Class StorageColumn

Provides information about how to store values in the database.

Inheritance

System.Object

StorageColumn

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: TimeCockpit.Data.DataModel

Assembly: TimeCockpit.Data.dll

Syntax

public class StorageColumn

Constructors

StorageColumn()

Initializes a new instance of the StorageColumn class.

Declaration

public StorageColumn()

StorageColumn(String, Type, Int32, Byte, Byte, Ownership, ModelEntityBase, Boolean)

Initializes a new instance of the StorageColumn class.

Declaration

public StorageColumn(string name, Type dataType, int size, byte precision, byte scale, Ownership ownership, ModelEntityBase relationTarget, bool isLocalized)

Parameters

Type	Name	Description
System.String	name	Name of the column.
System.Type	dataType	.NET data type of the column
System.Int32	size	The length of the column.
System.Byte	precision	The total number of digits to the left and right of the decimal point.
System.Byte	scale	The total number of decimal places.
Ownership	ownership	The parent model entity the property/relation to which this storage column belongs to
ModelEntityBase	relationTarget	Target of the foreign key.
System.Boolean	isLocalized	Indicates whether the property represented by the storage column is localized or not.

StorageColumn(String, Type, Ownership, ModelEntityBase, Boolean)

Initializes a new instance of the StorageColumn class.

Declaration

public StorageColumn(string name, Type dataType, Ownership ownership, ModelEntityBase relationTarget, bool isLocalized = false)

Parameters

Type	Name	Description
System.String	name	Name of the column.
System.Type	dataType	.NET data type of the column
Ownership	ownership	The parent model entity the property/relation to which this storage column belongs to
ModelEntityBase	relationTarget	Target of the foreign key.
System.Boolean	isLocalized	Indicates whether the property represented by the storage column is localized or not.

Properties

DataType

Gets the .NET data type of the column.

Declaration

public Type DataType { get; }

Property Value

Type	Description
System.Type

EntityObjectProperties

Gets a list of properties, that provide access to the value of the column.

Declaration

public Collection<string> EntityObjectProperties { get; }

Property Value

Type	Description
System.Collections.ObjectModel.Collection<System.String>

Remarks

For properties (see ModelProperty) EntityObjectProperties contains a single string with the property's name.

For relations (see Relation) EntityObjectProperties contains a single string with the relation's name.

IsApplicationSpecificElement

Gets a value indicating whether the storagecolumn represents a application specific element.

Declaration

public bool IsApplicationSpecificElement { get; }

Property Value

Type	Description
System.Boolean

IsBinary

Gets a value indicating whether the specified .NET type is of type byte []

Declaration

public bool IsBinary { get; }

Property Value

Type	Description
System.Boolean

IsBoolean

Gets a value indicating whether the specified .NET type is of type bool.

Declaration

public bool IsBoolean { get; }

Property Value

Type	Description
System.Boolean

IsDateTime

Gets a value indicating whether the specified .NET type is of type DateTime.

Declaration

public bool IsDateTime { get; }

Property Value

Type	Description
System.Boolean

IsDecimal

Gets a value indicating whether the specified .NET type is of type decimal.

Declaration

public bool IsDecimal { get; }

Property Value

Type	Description
System.Boolean

IsGuid

Gets a value indicating whether the specified .NET type is of type Guid.

Declaration

public bool IsGuid { get; }

Property Value

Type	Description
System.Boolean

IsLocalized

Gets a value indicating whether this instance is localized.

Declaration

public bool IsLocalized { get; }

Property Value

Type	Description
System.Boolean	true if this instance is localized; otherwise, false.

IsMaxSize

Gets a value indicating whether the specified size is the max size.

Declaration

public bool IsMaxSize { get; }

Property Value

Type	Description
System.Boolean

IsRelation

Gets a value indicating whether the storage column is a relation or not.

Declaration

public bool IsRelation { get; }

Property Value

Type	Description
System.Boolean

IsStoredOnBlobStorage

Gets or sets a value indicating whether the column is stored on blob storage

Declaration

public bool IsStoredOnBlobStorage { get; set; }

Property Value

Type	Description
System.Boolean

IsString

Gets a value indicating whether the specified .NET type is of type string.

Declaration

public bool IsString { get; }

Property Value

Type	Description
System.Boolean

IsSystemElement

Gets a value indicating whether the storagecolumn represents a system element.

Declaration

public bool IsSystemElement { get; }

Property Value

Type	Description
System.Boolean

IsUserElement

Gets a value indicating whether the storagecolumn represents a user specific element.

Declaration

public bool IsUserElement { get; }

Property Value

Type	Description
System.Boolean

Name

Gets the name of the column.

Declaration

public string Name { get; }

Property Value

Type	Description
System.String

Ownership

Gets the parent ownership of the the property/relation to which this storage column belongs to

Declaration

public Ownership Ownership { get; }

Property Value

Type	Description
Ownership

Precision

Gets or sets the total number of digits to the left and right of the decimal point.

Declaration

public byte Precision { get; set; }

Property Value

Type	Description
System.Byte

RelationTarget

Gets the target of the foreign key.

Declaration

public ModelEntityBase RelationTarget { get; }

Property Value

Type	Description
ModelEntityBase

Scale

Gets or sets the total number of decimal places.

Declaration

public byte Scale { get; set; }

Property Value

Type	Description
System.Byte

Size

Gets or sets the length of the column.

Declaration

public int Size { get; set; }

Property Value

Type	Description
System.Int32