Class SortColumns

Namespace

Spire.Xls.Core.Spreadsheet.Sorting

Assembly

Spire.XLS.dll

Represents the sort column collection.

public class SortColumns : CollectionExtended<SortColumn>, IList<SortColumn>, ICollection<SortColumn>, IEnumerable<SortColumn>, IExcelApplication, ICloneParent, ISortColumns, IEnumerable

Inheritance

object

CollectionBase<SortColumn>

CollectionExtended<SortColumn>

SortColumns

Implements

IList<SortColumn>

ICollection<SortColumn>

IEnumerable<SortColumn>

IExcelApplication

ICloneParent

ISortColumns

IEnumerable

Inherited Members

CollectionExtended<SortColumn>.OnClear()

CollectionExtended<SortColumn>.OnClearComplete()

CollectionExtended<SortColumn>.OnInsert(int, SortColumn)

CollectionExtended<SortColumn>.OnInsertComplete(int, SortColumn)

CollectionExtended<SortColumn>.OnRemove(int, SortColumn)

CollectionExtended<SortColumn>.OnRemoveComplete(int, SortColumn)

CollectionExtended<SortColumn>.OnSet(int, SortColumn, SortColumn)

CollectionExtended<SortColumn>.OnSetComplete(int, SortColumn, SortColumn)

CollectionExtended<SortColumn>.FindParent(Type)

CollectionExtended<SortColumn>.FindParent(Type, bool)

CollectionExtended<SortColumn>.SetParent(object)

CollectionExtended<SortColumn>.Clone(object)

CollectionExtended<SortColumn>.EnsureCapacity(int)

CollectionExtended<SortColumn>.GenerateDefaultName(ICollection<SortColumn>, string)

CollectionExtended<SortColumn>.GenerateDefaultName(ICollection, string)

CollectionExtended<SortColumn>.GenerateDefaultName(string, params ICollection[])

CollectionExtended<SortColumn>.ChangeName(IDictionary, XlsEventArgs)

CollectionExtended<SortColumn>.Parent

CollectionExtended<SortColumn>.Changed

CollectionBase<SortColumn>.Insert(int, SortColumn)

CollectionBase<SortColumn>.IndexOf(SortColumn)

CollectionBase<SortColumn>.Add(SortColumn)

CollectionBase<SortColumn>.Contains(SortColumn)

CollectionBase<SortColumn>.CopyTo(SortColumn[], int)

CollectionBase<SortColumn>.InnerList

CollectionBase<SortColumn>.List

CollectionBase<SortColumn>.IsReadOnly

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Properties

Capacity

public int Capacity { get; set; }

Property Value

int

Count

public int Count { get; }

Property Value

int

this[int]

public SortColumn this[int fieldIndex] { get; }

Parameters

fieldIndex int

Property Value

SortColumn

Methods

Add(int, OrderBy)

Adds the item in the collection.

public SortColumn Add(int key, OrderBy orderBy)

Parameters

key int

Column Index to sort the data.

orderBy OrderBy

To order the sorted data.

Returns

SortColumn

Added sort column.

Add(int, SortComparsionType, OrderBy)

Adds the item in the collection.

public SortColumn Add(int key, SortComparsionType sortComparsionType, OrderBy orderBy)

Parameters

key int

Column Index to sort the data.

sortComparsionType SortComparsionType

Compare value type.

orderBy OrderBy

To order the sorted data.

Returns

SortColumn

Added sort column.

Add(int, string[])

Adds the item in the collection.

public SortColumn Add(int key, string[] customSortOrder)

Parameters

key int

Column Index to sort the data.

customSortOrder string[]

Custom order to order the sorted data.

Returns

SortColumn

Added sort column.

Clear()

public void Clear()

GetByIndex(int)

public SortColumn GetByIndex(int index)

Parameters

index int

Returns

SortColumn

GetEnumerator()

public IEnumerator GetEnumerator()

Returns

IEnumerator

Remove(SortColumn)

public void Remove(SortColumn sortColumn)

Parameters

sortColumn SortColumn

Remove(int)

Remvoes the Sort item in the collection.

public void Remove(int key)

Parameters

key int

RemoveAt(int)

public void RemoveAt(int index)

Parameters

index int