SftBoxItems.Sort Method	Softel vdm, Inc.

Sorts items.

Syntax       

		VB.NET	object.Sort(ByVal ItemIndex As Integer, ByVal ColNum As Short, ByVal SortType As SftBoxSortConstants)
		VB	object.Sort(ByVal ItemIndex As Long, ByVal ColNum As Integer, ByVal SortType As SftBoxSortConstants)
		C#.NET	void object.Sort(int ItemIndex, short ColNum, SftBoxSortConstants SortType);
		VC++	HRESULT object->Sort(long ItemIndex, short ColNum, enum SftBoxSortConstants SortType);
		C	HRESULT object->raw_Sort(long ItemIndex, short ColNum, enum SftBoxSortConstants SortType);
		Delphi	procedure object.Sort(ItemIndex : Integer, ColNum : Smallint, SortType : TOleEnum);

object

A SftBoxItems object.

ItemIndex

The zero-based index of the item whose dependents are to be sorted. Specify -1 to sort all items.

ColNum

The zero-based index of the column whose contents are to be used for sorting purposes.

SortType

Defines the sorting method used.

Name	Value	Description
sortSftBoxAscending	0	Items defined by ItemIndex are sorted using the Cell.Text property in column ColNum, in ascending fashion. The SortCompare event is not used.
sortSftBoxDescending	1	Items defined by ItemIndex are sorted using the Cell.Text property in column ColNum, in descending fashion. The SortCompare event is not used.
sortSftBoxCellValueAscending	2	Items defined by ItemIndex are sorted using the Cell.Data property in column ColNum, in ascending fashion. The SortCompare event is not used.
sortSftBoxCellValueDescending	3	Items defined by ItemIndex are sorted using the Cell.Data property in column ColNum, in descending fashion. The SortCompare event is not used.
sortSftBoxItemTagStringAscending	4	Items defined by ItemIndex are sorted using the Item.DataTag property, in ascending fashion. The Item.DataTag property is interpreted as a string. The SortCompare event is not used. The ColNum parameter is not used, but must be a valid column.
sortSftBoxItemTagStringDescending	5	Items defined by ItemIndex are sorted using the Item.DataTag property, in descending fashion. The Item.DataTag property is interpreted as a string. The SortCompare event is not used. The ColNum parameter is not used, but must be a valid column.
sortSftBoxItemTagLongAscending	6	Items defined by ItemIndex are sorted using the Item.DataTag property, in ascending fashion. The Item.DataTag property is interpreted as a Long value. The SortCompare event is not used. The ColNum parameter is not used, but must be a valid column.
sortSftBoxItemTagLongDescending	7	Items defined by ItemIndex are sorted using the Item.DataTag property, in descending fashion. The Item.DataTag property is interpreted as a Long value. The SortCompare event is not used. The ColNum parameter is not used, but must be a valid column.
sortSftBoxItemTag	8	Items defined by ItemIndex are sorted using the SortCompare event. The SortCompare event receives the Cell(ColNum).Text, Item.DataTag and Cell(ColNum).Data properties for each item as arguments.
sortSftBoxCellTag	9	Items defined by ItemIndex are sorted using the SortCompare event. The SortCompare event receives the Cell(ColNum).Text, Cell(ColNum).DataTag and Cell(ColNum).Data properties for each item as arguments.
sortSftBoxCellText	10	Items defined by ItemIndex are sorted using the SortCompare event. The SortCompare event receives the Cell(ColNum).Text properties for each item as arguments. The parameters vData and Value of the SortCompare event are not used.

Comments

The Sort method sorts items.

Based on the specified column number ColNum, the immediate dependents of the specified item ItemIndex are sorted according to the SortType specified. To sort all items specify ItemIndex as -1.

When sorting dependents, only immediate dependents are sorted, i.e., items on the immediate lower level. Dependents of items being sorted are moved with their parent item, but are not sorted. Invoke the Sort method separately for each parent item to be sorted.