A collection of PivotGridSortExpression objects.
Definition
Namespace:Telerik.Web.UI
Assembly:Telerik.Web.UI.dll
Syntax:
[SuppressMessage("Microsoft.Design", "CA1010:CollectionsShouldImplementGenericInterface")]
[TypeConverter(typeof(ExpandableObjectConverter))]
public class PivotGridSortExpressionCollection : IList, ICollection, IEnumerable, IStateManagerInheritance: objectPivotGridSortExpressionCollection
Implements:
Inherited Members
Properties
Returns the number of items in the RadPivotGridSortExpressionCollection.
[Browsable(false)]
public int Count { get; }Implements:
Gets a value indicating whether access to the RadPivotGridSortExpressionCollection is synchronized (thread safe).
[Browsable(false)]
public bool IsSynchronized { get; }Implements:
This is the default indexer of the collection - takes an integer value.
Methods
Adds a PivotGridSortExpression to the collection.
Adds a PivotGridSortExpression to the collection at the specified index.
public void AddAt(int index, PivotGridSortExpression sortExpression)Adds the sortExpression in the collection.
public void AddSortExpression(PivotGridSortExpression sortExpression)Adds the sortExpression in the collection.
public void AddSortExpression(string expression)String containing sort field and optionaly sort order (ASC or DESC)
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.
Clears the RadPivotGridSortExpressionCollection of all items.
public void Clear()Implements:
Returns true or false depending on whether the specified sorting expression exists in the collection. Takes a PivotGridSortExpression parameter.
public bool ContainsSortExpression(PivotGridSortExpression sortExpression)Returns an enumerator that iterates through the RadPivotGridSortExpressionCollection.
Find a SortExpression in the collection if it contains any with sort field = expression
public PivotGridSortExpression GetExpression(string expression)sort field
Returns: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
[SuppressMessage("Microsoft.Design", "CA1024:UsePropertiesWhereAppropriate")]
public string GetSortString()Comma separated list of sort fields and optionaly sort-order, null if there are no sort expressions in the collection
Searches for the specified PivotGridSortExpression and returns the zero-based index of the first occurrence within the entire PivotGridSortExpressionCollection.
public int IndexOf(PivotGridSortExpression viewSortExpression)Removes the specified PivotGridSortExpression from the collection.
public void RemoveSortExpression(PivotGridSortExpression sortExpression)