Click or drag to resize

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 Hierarchy
SystemObject
  SD.LLBLGen.Pro.ORMSupportClassesSortClause

Namespace:  SD.LLBLGen.Pro.ORMSupportClasses
Assembly:  SD.LLBLGen.Pro.ORMSupportClasses (in SD.LLBLGen.Pro.ORMSupportClasses.dll) Version: 5.9.0.0 (5.9.0)
Syntax
[SerializableAttribute]
public class SortClause : ISortClause, IXmlSerializable

The SortClause type exposes the following members.

Constructors
Properties
  NameDescription
Public propertyCaseSensitiveCollation
Gets / sets caseSensitiveCollation flag. If set to true, the UPPER() function (or db specific equivalent) is applied to the field. Default: false
Public propertyEmitAliasForExpressionAggregateField
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.
Public propertyFieldToSortCore
entity field to sort on.
Public propertyObjectAlias
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).
Public propertyPersistenceInfo
Persistence information for FieldToSort. Can be a cast of the same object, when an IEntityField is added to this sort clause
Public propertySortOperatorToUse
The sort operator to use for this sort clause
Top
Methods
  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodSetCaseSensitiveCollation
Sets the case sensitive collation flag and returns the sortclause instance for further command chaining
Public methodSetEmitAliasForExpressionAggregateField
Sets the property EmitAliasForExpressionAggregateField to the value specified and returns itself, for command chaining in e.g. QuerySpec.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Operators
  NameDescription
Public operatorStatic memberBitwiseAnd(SortClause, SortClause)
Operator overload for the '&' operator to concatenate sortclauses into a sortexpression
Public operatorStatic memberBitwiseAnd(SortExpression, SortClause)
Operator overload for the '&' operator to concatenate sortclauses into a sortexpression
Top
Extension Methods
  NameDescription
Public Extension MethodCaseInsensitive
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.)
Public Extension MethodDontEmitAliasForExpressionAggregateField
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.)
Public Extension MethodThenBy
Appends an ISortClause to an existing ISortClause to form a new ISortExpression
(Defined by SortClauseProducers.)
Top
Explicit Interface Implementations
  NameDescription
Explicit interface implementationPrivate methodIXmlSerializableGetSchema
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.
Explicit interface implementationPrivate methodIXmlSerializableReadXml
Generates an object from its XML representation.
Explicit interface implementationPrivate methodIXmlSerializableWriteXml
Converts an object into its XML representation.
Explicit interface implementationPrivate methodISortClauseReadXml
Deserializes the object data on the xml reader into this instance
Explicit interface implementationPrivate methodISortClauseSetCaseSensitiveCollation
Sets the case sensitive collation flag and returns the sortclause instance for further command chaining
Explicit interface implementationPrivate methodISortClauseSetEmitAliasForExpressionAggregateField
Sets the property EmitAliasForExpressionAggregateField to the value specified and returns itself, for command chaining in e.g. QuerySpec.
Explicit interface implementationPrivate methodISortClauseWriteXml
Serializes the object as xml to the writer specified.
Top
See Also