GrapeCity.Spreadsheet.ISortFields.Add

Add Method

Add(IRange, SortOn, SortOrder, SortDataOption)

Creates a new sort field and returns an ISortField object.

Declaration

ISortField Add(IRange key, SortOn sortOn = SortOn.Value, SortOrder order = SortOrder.Ascending, SortDataOption dataOption = SortDataOption.Normal)

Function Add(key As IRange, Optional sortOn As SortOn = SortOn.Value, Optional order As SortOrder = SortOrder.Ascending, Optional dataOption As SortDataOption = SortDataOption.Normal) As ISortField

Parameters

Type	Name	Description
IRange	key	Specifies a key value for the sort.
SortOn	sortOn	The field to sort on.
SortOrder	order	Specifies the sort order.
SortDataOption	dataOption	Specifies the data option.

Returns

Type	Description
ISortField	The new created ISortField object.

Add(string, SortOn, SortOrder, SortDataOption)

Creates a new sort field and returns an ISortField object.

Declaration

ISortField Add(string key, SortOn sortOn = SortOn.Value, SortOrder order = SortOrder.Ascending, SortDataOption dataOption = SortDataOption.Normal)

Function Add(key As String, Optional sortOn As SortOn = SortOn.Value, Optional order As SortOrder = SortOrder.Ascending, Optional dataOption As SortDataOption = SortDataOption.Normal) As ISortField

Parameters

Type	Name	Description
string	key	Specifies a key value for the sort.
SortOn	sortOn	The field to sort on.
SortOrder	order	Specifies the sort order.
SortDataOption	dataOption	Specifies the data option.

Returns

Type	Description
ISortField	The new created ISortField object.

Add(Reference, SortOn, SortOrder, SortDataOption)

Creates a new sort field and returns an ISortField object.

Declaration

ISortField Add(Reference key, SortOn sortOn = SortOn.Value, SortOrder order = SortOrder.Ascending, SortDataOption dataOption = SortDataOption.Normal)

Function Add(key As Reference, Optional sortOn As SortOn = SortOn.Value, Optional order As SortOrder = SortOrder.Ascending, Optional dataOption As SortDataOption = SortDataOption.Normal) As ISortField

Parameters

Type	Name	Description
Reference	key	Specifies a key value for the sort.
SortOn	sortOn	The field to sort on.
SortOrder	order	Specifies the sort order.
SortDataOption	dataOption	Specifies the data option.

Returns

Type	Description
ISortField	The new created ISortField object.

Add(int, SortOn, SortOrder, SortDataOption)

Creates a new sort field and returns an ISortField object.

Declaration

ISortField Add(int key, SortOn sortOn = SortOn.Value, SortOrder order = SortOrder.Ascending, SortDataOption dataOption = SortDataOption.Normal)

Function Add(key As Integer, Optional sortOn As SortOn = SortOn.Value, Optional order As SortOrder = SortOrder.Ascending, Optional dataOption As SortDataOption = SortDataOption.Normal) As ISortField

Parameters

Type	Name	Description
int	key	Specifies a key value for the sort.
SortOn	sortOn	The field to sort on.
SortOrder	order	Specifies the sort order.
SortDataOption	dataOption	Specifies the data option.

Returns

Type	Description
ISortField	The new created ISortField object.