Hide

SftTree/OCX 7.5 - ActiveX Tree Control

Display
Print

SortDependents Method, SftTree Object

Sorts an item's dependents.

Deprecated - Provided for compatibility with earlier versions only - Use Items.SortDependents instead

Syntax

VB.NETResult = object.SortDependents(ByVal ItemIndex As Integer, ByVal ColIndex As Short, ByVal SortType As SftTreeSortTypeConstants) As Boolean
VBResult = object.SortDependents(ByVal ItemIndex As Long, ByVal ColIndex As Integer, ByVal SortType As SftTreeSortTypeConstants) As Boolean
C#.NETbool Result = object.SortDependents(int ItemIndex, short ColIndex, SftTreeSortTypeConstants SortType);
VC++VARIANT_BOOL Result = object->SortDependents(long ItemIndex, short ColIndex, enum SftTreeSortTypeConstants SortType);
CHRESULT object->raw_SortDependents(long ItemIndex, short ColIndex, enum SftTreeSortTypeConstants SortType, VARIANT_BOOL* Result);

object

A SftTree 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.

SortTypeValueDescription
sortSftTreeAscending0The immediate dependents are sorted in an ascending fashion (not case sensitive) based on their cell text in column ColIndex.
sortSftTreeDescending1The immediate dependents are sorted in a descending fashion (not case sensitive) based on their cell text in column ColIndex.
sortSftTreeAscItemData2The immediate dependents are sorted in an ascending fashion based on their Item.Data property value (ColIndex is ignored, but must be valid).
sortSftTreeDscItemData3The immediate dependents are sorted in a descending fashion based on their Item.Data property value (ColIndex is ignored, but must be valid).
sortSftTreeAscItemDataFloat4The immediate dependents are sorted in an ascending fashion based on their Item.DataFloat property value (ColIndex is ignored, but must be valid).
sortSftTreeDscItemDataFloat5The immediate dependents are sorted in a descending fashion based on their Item.DataFloat property value (ColIndex is ignored, but must be valid).
sortSftTreeEvent6The 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.
sortSftTreeEventCell7The 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.
sortSftTreeAscCellItemData8The immediate dependents are sorted in an ascending fashion based on their Cell.Data property value.
sortSftTreeDscCellItemData9The immediate dependents are sorted in a descending fashion based on their Cell.Data property value.
sortSftTreeAscItemDataString10The immediate dependents are sorted in an ascending fashion based on their Item.DataString property value (ColIndex is ignored, but must be valid).
sortSftTreeDscItemDataString11The immediate dependents are sorted in a descending fashion based on their Item.DataString property value (ColIndex is ignored, but must be valid).
sortSftTreeEventWithIndex12The 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

Deprecated - Provided for compatibility with earlier versions only - Use Items.SortDependents instead

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.

See Also SftTree Object | Object Hierarchy


Last Updated 08/13/2020 - (email)
© 2022 Softel vdm, Inc.