ToString Method

Returns the string form of this OrderBy.

Declaration Syntax

Visual Basic

Visual C++

public override string ToString()

Public Overrides Function ToString As String

public:
virtual String^ ToString () override

Return Value

The string form of this OrderBy.

Remarks

For an ascending sort, the OrderBy format is:

CopyC#

<i>key-sort-name</i> ASC

For a descending sort, the format is:

CopyC#

<i>key-sort-name</i> DESC

where key-sort-name is the Endeca property or dimension by which the records will be sorted.

Examples

This string:

CopyC#

YearSales ASC

is returned if the sorting key is a property named YearSales and an ascending sort direction has been set.

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