Class SortColumnDescriptorCollection

A collection of SortColumnDescriptor descriptors that define the sort order or grouping of a table. An instance of this collection is returned by the SortedColumns or GroupedColumns property of a TableDescriptor.

Inheritance

System.Object

SortColumnDescriptorCollection

RelationChildColumnDescriptorCollection

Implements

System.IDisposable

System.Collections.IList

System.Collections.ICollection

System.Collections.IEnumerable

IInsideCollectionEditorProperty

System.ICloneable

System.ComponentModel.ICustomTypeDescriptor

Inherited Members

System.Object.Equals(System.Object, System.Object)

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

Namespace: Syncfusion.Grouping

Assembly: Syncfusion.Grouping.Base.dll

Syntax

public class SortColumnDescriptorCollection : IDisposable, IList, ICollection, IEnumerable, IInsideCollectionEditorProperty, ICloneable, ICustomTypeDescriptor

Constructors

SortColumnDescriptorCollection()

Initializes a new instance for SortColumnDescriptorCollection empty collection.

Declaration

public SortColumnDescriptorCollection()

SortColumnDescriptorCollection(TableDescriptor)

Initializes a new empty collection and attaches it to a TableDescriptor

Declaration

public SortColumnDescriptorCollection(TableDescriptor tableDescriptor)

Parameters

Type	Name	Description
TableDescriptor	tableDescriptor	Table descriptor.

Fields

Empty

A Read-only and empty collection.

Declaration

public static readonly SortColumnDescriptorCollection Empty

Field Value

Type
SortColumnDescriptorCollection

Properties

Count

Gets the number of elements contained in the collection. The property also ensures that the collection is in sync with the underlying table if changes have been made to the table or the TableDescriptor.

Declaration

public int Count { get; }

Property Value

Type
System.Int32

Remarks

If changes in the TableDescriptor are detected, the method will reinitialize the field descriptors before returning the count.

InsideCollectionEditor

Gets or sets whether the collection is manipulated inside a collection editor.

Declaration

public bool InsideCollectionEditor { get; set; }

Property Value

Type
System.Boolean

IsFixedSize

Returns False since this collection has no fixed size.

Declaration

public bool IsFixedSize { get; }

Property Value

Type
System.Boolean

IsModified

Determines if the collection was modified from its default state.

Declaration

public bool IsModified { get; }

Property Value

Type
System.Boolean

IsReadOnly

Returns False.

Declaration

public bool IsReadOnly { get; }

Property Value

Type
System.Boolean

IsSynchronized

Returns False.

Declaration

public bool IsSynchronized { get; }

Property Value

Type
System.Boolean

Item[Int32]

Gets or sets the element at the zero-based index.

Declaration

public SortColumnDescriptor this[int index] { get; set; }

Parameters

Type	Name	Description
System.Int32	index

Property Value

Type
SortColumnDescriptor

Item[String]

Gets or sets the element with the specified name.

Declaration

public SortColumnDescriptor this[string name] { get; set; }

Parameters

Type	Name	Description
System.String	name

Property Value

Type
SortColumnDescriptor

ShouldPopulate

Gets or sets whether collection should check for changes in engine schema or underlying data source schema when EnsureInitialized gets called.

Declaration

public bool ShouldPopulate { get; set; }

Property Value

Type
System.Boolean

Version

The version number of this collection. The version is increased each time the collection or an element within the collection was modified.

Declaration

public int Version { get; }

Property Value

Type
System.Int32

Methods

Add(SortColumnDescriptor)

Adds a SortColumnDescriptor to the end of the collection.

Declaration

public int Add(SortColumnDescriptor value)

Parameters

Type	Name	Description
SortColumnDescriptor	value	The element to be added to the end of the collection. The value must not be a NULL reference (Nothing in Visual Basic).

Returns

Type	Description
System.Int32	The zero-based collection index at which the value has been added.

Add(String)

Creates a SortColumnDescriptor with ListSortDirection.Ascending and adds it to the end of the collection.

Declaration

public int Add(string name)

Parameters

Type	Name	Description
System.String	name	The field name.

Returns

Type	Description
System.Int32	The zero-based collection index at which the value has been added.

Add(String, ListSortDirection)

Creates a SortColumnDescriptor and adds it to the end of the collection.

Declaration

public int Add(string name, ListSortDirection sortDirection)

Parameters

Type	Name	Description
System.String	name	The field name.
System.ComponentModel.ListSortDirection	sortDirection	The sort direction.

Returns

Type	Description
System.Int32	The zero-based collection index at which the value has been added.

AddRange(SortColumnDescriptor[])

Adds multiple elements at the end of the collection.

Declaration

public void AddRange(SortColumnDescriptor[] columnDescriptors)

Parameters

Type	Name	Description
SortColumnDescriptor[]	columnDescriptors	The array whose elements should be added to the end of the collection. The array and its elements cannot be NULL references (Nothing in Visual Basic).

BumpVersion()

Increases the version counter for this collection.

Declaration

public void BumpVersion()

CheckOutOfDate()

Called internally to ensure all field descriptors are up to date after table descriptor is changed.

Declaration

protected virtual bool CheckOutOfDate()

Returns

Type	Description
System.Boolean	true if field descriptors need to be reinitialized

CheckType(Object)

Ensure type correctness when a new element is added to the collection.

Declaration

protected virtual void CheckType(object obj)

Parameters

Type	Name	Description
System.Object	obj	The newly added object.

Clear()

Removes all elements from the collection.

Declaration

public void Clear()

Clone()

Creates a copy of the collection and all its elements.

Declaration

public SortColumnDescriptorCollection Clone()

Returns

Type	Description
SortColumnDescriptorCollection	A copy of the collection and all its elements.

Contains(SortColumnDescriptor)

Determines if the element belongs to this collection.

Declaration

public bool Contains(SortColumnDescriptor value)

Parameters

Type	Name	Description
SortColumnDescriptor	value	The element to locate in the collection. The value can be a NULL reference (Nothing in Visual Basic).

Returns

Type	Description
System.Boolean	True if item is found in the collection; otherwise, False.

Contains(String)

Determines if the element with the specified name belongs to this collection.

Declaration

public bool Contains(string name)

Parameters

Type	Name	Description
System.String	name	The name of the element to locate in the collection.

Returns

Type	Description
System.Boolean	True if item is found in the collection; otherwise, False.

CopyAllMembersTo(SortColumnDescriptorCollection)

Copies all members to another collection.

Declaration

protected void CopyAllMembersTo(SortColumnDescriptorCollection coll)

Parameters

Type	Name	Description
SortColumnDescriptorCollection	coll	The target collection.

CopyTo(SortColumnDescriptor[], Int32)

Copies the entire collection to a compatible one-dimensional Array, starting at the specified index of the target array.

Declaration

public void CopyTo(SortColumnDescriptor[] array, int index)

Parameters

Type	Name	Description
SortColumnDescriptor[]	array	The one-dimensional array that is the destination of the elements copied from the ArrayList. The array must have zero-based indexing.
System.Int32	index	The zero-based index in an array at which copying begins.

Dispose()

Disposes the object and collection items.

Declaration

public void Dispose()

EnableOneTimePopulate()

When called the ShouldPopulate property will be set true temporarily until the next EnsureInitialized call and then be reset again to optimize subsequent lookups. The Engine calls this method when schema changes occurred (PropertyChanged was raised).

Declaration

public void EnableOneTimePopulate()

Equals(Object)

Determines if the specified object and current object are equal.

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
System.Object	obj	An object to compare.

Returns

Type	Description
System.Boolean	True if the objects are equal; False otherwise.

Overrides

System.Object.Equals(System.Object)

GetEnumerator()

Returns an enumerator for the entire collection.

Declaration

public SortColumnDescriptorCollectionEnumerator GetEnumerator()

Returns

Type	Description
SortColumnDescriptorCollectionEnumerator	An Enumerator for the entire collection.

Remarks

Enumerators only allow reading the data in the collection. Enumerators cannot be used to modify the underlying collection.

GetHashCode()

Serves as a hash function.

Declaration

public override int GetHashCode()

Returns

Type	Description
System.Int32	Hash code for the current object.

Overrides

System.Object.GetHashCode()

IndexOf(SortColumnDescriptor)

Returns the zero-based index of the occurrence of the element in the collection.

Declaration

public int IndexOf(SortColumnDescriptor value)

Parameters

Type	Name	Description
SortColumnDescriptor	value	The element to locate in the collection. The value can be a NULL reference (Nothing in Visual Basic).

Returns

Type	Description
System.Int32	The zero-based index of the occurrence of the element within the entire collection, if found; otherwise, -1.

IndexOf(String)

Searches for the element with the specified name.

Declaration

public int IndexOf(string name)

Parameters

Type	Name	Description
System.String	name	The name of the element to locate in the collection.

Returns

Type	Description
System.Int32	The zero-based index of the occurrence of the element with matching name within the entire collection, if found; otherwise, -1.

InitializeFrom(SortColumnDescriptorCollection)

Copies settings from another collection and raises Changing and Changed events if differences to the other collection are detected.

Declaration

public void InitializeFrom(SortColumnDescriptorCollection other)

Parameters

Type	Name	Description
SortColumnDescriptorCollection	other	The source collection.

InitializeFrom(SortColumnDescriptorCollection, Boolean)

Copies settings from another collection and raises Changing and Changed events if differences to the other collection are detected.

Declaration

public bool InitializeFrom(SortColumnDescriptorCollection other, bool raiseChangeEvents)

Parameters

Type	Name	Description
SortColumnDescriptorCollection	other	The source collection.
System.Boolean	raiseChangeEvents	Specifies if Changing and Changed events should be raised.

Returns

Type	Description
System.Boolean	True if successfully initialized; False otherwise.

Insert(Int32, SortColumnDescriptor)

Inserts a descriptor element into the collection at the specified index.

Declaration

public void Insert(int index, SortColumnDescriptor value)

Parameters

Type	Name	Description
System.Int32	index	The zero-based index at which the element should be inserted.
SortColumnDescriptor	value	The element to insert. The value must not be a NULL reference (Nothing in Visual Basic).

LoadDefault()

Resets the collection to its default state, auto populates the collection, and marks the collection as modified. Call this method if you want to load the default items for the collection and then modify them (e.g. remove members from the auto-populated list).

Declaration

public void LoadDefault()

OnChanged(ListPropertyChangedEventArgs)

Raises the Changed event.

Declaration

protected virtual void OnChanged(ListPropertyChangedEventArgs e)

Parameters

Type	Name	Description
ListPropertyChangedEventArgs	e	A ListPropertyChangedEventArgs that contains the event data.

OnChanging(ListPropertyChangedEventArgs)

Raises the Changed event.

Declaration

protected virtual void OnChanging(ListPropertyChangedEventArgs e)

Parameters

Type	Name	Description
ListPropertyChangedEventArgs	e	A ListPropertyChangedEventArgs that contains the event data.

Remove(SortColumnDescriptor)

Removes the specified descriptor element from the collection.

Declaration

public void Remove(SortColumnDescriptor value)

Parameters

Type	Name	Description
SortColumnDescriptor	value	The element to remove from the collection. If the value is NULL or the element is not contained in the collection, the method will do nothing.

Remove(String)

Removes the specified descriptor element with the specified name from the collection.

Declaration

public void Remove(string name)

Parameters

Type	Name	Description
System.String	name	The name of the element to remove from the collection. If no element with that name is found in the collection, the method will do nothing.

RemoveAt(Int32)

Removes the element at the specified index of the collection.

Declaration

public void RemoveAt(int index)

Parameters

Type	Name	Description
System.Int32	index	The zero-based index of the element to remove.

Reset()

Resets the collection to its default state. If the collection is bound to a TableDescriptor, the collection will auto populate itself the next time an item inside the collection is accessed.

Declaration

public void Reset()

ToArray()

Returns an array of SortColumnDescriptor objects where elements reference items in this collection. (Elements are not copied).

Declaration

public SortColumnDescriptor[] ToArray()

Returns

Type	Description
SortColumnDescriptor[]	An array of SortColumnDescriptor objects.

ToString()

Returns a string representation of the current object.

Declaration

public override string ToString()

Returns

Type	Description
System.String	A string holding the current object.

Overrides

System.Object.ToString()

Events

Changed

Occurs after a property in a nested element or the collection was changed.

Declaration

public event ListPropertyChangedEventHandler Changed

Event Type

Type
ListPropertyChangedEventHandler

Changing

Occurs before a property in a nested element or the collection is changed.

Declaration

public event ListPropertyChangedEventHandler Changing

Event Type

Type
ListPropertyChangedEventHandler

Explicit Interface Implementations

IInsideCollectionEditorProperty.InitializeFrom(Object)

Declaration

void IInsideCollectionEditorProperty.InitializeFrom(object other)

Parameters

Type	Name	Description
System.Object	other

ICollection.CopyTo(Array, Int32)

Copies the elements of the collections an array, starting at a particular index.

Declaration

void ICollection.CopyTo(Array array, int index)

Parameters

Type	Name	Description
System.Array	array	The one-dimensional array that is the destination of the elements copied from collection.
System.Int32	index	The specified index.

ICollection.SyncRoot

Returns null value.

Declaration

object ICollection.SyncRoot { get; }

Returns

Type
System.Object

IEnumerable.GetEnumerator()

Returns an enumerator that iterates through a collection.

Declaration

IEnumerator IEnumerable.GetEnumerator()

Returns

Type	Description
System.Collections.IEnumerator	An System.Collections.IEnumerator object that can be used to iterate through the collection.

IList.Add(Object)

Add the specific value to the Collection.

Declaration

int IList.Add(object value)

Parameters

Type	Name	Description
System.Object	value	The object to be inserted into the collection.

Returns

Type	Description
System.Int32	Returns the index of the added object; Otherwise -1.

IList.Contains(Object)

Determines whether the System.Collections.IList contains a specific value or not.

Declaration

bool IList.Contains(object value)

Parameters

Type	Name	Description
System.Object	value	The object to be located in the collection.

Returns

Type	Description
System.Boolean	True if the object is found in the collection; otherwise False.

IList.get_Item(Int32)

Declaration

object IList.get_Item(int index)

Parameters

Type	Name	Description
System.Int32	index

Returns

Type
System.Object

IList.IndexOf(Object)

Determines the index of a specific item in the System.Collections.IList.

Declaration

int IList.IndexOf(object value)

Parameters

Type	Name	Description
System.Object	value	The object to locate in the System.Collections.IList.

Returns

Type	Description
System.Int32	The index of value if found in the list; otherwise, -1.

IList.Insert(Int32, Object)

Inserts an item to the System.Collections.IList at the specified index.

Declaration

void IList.Insert(int index, object value)

Parameters

Type	Name	Description
System.Int32	index	The zero-based index at which value should be inserted.
System.Object	value	The object to insert into the collection.

IList.Item[Int32]

Gets or sets the element at the specified index.

Declaration

object IList.this[] { get; set; }

Parameters

Type	Name	Description
System.Int32	index	The zero-based index of the element to get or set.

Returns

Type	Description
System.Object	The element at the specified index.

IList.Remove(Object)

Removes the first occurrence of a specific object from the System.Collections.IList.

Declaration

void IList.Remove(object value)

Parameters

Type	Name	Description
System.Object	value	The object to be removed from the collection.

IList.set_Item(Int32, Object)

Declaration

void IList.set_Item(int index, object value)

Parameters

Type	Name	Description
System.Int32	index
System.Object	value

ICloneable.Clone()

Creates the clone of this object.

Declaration

object ICloneable.Clone()

Returns

Type	Description
System.Object	Returns the cloned object.

Implements

System.IDisposable

System.Collections.IList

System.Collections.ICollection

System.Collections.IEnumerable

IInsideCollectionEditorProperty

System.ICloneable

System.ComponentModel.ICustomTypeDescriptor