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

Namespace:  SD.LLBLGen.Pro.ORMSupportClasses
Assembly:  SD.LLBLGen.Pro.ORMSupportClasses (in SD.LLBLGen.Pro.ORMSupportClasses.dll) Version: 5.1.0.0 (5.1.0)
Syntax
[SerializableAttribute]
public class SortExpression : CollectionBase, 
	ISortExpression, IEnumerable, 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
Gets or sets the number of elements that the CollectionBase can contain.
(Inherited from CollectionBase.)
Public propertyCount
Gets the number of elements contained in the CollectionBase instance. This property cannot be overridden.
(Inherited from CollectionBase.)
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.
Protected propertyInnerList
Gets an ArrayList containing the list of elements in the CollectionBase instance.
(Inherited from CollectionBase.)
Public propertyItem
Indexer for this list.
Protected propertyList
Gets an IList containing the list of elements in the CollectionBase instance.
(Inherited from CollectionBase.)
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
Removes all objects from the CollectionBase instance. This method cannot be overridden.
(Inherited from CollectionBase.)
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 methodGetEnumerator
Returns an enumerator that iterates through the CollectionBase instance.
(Inherited from CollectionBase.)
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.)
Protected methodOnClear
Performs additional custom processes when clearing the contents of the CollectionBase instance.
(Inherited from CollectionBase.)
Protected methodOnClearComplete
Performs additional custom processes after clearing the contents of the CollectionBase instance.
(Inherited from CollectionBase.)
Protected methodOnInsert
Performs additional custom processes before inserting a new element into the CollectionBase instance.
(Inherited from CollectionBase.)
Protected methodOnInsertComplete
Performs additional custom processes after inserting a new element into the CollectionBase instance.
(Inherited from CollectionBase.)
Protected methodOnRemove
Performs additional custom processes when removing an element from the CollectionBase instance.
(Inherited from CollectionBase.)
Protected methodOnRemoveComplete
Performs additional custom processes after removing an element from the CollectionBase instance.
(Inherited from CollectionBase.)
Protected methodOnSet
Performs additional custom processes before setting a value in the CollectionBase instance.
(Inherited from CollectionBase.)
Protected methodOnSetComplete
Performs additional custom processes after setting a value in the CollectionBase instance.
(Inherited from CollectionBase.)
Protected methodOnValidate
Performs additional custom processes when validating a value.
(Inherited from CollectionBase.)
Public methodRemove
Removes the given sort clause from the list.
Public methodRemoveAt
Removes the element at the specified index of the CollectionBase instance. This method is not overridable.
(Inherited from CollectionBase.)
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 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 methodIListAdd
Adds an object to the end of the CollectionBase.
(Inherited from CollectionBase.)
Explicit interface implementationPrivate methodIListContains
Determines whether the CollectionBase contains a specific element.
(Inherited from CollectionBase.)
Explicit interface implementationPrivate methodICollectionCopyTo
Copies the entire CollectionBase to a compatible one-dimensional Array, starting at the specified index of the target array.
(Inherited from CollectionBase.)
Explicit interface implementationPrivate methodIListIndexOf
Searches for the specified Object and returns the zero-based index of the first occurrence within the entire CollectionBase.
(Inherited from CollectionBase.)
Explicit interface implementationPrivate methodIListInsert
Inserts an element into the CollectionBase at the specified index.
(Inherited from CollectionBase.)
Explicit interface implementationPrivate propertyIListIsFixedSize
Gets a value indicating whether the CollectionBase has a fixed size.
(Inherited from CollectionBase.)
Explicit interface implementationPrivate methodISortExpressionReadXml
Deserializes the object data on the xml reader into this instance
Explicit interface implementationPrivate methodISortExpressionWriteXml
Serializes the object as xml to the writer specified.
Explicit interface implementationPrivate propertyIListIsReadOnly
Gets a value indicating whether the CollectionBase is read-only.
(Inherited from CollectionBase.)
Explicit interface implementationPrivate propertyICollectionIsSynchronized
Gets a value indicating whether access to the CollectionBase is synchronized (thread safe).
(Inherited from CollectionBase.)
Explicit interface implementationPrivate propertyIListItem
Gets or sets the element at the specified index.
(Inherited from CollectionBase.)
Explicit interface implementationPrivate methodIListRemove
Removes the first occurrence of a specific object from the CollectionBase.
(Inherited from CollectionBase.)
Explicit interface implementationPrivate propertyICollectionSyncRoot
Gets an object that can be used to synchronize access to the CollectionBase.
(Inherited from CollectionBase.)
Top
See Also