Back to Devexpress

GridColumnSortInfoCollection Members

windowsforms-devexpress-dot-xtragrid-dot-columns-dot-gridcolumnsortinfocollection-dot-underscore-members.md

latest18.6 KB
Original Source

GridColumnSortInfoCollection Members

Represents the collection that maintains the sorted and grouping columns for a grid’s View.

Constructors

NameDescription
GridColumnSortInfoCollection(ColumnView)Initializes a new instance of the GridColumnSortInfoCollection class.

Properties

NameDescription
CapacityGets or sets the number of elements that the CollectionBase can contain. Inherited from CollectionBase.
CountGets the number of elements contained in the CollectionBase instance. This property cannot be overridden. Inherited from CollectionBase.
GroupCountGets or sets how many of the elements starting from the beginning of the collection refer to columns used to group data.
InnerList protectedGets an ArrayList containing the list of elements in the CollectionBase instance. Inherited from CollectionBase.
Item[GridColumn]Gets the collection’s item that refers to the specified column.
Item[Int32]Provides indexed access to the elements in the collection.
List protectedGets an IList containing the list of elements in the CollectionBase instance. Inherited from CollectionBase.
ICollection.IsSynchronizedGets a value indicating whether access to the CollectionBase is synchronized (thread safe). Inherited from CollectionBase.
ICollection.SyncRootGets an object that can be used to synchronize access to the CollectionBase. Inherited from CollectionBase.
IList.IsFixedSizeGets a value indicating whether the CollectionBase has a fixed size. Inherited from CollectionBase.
IList.IsReadOnlyGets a value indicating whether the CollectionBase is read-only. Inherited from CollectionBase.
IList.Item[Int32]Gets or sets the element at the specified index. Inherited from CollectionBase.
ViewGets the View which obtains its sorting and grouping settings from the current collection.

Methods

NameDescription
Add(GridColumn, ColumnSortOrder)Adds a new GridColumnSortInfo item to the collection.
Add(GridColumn[], ColumnSortOrder[])Adds a new GridMergedColumnSortInfo item to the collection.
Add(GridColumnSortInfo)Adds the specified GridColumnSortInfo object to the collection.
AddRange(GridColumnSortInfo[], Int32)Adds an array of GridColumnSortInfo objects to the current collection and sets how many columns are used to group data.
AddRange(GridColumnSortInfo[])Adds an array of GridColumnSortInfo objects to the current collection.
BeginUpdate()Locks the GridColumnSortInfoCollection by preventing change notifications from being fired, preventing visual updates until the EndUpdate method is called.
Clear()Removes all objects from the CollectionBase instance. This method cannot be overridden. Inherited from CollectionBase.
ClearAndAddRange(GridColumnSortInfo[], Int32)Clears the collection, then adds the specified objects to it and sets how many columns are used to group data.
ClearAndAddRange(GridColumnSortInfo[])Clears the collection and then adds the specified objects to it.
ClearSorting()Removes the collection’s items which refer to the columns used to sort data (grouping columns are not affected).
EndUpdate()Unlocks the GridColumnSortInfoCollection object after a call to the BeginUpdate method and causes an immediate visual update.
Equals(Object, Object) staticDetermines whether the specified object instances are considered equal. Inherited from Object.
Equals(Object)Determines whether the specified object is equal to the current object. Inherited from Object.
GetEnumerator()Returns an enumerator that iterates through the CollectionBase instance. Inherited from CollectionBase.
GetHashCode()Serves as the default hash function. Inherited from Object.
GetType()Gets the Type of the current instance. Inherited from Object.
IndexOf(GridColumnSortInfo)Returns the index of the specified item in the collection.
Insert(Int32, GridColumn, ColumnSortOrder)Creates a new GridColumnSortInfo object and inserts it at the specified position in the collection.
Insert(Int32, GridColumnSortInfo)Inserts the specified GridColumnSortInfo object at the specified position.
MemberwiseClone() protectedCreates a shallow copy of the current Object. Inherited from Object.
OnClearComplete() protectedPerforms additional custom processes after clearing the contents of the CollectionBase instance. Inherited from CollectionBase.
OnInsert(Int32, Object) protectedPerforms additional custom processes before inserting a new element into the CollectionBase instance. Inherited from CollectionBase.
OnRemove(Int32, Object) protectedPerforms additional custom processes when removing an element from the CollectionBase instance. Inherited from CollectionBase.
OnSet(Int32, Object, Object) protectedPerforms additional custom processes before setting a value in the CollectionBase instance. Inherited from CollectionBase.
OnSetComplete(Int32, Object, Object) protectedPerforms additional custom processes after setting a value in the CollectionBase instance. Inherited from CollectionBase.
OnValidate(Object) protectedPerforms additional custom processes when validating a value. Inherited from CollectionBase.
ReferenceEquals(Object, Object) staticDetermines whether the specified Object instances are the same instance. Inherited from Object.
Remove(GridColumn)Removes the element from the collection that refers to the specified column.
Remove(GridColumnSortInfo)Removes the specified element from the collection.
RemoveAt(Int32)Removes the element at the specified index of the CollectionBase instance. This method is not overridable. Inherited from CollectionBase.
ICollection.CopyTo(Array, Int32)Copies the entire CollectionBase to a compatible one-dimensional Array, starting at the specified index of the target array. Inherited from CollectionBase.
IList.Add(Object)Adds an object to the end of the CollectionBase. Inherited from CollectionBase.
IList.Contains(Object)Determines whether the CollectionBase contains a specific element. Inherited from CollectionBase.
IList.IndexOf(Object)Searches for the specified Object and returns the zero-based index of the first occurrence within the entire CollectionBase. Inherited from CollectionBase.
IList.Insert(Int32, Object)Inserts an element into the CollectionBase at the specified index. Inherited from CollectionBase.
IList.Remove(Object)Removes the first occurrence of a specific object from the CollectionBase. Inherited from CollectionBase.
ToString()Returns a string that represents the current object. Inherited from Object.

See Also

GridColumnSortInfoCollection Class

DevExpress.XtraGrid.Columns Namespace