Click or drag to resize
SortExpression Class
Implementation of the ISortExpression interface. This class contains the sort clauses used in IRetrievalQuery instances.
Inheritance Hierarchy
System.Object
  SD.LLBLGen.Pro.ORMSupportClasses.SortExpression

Namespace:  SD.LLBLGen.Pro.ORMSupportClasses
Assembly:  SD.LLBLGen.Pro.ORMSupportClasses (in SD.LLBLGen.Pro.ORMSupportClasses.dll) Version: 5.3.0.0 (5.3.0)
Syntax
Copy
[SerializableAttribute]
public class SortExpression : IList, 
	ICollection, IEnumerable, ISortExpression, IXmlSerializable

The SortExpression type exposes the following members.

Constructors
  NameDescription
Public methodSortExpression()
CTor
Public methodSortExpression(ISortClause)
CTor which initially adds the passed in sort clause. This is an accelerator constructor to make code more compact.
Top
Properties
  NameDescription
Public propertyCapacity
Returns the capacity of the collection
Public propertyCount
Returns the number of elements in this path
Public propertyDatabaseSpecificCreator
Object which will be used to create valid parameter objects, field names, including prefix/postfix characters, and conversion routines, and field names, including prefix/postfix characters. Uses the strategy pattern so the generic code can work with more than one target database.
Public propertyItem
Indexer for this list.
Public propertyParameters
The list of parameters created when the sortexpression was translated to text usable in a query. Only valid after a succesful call to ToQueryText
Top
Methods
  NameDescription
Public methodAdd
Adds the passed in sort clause to the list.
Public methodClear
Clears this instance
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.)
Public methodInsert
Inserts the passed in sort clause at the index provided.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodRemove
Removes the given sort clause from the list.
Public methodToQueryText()
Retrieves a ready to use text representation for the sort clauses contained in this expression.
Public methodToQueryText(Boolean)
Retrieves a ready to use text representation for the sort clauses contained in this expression.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Extension Methods
  NameDescription
Public Extension MethodIsEmpty
Determines whether the specified sortexpression is empty. A null passed in is also considered empty.
(Defined by ORMClassExtensions.)
Top
Explicit Interface Implementations
  NameDescription
Explicit interface implementationPrivate methodIList.Add
Adds an item to the IList.
Explicit interface implementationPrivate methodIList.Contains
Determines whether the IList contains a specific value.
Explicit interface implementationPrivate methodICollection.CopyTo
Copies the elements of the ICollection to an Array, starting at a particular Array index.
Explicit interface implementationPrivate methodIEnumerable.GetEnumerator
Returns an enumerator that iterates through the CollectionBase instance.
Explicit interface implementationPrivate methodIXmlSerializable.GetSchema
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 methodIList.IndexOf
Determines the index of a specific item in the IList.
Explicit interface implementationPrivate methodIList.Insert
Inserts an item to the IList at the specified index.
Explicit interface implementationPrivate propertyIList.IsFixedSize
Gets a value indicating whether the IList has a fixed size.
Explicit interface implementationPrivate propertyIList.IsReadOnly
Gets a value indicating whether the IList is read-only.
Explicit interface implementationPrivate propertyICollection.IsSynchronized
Gets a value indicating whether access to the ICollection is synchronized (thread safe).
Explicit interface implementationPrivate propertyIList.Item
Gets or sets the element at the specified index.
Explicit interface implementationPrivate methodIXmlSerializable.ReadXml
Generates an object from its XML representation.
Explicit interface implementationPrivate methodIList.Remove
Removes the first occurrence of a specific object from the IList.
Explicit interface implementationPrivate methodIList.RemoveAt
Removes the IList item at the specified index.
Explicit interface implementationPrivate propertyICollection.SyncRoot
Gets an object that can be used to synchronize access to the ICollection.
Explicit interface implementationPrivate methodIXmlSerializable.WriteXml
Converts an object into its XML representation.
Explicit interface implementationPrivate methodISortExpression.ReadXml
Deserializes the object data on the xml reader into this instance
Explicit interface implementationPrivate methodISortExpression.WriteXml
Serializes the object as xml to the writer specified.
Top
See Also