ISortClause Interface |
Interface definition for a class which forms a single sort clause, thus an order by
definition defined for a single IEntityField or IEntityField - IFieldPersistenceInfo combination
PersistenceInfo will return the same object when an IEntityField is added to the object.
Generic
Namespace: SD.LLBLGen.Pro.ORMSupportClasses
Assembly: SD.LLBLGen.Pro.ORMSupportClasses (in SD.LLBLGen.Pro.ORMSupportClasses.dll) Version: 5.10.0.0 (5.10.0)
SyntaxThe ISortClause type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | CaseSensitiveCollation |
Gets / sets the CaseSensitiveCollation flag. If set to true, the UPPER() function (or db specific equivalent) is applied to the field in the ORDER BY clause. Default: false
|
| EmitAliasForExpressionAggregateField |
Gets or sets a value indicating whether the alias of the field should be emitted if it has an expression/aggregate or the full field / expression.
Default is true. Set to false if the field in this sortclause isn't used in the projection and it has an expression/aggregate assigned to it.
|
| FieldToSortCore |
IEntityFieldCore to sort on.
|
| ObjectAlias |
Alias for the object the field belongs to. Used to identify which entity to use when the entity
is present multiple times in a relation collection. Alias has to match an alias specified in the relation collection or should be
left empty if no alias is specified (or no relation collection is used).
|
| PersistenceInfo |
Persistence information for FieldToSort. Can be a cast of the same object, when an IEntityField is
added to this sort clause
|
| SortOperatorToUse |
The sort operator to use for this sort clause
|
Methods| Name | Description | |
|---|---|---|
 | ReadXml |
Deserializes the object data on the xml reader into this instance
|
| SetCaseSensitiveCollation |
Sets the case sensitive collation flag and returns the sortclause instance for further command chaining
|
| SetEmitAliasForExpressionAggregateField |
Sets the property EmitAliasForExpressionAggregateField to the value specified and returns itself, for command chaining in e.g. QuerySpec.
|
| WriteXml |
Serializes the object as xml to the writer specified.
|
Extension Methods| Name | Description | |
|---|---|---|
 | CaseInsensitive |
Sets the CaseSensitiveCollation flag on the sort clause specified. This will apply the UPPER() function (or db specific equivalent) to the field in the ORDER BY clause.
(Defined by SortClauseProducers.) |
| DontEmitAliasForExpressionAggregateField |
Sets the EmitAliasForExpressionAggregateField flag on the sort clause specified to false. The value of the flag indicates whether the alias of the field
should be emitted if it has an expression/aggregate or the full field / expression.
Using this method sets this flag to false indicating that the field in this sortclause isn't used in the projection and it has an expression/aggregate assigned to it.
(Defined by SortClauseProducers.) |
| ThenBy |
Appends an ISortClause to an existing ISortClause to form a new ISortExpression
(Defined by SortClauseProducers.) |
See Also