SortClause Class |
Class which implements ISortClause, a class which forms a single sort clause, thus an order by
definition defined for a single IEntityField.
Inheritance HierarchyNamespace: SD.LLBLGen.Pro.ORMSupportClasses
Assembly: SD.LLBLGen.Pro.ORMSupportClasses (in SD.LLBLGen.Pro.ORMSupportClasses.dll) Version: 5.10.0.0 (5.10.0)
SyntaxThe SortClause type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | SortClause |
Initializes a new instance of the SortClause class. For deserialization
|
| SortClause(IEntityField, SortOperator) |
CTor
|
| SortClause(IEntityField, SortOperator, String) |
CTor
|
| SortClause(IEntityFieldCore, IFieldPersistenceInfo, SortOperator) |
CTor
|
| SortClause(IEntityFieldCore, IFieldPersistenceInfo, SortOperator, String) |
CTor
|
Properties| Name | Description | |
|---|---|---|
 | CaseSensitiveCollation |
Gets / sets caseSensitiveCollation flag. If set to true, the UPPER() function (or db specific equivalent) is applied to the field. 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 |
entity field 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 | |
|---|---|---|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| 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.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Operators| Name | Description | |
|---|---|---|
  | BitwiseAnd(SortClause, SortClause) |
Operator overload for the '&' operator to concatenate sortclauses into a sortexpression
|
| BitwiseAnd(SortExpression, SortClause) |
Operator overload for the '&' operator to concatenate sortclauses into a sortexpression
|
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.) |
Explicit Interface Implementations| Name | Description | |
|---|---|---|
  | IXmlSerializableGetSchema |
This method is reserved and should not be used. When implementing the IXmlSerializable interface, you should return null (Nothing in Visual Basic) from this method, and instead, if specifying a custom schema is required, apply the XmlSchemaProviderAttribute to the class.
|
| IXmlSerializableReadXml |
Generates an object from its XML representation.
|
| IXmlSerializableWriteXml |
Converts an object into its XML representation.
|
| ISortClauseReadXml |
Deserializes the object data on the xml reader into this instance
|
| ISortClauseSetCaseSensitiveCollation |
Sets the case sensitive collation flag and returns the sortclause instance for further command chaining
|
| ISortClauseSetEmitAliasForExpressionAggregateField |
Sets the property EmitAliasForExpressionAggregateField to the value specified and returns itself, for command chaining in e.g. QuerySpec.
|
| ISortClauseWriteXml |
Serializes the object as xml to the writer specified.
|
See Also