SortDependents Method, SftTreeItems Object


	SftTreeItems.SortDependents Method	Softel vdm, Inc.

Sorts an item's dependents.

Syntax

		VB.NET	Result = object.SortDependents(ByVal ItemIndex As Integer, ByVal ColIndex As Short, ByVal SortType As SftTreeSortTypeConstants) As Boolean
		VB	Result = object.SortDependents(ByVal ItemIndex As Long, ByVal ColIndex As Integer, ByVal SortType As SftTreeSortTypeConstants) As Boolean
		C#.NET	bool Result = object.SortDependents(int ItemIndex, short ColIndex, SftTreeSortTypeConstants SortType);
		VC++	VARIANT_BOOL Result = object->SortDependents(long ItemIndex, short ColIndex, enum SftTreeSortTypeConstants SortType);
		C	HRESULT object->raw_SortDependents(long ItemIndex, short ColIndex, enum SftTreeSortTypeConstants SortType, VARIANT_BOOL* Result);
		Delphi	Result := object.SortDependents(ItemIndex : Integer; ColIndex : Smallint; SortType : TOleEnum) : WordBool;

object

A SftTreeItems object.

ItemIndex

The zero-based index of the item whose immediate dependents are to be sorted. If ItemIndex is -1, the items on the root level (level 0) are sorted.

ColIndex

The zero-based column number to be sorted.

SortType

The sort method to be used.

SortType	Value	Description
sortSftTreeAscending	0	The immediate dependents are sorted in an ascending fashion (not case sensitive) based on their cell text in column ColIndex.
sortSftTreeDescending	1	The immediate dependents are sorted in a descending fashion (not case sensitive) based on their cell text in column ColIndex.
sortSftTreeAscItemData	2	The immediate dependents are sorted in an ascending fashion based on their Item.Data property value (ColIndex is ignored, but must be valid).
sortSftTreeDscItemData	3	The immediate dependents are sorted in a descending fashion based on their Item.Data property value (ColIndex is ignored, but must be valid).
sortSftTreeAscItemDataFloat	4	The immediate dependents are sorted in an ascending fashion based on their Item.DataFloat property value (ColIndex is ignored, but must be valid).
sortSftTreeDscItemDataFloat	5	The immediate dependents are sorted in a descending fashion based on their Item.DataFloat property value (ColIndex is ignored, but must be valid).
sortSftTreeEvent	6	The immediate dependents are sorted in a fashion determined by the SortCompare event. The SortCompare event is generated to compare two items. It is only generated for a SortType of sortSftTreeEvent, sortSftTreeEventCell or sortSftTreeEventWithIndex. For other SortType values, the event is not generated.
sortSftTreeEventCell	7	The immediate dependents are sorted in a fashion determined by the SortCompare event. The SortCompare event is generated to compare two items. It is only generated for a SortType of sortSftTreeEvent, sortSftTreeEventCell or sortSftTreeEventWithIndex. For other SortType values, the event is not generated.
sortSftTreeAscCellItemData	8	The immediate dependents are sorted in an ascending fashion based on their Cell.Data property value.
sortSftTreeDscCellItemData	9	The immediate dependents are sorted in a descending fashion based on their Cell.Data property value.
sortSftTreeAscItemDataString	10	The immediate dependents are sorted in an ascending fashion based on their Item.DataString property value (ColIndex is ignored, but must be valid).
sortSftTreeDscItemDataString	11	The immediate dependents are sorted in a descending fashion based on their Item.DataString property value (ColIndex is ignored, but must be valid).
sortSftTreeEventWithIndex	12	The immediate dependents are sorted in a fashion determined by the SortCompare event. The SortCompare event is generated to compare two items. It is only generated for a SortType of sortSftTreeEvent, sortSftTreeEventCell or sortSftTreeEventWithIndex. For other SortType values, the event is not generated.

Result

Returns True if sorting was successful, False if the sorting process ran out of memory.

Comments

The SortDependents method sorts an item's dependents.

Based on the specified column number ColIndex, the immediate dependents of the specified item ItemIndex are sorted according to the SortType specified.

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 SortDependents method separately for each parent item to be sorted.