Endeca Presentation API
ERecSortKey Class
NamespacesEndeca.NavigationERecSortKey
Key with which a record set can or is sorted by.
Declaration Syntax
C#Visual BasicVisual C++
public class ERecSortKey : IComparable
Public Class ERecSortKey _
	Implements IComparable
public ref class ERecSortKey : IComparable
Members
All MembersConstructorsMethodsPropertiesFields



IconMemberDescription
ERecSortKeyERecSortKeyNew(String, Boolean)
Create a new alpha-numeric sort key that specifies a sort on a property and the order with which to sort with regard to that property.

ERecSortKeyERecSortKeyNew(String, Boolean, Double, Double)
Create a new geocode sort key that specifies a sort on a geocode property, the reference geocode and the order with which to sort with regard to that property.

static memberALPHA_NUM_SORT_KEY
This is a sort key for a non-Geocode typed property.

static memberASCENDING
Sort key application in ascending direction.

CompareTo(Object)
Compares the current ERecSortKey to the specified ERecSortKeyobject.

static memberDESCENDING
Sort key application in descending direction.

Equals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Finalize()()
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.)
static memberGEOCODE_SORT_KEY
This is a sort key for a Geocode typed property.

GetHashCode()()
Serves as a hash function for a particular type. GetHashCode()() is suitable for use in hashing algorithms and data structures like a hash table.
(Inherited from Object.)
GetOrder()()
Gets the direction the sort key has been applied to record set if the sort key has been applied, is active.

GetReferenceLatitude()()
Gets the latitude of the reference point for a geocode sort key. It is an error to call this method if GetType() != GEOCODE_SORT_KEY.

GetReferenceLongitude()()
Gets the longitude of the reference point for a geocode sort key. It is an error to call this method if GetType() != GEOCODE_SORT_KEY.

GetType()()
Gets the Type of the current instance.
(Inherited from Object.)
IsActive()()
Returns whether the key is active. Returns whether this sort key is being applied.

MemberwiseClone()()
Creates a shallow copy of the current Object.
(Inherited from Object.)
Name
Gets the name of this sort key.

static memberNOT_ACTIVE
Sort key not applied.

SetGeocode(Double, Double)
Sets the coordinates of the reference point if this is a geocode sort key.

SetOrder(Boolean)
Sets whether or not the sort on this key will be ascending.

ToString()()
Returns a String that represents the current Object.
(Inherited from Object.)
Type
Gets the type of the sort key.

Inheritance Hierarchy
Object
ERecSortKey

Assembly: Endeca.Navigation (Module: Endeca.Navigation) Version: 0.0.0.0