QueryColumn class

April 28, 2021

Represents some column which will be queried.

public class Korzh.EasyQuery.QueryColumn

Package: Korzh.EasyQuery (targets: netstandard2.0)

Assembly: Korzh.EasyQuery.dll

Fields

Name Type Description
_caption string QueryColumn caption
_isDistinct bool A field that indicates whether this QueryColumn must be marked as DISTINCT in result SQL statement.
Params QueryParamList The parameters associated with this column
parent QueryColumnStore Parent columns storage.
sorting SortDirection QueryColumn sorting direction

Properties

Name Type Description
Alias string Gets or Sets the column alias.
AllowSorting bool Gets a value indicating whether this column can be sorted.
BaseAttr EntityAttr Gets the entity attribute (EntityAttr object) this column is based on.
Caption string Gets or sets the column caption.
DataType DataType Gets the data type of the column.
Expr EqExpression Gets or sets the column expression.
ExprType int Gets or sets the tag (type) of the expression.
Id string The column's Id.
Index int Gets the index of column in column list.
IsAggregate bool Gets a value indicating whether this is aggregate.
IsDistinct bool Gets or sets a value indicating whether this QueryColumn must be marked as DISTINCT in result SQL statement.
IsEnabled bool Gets or sets a value indicating whether this column is enabled. Only enabled columns will participates in the query.
IsHidden bool Gets or sets a value indicating whether this QueryColumn is hidden - it will participate in the query but is not shown in the result set.
IsJustSorting bool Gets a value indicating whether this column is just sorting one (will not be shown in query result).
IsReadOnly bool Gets or sets a value indicating whether this columns marked as read only.
Model DataModel Gets or sets the reference to the data model where this column is defined.
Parent QueryColumnStore Gets or sets the parent columns storage.
ParentQuery Query Gets the parent query.
SortIndex int Gets or sets the index of the column in the sorting list. Is used to load the column from XML.
Sorting SortDirection Gets or sets the sorting direction.
SystemType Type Gets the system type of this column.
UserData string Gets or sets users data for the column

Events

Name Type Description
ColumnChanged EventHandler Indicates that column was changed.

Methods

Name Type Description
CheckDataModel() void Checks the data model object. Generates an exception if Model property has null value.
ExprChangeHandler(object sender, EventArgs e) void Expression's Change event handler.
GetAttribute() EntityAttr Gets the attribute associated with this column
GetHashCode() int Returns hash code for column
LoadFromXmlReader(XmlReader reader) void Loads definition from XML.
OnColumnChanged(int part) void Raises the ColumnChanged event.
OnColumnChanging(int part) bool Called when the column is about to change.
ReadFromJsonAsync(JsonReader reader) Task Loads column from JSON reader (asynchronous way). Calls Korzh.EasyQuery.QueryColumn.ReadOnePropFromJsonAsync(Newtonsoft.Json.JsonReader,System.String)
ReadOnePropFromJsonAsync(JsonReader reader, string propName) Task Reads the property from JSON reader or skip unused (asynchronous way).
RecreateExpression(int tag) void Recreates the column expression.
RegenerateCaption() void Regenerates the column caption.
SaveToXmlWriter(XmlWriter writer) void Saves the column definition to XML.
WritePropertiesToJsonAsync(JsonWriter writer) Task Saves content of the column to JSON (asynchronous way).
WriteToJsonAsync(JsonWriter writer) Task Saves the column definition to JSON (asynchronous way). Calls Korzh.EasyQuery.QueryColumn.WritePropertiesToJsonAsync(Newtonsoft.Json.JsonWriter).