Class EntitySchemaQueryColumn
Колонка запроса к схеме объекта.
Inherited Members
Namespace: Terrasoft.Core.Entities
Assembly: Terrasoft.Core.dll
Syntax
public class EntitySchemaQueryColumn : MetaItem, IMetaItem, IMetaDataSerializable, ICloneable
Constructors
EntitySchemaQueryColumn()
Инициализирует экземпляр EntitySchemaQueryColumn.
Declaration
public EntitySchemaQueryColumn()
EntitySchemaQueryColumn(String)
Инициализирует экземпляр EntitySchemaQueryColumn с заданным именем.
Declaration
public EntitySchemaQueryColumn(string name)
Parameters
Type | Name | Description |
---|---|---|
System.String | name | Имя колонки запроса к схеме объекта. |
EntitySchemaQueryColumn(EntitySchemaQueryColumn)
Инициализирует экземпляр EntitySchemaQueryColumn, являющийся клоном переданной колонки запроса к схеме объекта.
Declaration
public EntitySchemaQueryColumn(EntitySchemaQueryColumn source)
Parameters
Type | Name | Description |
---|---|---|
EntitySchemaQueryColumn | source | Колонка запроса к схеме объекта, клон которой создается. |
Properties
Caption
Заголовок колонки.
Declaration
public LocalizableString Caption { get; set; }
Property Value
Type | Description |
---|---|
LocalizableString |
DisplayExpression
Выражение значения для отображения колонки.
Declaration
public EntitySchemaQueryExpression DisplayExpression { get; set; }
Property Value
Type | Description |
---|---|
EntitySchemaQueryExpression |
DisplayValueQueryAlias
Псевдоним значения для отображения в sql-запросе.
Declaration
public string DisplayValueQueryAlias { get; }
Property Value
Type | Description |
---|---|
System.String |
IsAggregated
Признак, применяется ли к колонке агрегирующая функция.
Declaration
public bool IsAggregated { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
IsAlwaysSelect
Признак, будет ли данная колонка всегда присутствовать в результирующем sql-запросе.
Declaration
public bool IsAlwaysSelect { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
IsLookup
Признак, является ли колонка справочником.
Declaration
public bool IsLookup { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
IsSelecting
Признак, использовать ли данную колонку для построения результирующего sql-запроса.
Declaration
public bool IsSelecting { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
IsVisible
Признак, будет ли данная колонка присутствовать в результирующем наборе данных запроса.
Declaration
public bool IsVisible { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
OrderDirection
Порядок сортировки.
Declaration
public OrderDirection OrderDirection { get; set; }
Property Value
Type | Description |
---|---|
OrderDirection |
OrderPosition
Позиция сортировки.
Declaration
public int OrderPosition { get; set; }
Property Value
Type | Description |
---|---|
System.Int32 |
ParentQuery
Запрос к схеме объекта, которому принадлежит колонка.
Declaration
public EntitySchemaQuery ParentQuery { get; set; }
Property Value
Type | Description |
---|---|
EntitySchemaQuery |
Path
Путь к колонке.
Declaration
public string Path { get; set; }
Property Value
Type | Description |
---|---|
System.String |
PrimaryImageExpression
Declaration
public EntitySchemaQueryExpression PrimaryImageExpression { get; set; }
Property Value
Type | Description |
---|---|
EntitySchemaQueryExpression |
SourceSchemaUIdExpression
Выражение для уникального идентификатора схемы - источника.
Declaration
public EntitySchemaQueryExpression SourceSchemaUIdExpression { get; set; }
Property Value
Type | Description |
---|---|
EntitySchemaQueryExpression |
SummaryType
Тип агрегирующей функции для колонки.
Declaration
public AggregationType SummaryType { get; set; }
Property Value
Type | Description |
---|---|
AggregationType |
UseDisplayValue
Признак, использовать ли для колонки значение для отображения.
Declaration
public bool UseDisplayValue { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
ValueExpression
Выражение хранимого значения колонки.
Declaration
public EntitySchemaQueryExpression ValueExpression { get; set; }
Property Value
Type | Description |
---|---|
EntitySchemaQueryExpression |
ValueQueryAlias
Псевдоним хранимого значения в sql-запросе.
Declaration
public string ValueQueryAlias { get; }
Property Value
Type | Description |
---|---|
System.String |
Methods
ApplyMetaDataValue(DataReader)
Declaration
protected override void ApplyMetaDataValue(DataReader reader)
Parameters
Type | Name | Description |
---|---|---|
DataReader | reader |
Overrides
Clone()
Возвращает экземпляр System.Object, являющийся клоном текущей колонки запроса к схеме объекта.
Declaration
public override object Clone()
Returns
Type | Description |
---|---|
System.Object | Экземпляр System.Object, являющийся клоном текущей колонки запроса к схеме объекта. |
Overrides
CreateSummaryQueryColumnExpression(QueryColumnExpression)
Создает выражение агрегирующей функции для заданного выражения колонки.
Declaration
public QueryColumnExpression CreateSummaryQueryColumnExpression(QueryColumnExpression queryColumnExpression)
Parameters
Type | Name | Description |
---|---|---|
QueryColumnExpression | queryColumnExpression | Выражение колонки запроса. |
Returns
Type | Description |
---|---|
QueryColumnExpression | Выражение агрегирующей функции для выражения колонки запроса
|
GetResultDataDisplayValueType(DataValueTypeManager)
Возвращает тип данных значения для отображения колонки, используя переданный менеджер типов данных.
Declaration
public DataValueType GetResultDataDisplayValueType(DataValueTypeManager dataValueTypeManager)
Parameters
Type | Name | Description |
---|---|---|
DataValueTypeManager | dataValueTypeManager | Менеджер типов данных. |
Returns
Type | Description |
---|---|
DataValueType | Тип данных значения для отображения колонки. |
GetResultDataValueType(DataValueTypeManager)
Возвращает тип данных хранимого значения колонки, используя переданный менеджер типов данных.
Declaration
public DataValueType GetResultDataValueType(DataValueTypeManager dataValueTypeManager)
Parameters
Type | Name | Description |
---|---|---|
DataValueTypeManager | dataValueTypeManager | Менеджер типов данных. |
Returns
Type | Description |
---|---|
DataValueType | Тип данных значения колонки. |
GetResultSummaryDataValueType(DataValueTypeManager)
Возвращает тип данных итогового значения колонки, используя переданный менеджер типов данных.
Declaration
public DataValueType GetResultSummaryDataValueType(DataValueTypeManager dataValueTypeManager)
Parameters
Type | Name | Description |
---|---|---|
DataValueTypeManager | dataValueTypeManager | Менеджер типов данных. |
Returns
Type | Description |
---|---|
DataValueType | Тип данных итогового значения колонки. |
OrderByAsc()
Для текущей колонки устанавливает порядок сортировки по возрастанию.
Declaration
public EntitySchemaQueryColumn OrderByAsc()
Returns
Type | Description |
---|---|
EntitySchemaQueryColumn | Текущий экземпляр EntitySchemaQueryColumn. |
OrderByAsc(Int32)
Для текущей колонки устанавливает порядок сортировки по возрастанию в заданной позиции.
Declaration
public EntitySchemaQueryColumn OrderByAsc(int orderPosition)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | orderPosition | Позиция сортировки. |
Returns
Type | Description |
---|---|
EntitySchemaQueryColumn | Текущий экземпляр EntitySchemaQueryColumn с установленным порядком сортировки по возрастанию. |
OrderByDesc()
Для текущей колонки устанавливает порядок сортировки по убыванию.
Declaration
public EntitySchemaQueryColumn OrderByDesc()
Returns
Type | Description |
---|---|
EntitySchemaQueryColumn | Текущий экземпляр EntitySchemaQueryColumn |
OrderByDesc(Int32)
Для текущей колонки устанавливает порядок сортировки по убыванию в заданной позиции.
Declaration
public EntitySchemaQueryColumn OrderByDesc(int orderPosition)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | orderPosition | Позиция сортировки. |
Returns
Type | Description |
---|---|
EntitySchemaQueryColumn | Текущий экземпляр EntitySchemaQueryColumn с установленным порядком сортировки по убыванию. |
SetForcedQueryColumnValueAlias(String)
Specifies alias for query column value.
Declaration
public bool SetForcedQueryColumnValueAlias(string alias)
Parameters
Type | Name | Description |
---|---|---|
System.String | alias | Alias for query column with value. |
Returns
Type | Description |
---|---|
System.Boolean | Returns true if alias has been changed. |
SetForcedQueryDisplayColumnValueAlias(String)
Specifies alias for query column display value.
Declaration
public void SetForcedQueryDisplayColumnValueAlias(string alias)
Parameters
Type | Name | Description |
---|---|---|
System.String | alias | Alias for query column with display value. |
WriteMetaData(DataWriter)
Выполняет сериализацию текущей колонки запроса к схеме объекта, используя переданный экземпляр
Declaration
public override void WriteMetaData(DataWriter writer)
Parameters
Type | Name | Description |
---|---|---|
DataWriter | writer | Экземпляр |