Edit this page

Telerik.Web.UI.PivotGridSortExpressionCollection

A collection of Telerik.Web.UI.PivotGridSortExpression objects.

Inheritance Hierarchy

  • System.Object
  • Telerik.Web.UI.PivotGridSortExpressionCollection : ICollection, IEnumerable, IList, IStateManager

Properties

Count Int32

Returns the number of items in the RadPivotGridSortExpressionCollection.

IsSynchronized Boolean

Gets a value indicating whether access to the RadPivotGridSortExpressionCollection is
synchronized (thread safe).

Item PivotGridSortExpression

This is the default indexer of the collection - takes an integer value.

SyncRoot Object

Gets an object that can be used to synchronize access to the
RadPivotGridSortExpressionCollection.

Methods

Add

Adds a to the collection.

Returns

System.Int32

AddAt

Adds a to the collection at the specified
index.

Returns

System.Void

AddSortExpression

Adds the sortExpression in the collection.

Parameters

sortExpression Telerik.Web.UI.PivotGridSortExpression

Returns

System.Void

AddSortExpression

Adds the sortExpression in the collection.

Parameters

expression System.String

String containing sort field and optionaly sort order (ASC or DESC)

Returns

System.Void

ChangeSortOrder

Adds the sort field (expression parameter) if the collection does not alreqady contain the field. Else the sort order of the field will be inverted. The default change order is
Asc -> Desc.

Parameters

expression System.String

AllowNaturalSort System.Boolean

Parameter that indicates whether natural sorting is enabled.

Returns

System.Void

Clear

Clears the RadPivotGridSortExpressionCollection of all items.

Returns

System.Void

ContainsExpression

Returns true or false depending on whether the specified sorting expression
exists in the collection. Takes a string parameter.

Returns

System.Boolean

ContainsSortExpression

Returns true or false depending on whether the specified sorting expression exists
in the collection. Takes a parameter.

Returns

System.Boolean

GetEnumerator

Returns an enumerator that iterates through the
RadPivotGridSortExpressionCollection.

Returns

System.Collections.IEnumerator

GetExpression

Find a SortExpression in the collection if it contains any with sort field = expression

Parameters

expression System.String

sort field

Returns

Telerik.Web.UI.PivotGridSortExpression

GetSortString

Get a comma separated list of sort fields and sort-order, in the same format used by
DataView.Sort string expression. Returns null (Nothing) if there are no sort expressions in the collection

Returns

System.String Comma separated list of sort fields and optionaly sort-order, null if there are no sort expressions in the collection

IndexOf

Searches for the specified
and
returns the zero-based index of the first occurrence within the entire
.

Returns

System.Int32

RemoveSortExpression

Removes the specified from the collection.

Returns

System.Void