Class EntitySchemaColumn
Представляет колонку схемы.
Inherited Members
Namespace: Terrasoft.Core.Entities
Assembly: Terrasoft.Core.dll
Syntax
[MetaType("{D82CE7A8-867C-4b64-B5D6-B380BACFEDB5}")]
public class EntitySchemaColumn : SchemaProperty, IMetaItem, IMetaDataSerializable, ICloneable
Constructors
EntitySchemaColumn()
Инициализирует новый экземпляр класса EntitySchemaColumn.
Declaration
public EntitySchemaColumn()
EntitySchemaColumn(EntitySchema, DataValueType)
Инициализирует новый экземпляр класса EntitySchemaColumn с заданным типом данных в заданной схеме.
Declaration
public EntitySchemaColumn(EntitySchema entitySchema, DataValueType dataValueType)
Parameters
Type | Name | Description |
---|---|---|
EntitySchema | entitySchema | Схема, в которой создается колонка. |
DataValueType | dataValueType | Тип данных создаваемой колонки. |
EntitySchemaColumn(EntitySchemaColumn)
Инициализирует новый экземпляр EntitySchemaColumn, являющийся клоном заданной колонки.
Declaration
public EntitySchemaColumn(EntitySchemaColumn source)
Parameters
Type | Name | Description |
---|---|---|
EntitySchemaColumn | source | Колонка, клон которой создается. |
Properties
Caption
Заголовок колонки.
Declaration
[DBMetaTypeProperty(DBMetaInfoItemType.Column, typeof(LocalizableStringDBMetaTypeConverter))]
[MetaTypeProperty("{93A7D6E6-CFDE-4ed2-B731-FA1CFC932D55}", "Terrasoft.Core", "EntitySchemaColumn.Caption")]
public override LocalizableString Caption { get; set; }
Property Value
Type | Description |
---|---|
LocalizableString |
Overrides
ColumnValueName
Имя колонки, сформированное на основании значения, которое она содержит.
Declaration
[MetaTypeProperty("{9604C0DD-B8AD-4E75-95A0-29FE6F60C00D}")]
public virtual string ColumnValueName { get; set; }
Property Value
Type | Description |
---|---|
System.String |
CreatedInSchemaUId
Declaration
[DBMetaTypeProperty(DBMetaInfoItemType.Column, typeof(GuidDBMetaTypeConverter))]
public override Guid CreatedInSchemaUId { get; set; }
Property Value
Type | Description |
---|---|
System.Guid |
Overrides
DataValueType
Тип данных колонки.
Declaration
[DBMetaTypeProperty(DBMetaInfoItemType.Column, typeof(DataValueTypeDBMetaTypeConverter))]
[MetaTypeProperty("{42C0C55C-E87F-44b9-A386-DB46F0A149F1}", Manager = "DataValueTypeManager")]
public override DataValueType DataValueType { get; set; }
Property Value
Type | Description |
---|---|
DataValueType |
Overrides
DefValue
Значение по умолчанию для колонки.
Declaration
[MetaTypeProperty("FF574424-5886-44B7-A79D-E42FAA64838C")]
public EntitySchemaColumnDef DefValue { get; set; }
Property Value
Type | Description |
---|---|
EntitySchemaColumnDef |
Description
Описание колонки.
Declaration
[MetaTypeProperty("{4F7A4059-AA6C-4B1B-9D47-9C4D07F65B3D}", "Terrasoft.Core", "EntitySchemaColumn.Description.Caption")]
public override LocalizableString Description { get; set; }
Property Value
Type | Description |
---|---|
LocalizableString |
Overrides
DisplayColumnValueName
Формирует строку с значением колонки для отображения на основании значения, которое она содержит.
Declaration
[MetaTypeProperty("{017AE8F6-B671-4A38-952B-988C09FFD7C0}")]
public virtual string DisplayColumnValueName { get; set; }
Property Value
Type | Description |
---|---|
System.String |
DisplayValueType
Тип данных отображаемого значения колонки, который соответствует системному типу среды .NET.
Declaration
public Type DisplayValueType { get; }
Property Value
Type | Description |
---|---|
System.Type |
HasConstDefValue
Определяет, установлено ли для данной колонки константное значение по умолчанию.
Declaration
public bool HasConstDefValue { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
HasDefValue
Определяет, установлено ли для данной колонки значение по умолчанию.
Declaration
public bool HasDefValue { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
HasForeignKey
Gets true, if column has foreign key; false - otherwise.
Declaration
public bool HasForeignKey { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
HasReferenceSchemaList
Declaration
[Obsolete("7.14.0 | Property is not in use and will be removed in upcoming releases")]
public bool HasReferenceSchemaList { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
Index
Индекс колонки.
Declaration
public EntitySchemaIndex Index { get; }
Property Value
Type | Description |
---|---|
EntitySchemaIndex |
IsCascade
Для колонки типа справочник определяет, связана ли она каскадной связью с записью из справочника.
Declaration
[MetaTypeProperty("{E1E0767C-41F0-42ca-97F5-794D8B2CDDDE}", DefValue = false)]
public bool IsCascade { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
IsDBReadOnly
Признак, будет ли значение данной колонки записано в таблицу базы данных.
Declaration
public bool IsDBReadOnly { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
IsDBRequirement
Признак, является ли колонка обязательной на уровне базы данных.
Declaration
public bool IsDBRequirement { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
IsIndexed
Признак индексируемости колонки.
Declaration
[MetaTypeProperty("{16B91F17-56A3-4957-A319-E53E3D6414AF}", DefValue = false)]
public bool IsIndexed { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
IsLocalizable
Признак использования локализуемого значения для колонки.
Declaration
[MetaTypeProperty("{DE6AA0FC-9D6A-4567-A1D5-DEAB1CAB4A21}", DefValue = false)]
public bool IsLocalizable { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
IsMultiLineText
Признак использования для колонки элемента управления MemoEdit.
Declaration
[MetaTypeProperty("{6150C0CC-29C9-41E7-B660-9BA25A0433EA}", DefValue = false)]
public bool IsMultiLineText { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
IsSimpleLookup
Признак использования для колонки элемента управления ComboBoxEdit.
Declaration
[MetaTypeProperty("{A176A943-A751-48FC-8217-92ECDF02BAD8}", DefValue = false)]
public bool IsSimpleLookup { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
IsSystem
Declaration
public virtual bool IsSystem { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
IsTrackChangesInDB
Признак журналируемости колонки.
Declaration
[MetaTypeProperty("{57d685f1-2de6-4b21-8596-7c144dce3785}", DefValue = false)]
public bool IsTrackChangesInDB { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
IsValueCloneable
Признак клонируемости колонки.
Declaration
[MetaTypeProperty("{54725A14-4A1F-4b75-9952-41388C7A7C74}", DefValue = true)]
public bool IsValueCloneable { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
IsVirtual
Признак, является ли колонка виртуальной.
Declaration
[MetaTypeProperty("{9D746581-DC90-4b0a-B32E-5BF6671E3ECE}", DefValue = false)]
public bool IsVirtual { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
IsWeakReference
Определяет, что для колонки с типом справочник связь со справочником слабая на уровне базы данных, то есть нет внешнего ключа для проверки целостности.
Declaration
[MetaTypeProperty("{EAE08D50-9404-4468-9E2D-457FAAF17AC9}", DefValue = false)]
public bool IsWeakReference { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
Name
Column name.
Declaration
public override string Name { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Overrides
NamePrefix
Declaration
public override string NamePrefix { get; }
Property Value
Type | Description |
---|---|
System.String |
Overrides
ParentCollection
Коллекция колонок схемы, которой принадлежит текущая колонка.
Declaration
public EntitySchemaColumnCollection ParentCollection { get; set; }
Property Value
Type | Description |
---|---|
EntitySchemaColumnCollection |
PrimaryImageColumnValueName
Declaration
public virtual string PrimaryImageColumnValueName { get; }
Property Value
Type | Description |
---|---|
System.String |
ReferenceEnumType
Declaration
[MetaTypeProperty("{879C107F-B150-4c13-A67A-7B22FFC97E0C}")]
public Type ReferenceEnumType { get; set; }
Property Value
Type | Description |
---|---|
System.Type |
ReferenceSchema
Схема, на которую ссылается текущая колонка типа справочник.
Declaration
public override EntitySchema ReferenceSchema { get; set; }
Property Value
Type | Description |
---|---|
EntitySchema |
Overrides
ReferenceSchemaList
Declaration
[Obsolete("7.14.0 | Property is not in use and will be removed in upcoming releases")]
public EntitySchemaColumnReferenceSchemaCollection ReferenceSchemaList { get; set; }
Property Value
Type | Description |
---|---|
EntitySchemaColumnReferenceSchemaCollection |
ReferenceSchemaUId
Уникальный идентификатор, на который ссылается текущая колонка типа справочник.
Declaration
[DBMetaTypeProperty(DBMetaInfoItemType.Column, typeof(GuidDBMetaTypeConverter))]
[MetaTypeProperty("{0E119C8D-658F-4FF4-A605-9F34C1B00578}", Manager = "EntitySchemaManager")]
public override Guid ReferenceSchemaUId { get; set; }
Property Value
Type | Description |
---|---|
System.Guid |
Overrides
ReferenceValueListSchema
Виртуальный набор данных, на который ссылается текущая колонка с фиксированным списком значений.
Declaration
public override ValueListSchema ReferenceValueListSchema { get; set; }
Property Value
Type | Description |
---|---|
ValueListSchema |
Overrides
ReferenceValueListSchemaUId
Уникальный идентификатор виртуального набора данных, на который ссылается текущая колонка с фиксированным списком значений.
Declaration
[DBMetaTypeProperty(DBMetaInfoItemType.Column, typeof(GuidDBMetaTypeConverter))]
[MetaTypeProperty("{6CA6792F-EA79-4405-BB17-06E74F958DB0}", Manager = "ValueListSchemaManager")]
public override Guid ReferenceValueListSchemaUId { get; set; }
Property Value
Type | Description |
---|---|
System.Guid |
Overrides
RequirementType
Уровень обязательности колонки.
Declaration
[MetaTypeProperty("{384621C4-184A-4f95-8C8D-16106A67CAE3}", DefValue = EntitySchemaColumnRequirementType.None)]
public EntitySchemaColumnRequirementType RequirementType { get; set; }
Property Value
Type | Description |
---|---|
EntitySchemaColumnRequirementType |
SourceSchemaUIdColumnValueName
Declaration
public virtual string SourceSchemaUIdColumnValueName { get; }
Property Value
Type | Description |
---|---|
System.String |
UId
Column unique identifier.
Declaration
[DBMetaTypeProperty(DBMetaInfoItemType.Column | DBMetaInfoItemType.PrimaryKey | DBMetaInfoItemType.ForeignKey | DBMetaInfoItemType.DefValue, typeof(GuidDBMetaTypeConverter))]
public override Guid UId { get; set; }
Property Value
Type | Description |
---|---|
System.Guid |
Overrides
UsageType
Тип использования колонки.
Declaration
[MetaTypeProperty("{EC8F2FEB-BEBC-46C1-A159-346D0ACB3F0C}", DefValue = EntitySchemaColumnUsageType.General, IsExtraProperty = true)]
public EntitySchemaColumnUsageType UsageType { get; set; }
Property Value
Type | Description |
---|---|
EntitySchemaColumnUsageType |
ValueType
Тип данных значения колонки, который соответствует системному типу среды .NET.
Declaration
public Type ValueType { get; }
Property Value
Type | Description |
---|---|
System.Type |
Methods
ApplyMetaDataValue(DataReader)
Инициализирует основные свойства колонки на основании метаданных.
Declaration
protected override void ApplyMetaDataValue(DataReader reader)
Parameters
Type | Name | Description |
---|---|---|
DataReader | reader | Экземпляр |
Overrides
Clone()
Возвращает колонку - клон данной колонки.
Declaration
public override object Clone()
Returns
Type | Description |
---|---|
System.Object | Экземпляр EntitySchemaColumn, который является клоном текущей колонки. |
Overrides
HandleNameChanging(String)
Declaration
public override void HandleNameChanging(string oldName)
Parameters
Type | Name | Description |
---|---|---|
System.String | oldName |
Overrides
SetName(String)
Устанавливает для данной колонки заданное имя.
Declaration
public void SetName(string name)
Parameters
Type | Name | Description |
---|---|---|
System.String | name | Имя колонки. |
WriteMetaData(DataWriter)
Осуществляет запись метаданных схемы с помощью заданного экземпляра DataWriter.
Declaration
public override void WriteMetaData(DataWriter writer)
Parameters
Type | Name | Description |
---|---|---|
DataWriter | writer | Экземпляр DataWriter, с помощью которого записываются метаданные схемы. |