KaxListViewSortExpressionCollection Class

A collection of KaxListViewSortExpression objects. Depending on the value of AllowMultiFieldSorting it holds single or multiple sort expressions.

Inheritance Hierarchy

SystemObject
Kettic.AspNet.ControlsKaxListViewSortExpressionCollection

Namespace: Kettic.AspNet.Controls
Assembly: Kettic.AspNet.Controls (in Kettic.AspNet.Controls.dll) Version: 2014.4.1129.0 (2014.04.1129.0)

Syntax

C++

Copy

[TypeConverterAttribute(typeof(ExpandableObjectConverter))]
public class KaxListViewSortExpressionCollection : IList, 
	ICollection, IEnumerable, IStateManager

<TypeConverterAttribute(GetType(ExpandableObjectConverter))> 
Public Class KaxListViewSortExpressionCollection
	Implements IList, ICollection, IEnumerable, IStateManager

[TypeConverterAttribute(typeof(ExpandableObjectConverter))]
public ref class KaxListViewSortExpressionCollection : IList, 
	ICollection, IEnumerable, IStateManager

[<TypeConverterAttribute(typeof(ExpandableObjectConverter))>]
type KaxListViewSortExpressionCollection =  
    class
        interface IList
        interface ICollection
        interface IEnumerable
        interface IStateManager
    end

The KaxListViewSortExpressionCollection type exposes the following members.

Methods

	Name	Description
	Add	Adds a KaxListViewSortExpression to the collection.
	AddAt	Adds a KaxListViewSortExpression to the collection at the specified index.
	AddSortExpression(String)	If AllowMultiFieldSorting is true adds the sortExpression in the collection. Else any other expression previously stored in the collection wioll be removed
	AddSortExpression(KaxListViewSortExpression)	If AllowMultiFieldSorting is true adds the sortExpression in the collection. Else any other expression previously stored in the collection wioll be removed
	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 -> No Sort. The No-Sort state can be controlled using AllowNaturalSort property
	Clear	Clears the KaxListViewSortExpressionCollection of all items.
	ContainsExpression	Returns true or false depending on whether the specified sorting expression exists in the collection. Takes a string parameter.
	ContainsSortExpression	Returns true or false depending on whether the specified sorting expression exists in the collection. Takes a KaxListViewSortExpression parameter.
	GetEnumerator	Returns an enumerator that iterates through the KaxListViewSortExpressionCollection.
	GetExpression	Find a SortExpression in the collection if it contains any with sort field = expression
	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
	IndexOf	Searches for the specified KaxListViewSortExpression and returns the zero-based index of the first occurrence within the entire KaxListViewSortExpressionCollection.
	RemoveSortExpression	Removes the specified KaxListViewSortExpression from the collection.

Top

Properties

Name

Description

AllowMultiFieldSorting

If false, the collection can contain only one sort expression at a time. Trying to add a new one in this case will delete the existing expression or will change the sort order if its FiledName is the same.

AllowNaturalSort

Allow the no-sort state when changing sort order.

Count

Returns the number of items in the KaxListViewSortExpressionCollection.

IsSynchronized

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

Item

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

SyncRoot

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

Top

Reference

Kettic.AspNet.Controls Namespace