Class EntitySchemaQueryColumn
Column of the entity schema query.
Inherited Members
Namespace: Terrasoft.Core.Entities
Assembly: Terrasoft.Core.dll
Syntax
public class EntitySchemaQueryColumn : MetaItem, IMetaItem, IMetaDataSerializable, ICloneable
Constructors
EntitySchemaQueryColumn()
Initializes the EntitySchemaQueryColumn instance.
Declaration
public EntitySchemaQueryColumn()
EntitySchemaQueryColumn(String)
Initializes the EntitySchemaQueryColumn instance with the specified name.
Declaration
public EntitySchemaQueryColumn(string name)
Parameters
Type | Name | Description |
---|---|---|
System.String | name | Name of the column of the entity schema query. |
EntitySchemaQueryColumn(EntitySchemaQueryColumn)
Initializes the EntitySchemaQueryColumn instance that is a clone of the passed-in column of the entity schema query.
Declaration
public EntitySchemaQueryColumn(EntitySchemaQueryColumn source)
Parameters
Type | Name | Description |
---|---|---|
EntitySchemaQueryColumn | source | The column of the query to the schema of the object, the clone of which is created. |
Properties
Caption
The caption of the column.
Declaration
public LocalizableString Caption { get; set; }
Property Value
Type | Description |
---|---|
LocalizableString |
DisplayExpression
Expression of the column value to display.
Declaration
public EntitySchemaQueryExpression DisplayExpression { get; set; }
Property Value
Type | Description |
---|---|
EntitySchemaQueryExpression |
DisplayValueQueryAlias
Alias of the value to display in the SQL query.
Declaration
public string DisplayValueQueryAlias { get; }
Property Value
Type | Description |
---|---|
System.String |
IsAggregated
Indicates whether the aggregate function is applied to the column.
Declaration
public bool IsAggregated { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
IsAlwaysSelect
Indicates whether the column will be always present in the resulting SQL query.
Declaration
public bool IsAlwaysSelect { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
IsLookup
Indicates whether the column is a lookup.
Declaration
public bool IsLookup { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
IsSelecting
Indicates whether to use the column for building the resulting SQL query.
Declaration
public bool IsSelecting { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
IsVisible
Indicates whether the column will be present in the resulting data set of the query.
Declaration
public bool IsVisible { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
OrderDirection
The sorting order.
Declaration
public OrderDirection OrderDirection { get; set; }
Property Value
Type | Description |
---|---|
OrderDirection |
OrderPosition
The sort position.
Declaration
public int OrderPosition { get; set; }
Property Value
Type | Description |
---|---|
System.Int32 |
ParentQuery
Query against the schema of the entity that contains the column.
Declaration
public EntitySchemaQuery ParentQuery { get; set; }
Property Value
Type | Description |
---|---|
EntitySchemaQuery |
Path
Path to column.
Declaration
public string Path { get; set; }
Property Value
Type | Description |
---|---|
System.String |
PrimaryColorExpression
Declaration
public EntitySchemaQueryExpression PrimaryColorExpression { get; set; }
Property Value
Type | Description |
---|---|
EntitySchemaQueryExpression |
PrimaryImageExpression
Declaration
public EntitySchemaQueryExpression PrimaryImageExpression { get; set; }
Property Value
Type | Description |
---|---|
EntitySchemaQueryExpression |
SourceSchemaUIdExpression
Expression for the unique identifier of the source schema.
Declaration
public EntitySchemaQueryExpression SourceSchemaUIdExpression { get; set; }
Property Value
Type | Description |
---|---|
EntitySchemaQueryExpression |
SummaryType
The aggregate function type for the column.
Declaration
public AggregationType SummaryType { get; set; }
Property Value
Type | Description |
---|---|
AggregationType |
UseDisplayValue
Indicates whether to use the displayed value for the column.
Declaration
public bool UseDisplayValue { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
ValueExpression
Expression of the stored column value.
Declaration
public EntitySchemaQueryExpression ValueExpression { get; set; }
Property Value
Type | Description |
---|---|
EntitySchemaQueryExpression |
ValueQueryAlias
Alias of the stored value in the SQL query.
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()
Gets the System.Object instance that is a clone of the current column of the entity schema query.
Declaration
public override object Clone()
Returns
Type | Description |
---|---|
System.Object | The System.Object instance that is a clone of the current column of the entity schema query. |
Overrides
CreateSummaryQueryColumnExpression(QueryColumnExpression)
Creates the expression of the aggregate function for the specified column expression.
Declaration
public QueryColumnExpression CreateSummaryQueryColumnExpression(QueryColumnExpression queryColumnExpression)
Parameters
Type | Name | Description |
---|---|---|
QueryColumnExpression | queryColumnExpression | The query column expression. |
Returns
Type | Description |
---|---|
QueryColumnExpression | Expression of the aggregate function for the |
Exceptions
Type | Condition |
---|---|
InvalidObjectStateException | If the aggregate function type is not specified for the current query column. |
GetResultDataDisplayValueType(DataValueTypeManager)
Gets the data type of the column value to display, using the passed-in data type manager.
Declaration
public DataValueType GetResultDataDisplayValueType(DataValueTypeManager dataValueTypeManager)
Parameters
Type | Name | Description |
---|---|---|
DataValueTypeManager | dataValueTypeManager | Data type manager. |
Returns
Type | Description |
---|---|
DataValueType | The data type of the column value to display. |
GetResultDataValueType(DataValueTypeManager)
Gets the data type of the stored column value, using the passed-in data type manager.
Declaration
public DataValueType GetResultDataValueType(DataValueTypeManager dataValueTypeManager)
Parameters
Type | Name | Description |
---|---|---|
DataValueTypeManager | dataValueTypeManager | Data type manager. |
Returns
Type | Description |
---|---|
DataValueType | The data type of the column value. |
GetResultSummaryDataValueType(DataValueTypeManager)
Gets the data type of the column value total, using the passed-in data type manager.
Declaration
public DataValueType GetResultSummaryDataValueType(DataValueTypeManager dataValueTypeManager)
Parameters
Type | Name | Description |
---|---|---|
DataValueTypeManager | dataValueTypeManager | Data type manager. |
Returns
Type | Description |
---|---|
DataValueType | The data type of the column value total. |
Exceptions
Type | Condition |
---|---|
InvalidObjectStateException | If the total aggregate function type is not specified for the current column. |
OrderByAsc()
For the current column, sets the ascending sort order.
Declaration
public EntitySchemaQueryColumn OrderByAsc()
Returns
Type | Description |
---|---|
EntitySchemaQueryColumn | The current EntitySchemaQueryColumn instance. |
OrderByAsc(Int32)
For the current column, sets the ascending sort order at the specified position.
Declaration
public EntitySchemaQueryColumn OrderByAsc(int orderPosition)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | orderPosition | The sort position. |
Returns
Type | Description |
---|---|
EntitySchemaQueryColumn | The current EntitySchemaQueryColumn instance with the default ascending sort order. |
OrderByDesc()
For the current column, sets the descending sort order.
Declaration
public EntitySchemaQueryColumn OrderByDesc()
Returns
Type | Description |
---|---|
EntitySchemaQueryColumn | The current instance. EntitySchemaQueryColumn |
OrderByDesc(Int32)
For the current column, sets the descending sort order at the specified position.
Declaration
public EntitySchemaQueryColumn OrderByDesc(int orderPosition)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | orderPosition | The sort position. |
Returns
Type | Description |
---|---|
EntitySchemaQueryColumn | The current EntitySchemaQueryColumn instance with the default descending sort order. |
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)
Serializes the current query column to the object schema using the DataWriter passed instance.
Declaration
public override void WriteMetaData(DataWriter writer)
Parameters
Type | Name | Description |
---|---|---|
DataWriter | writer | The DataWriter instance that serializes the current query column to the object schema. |