NavigateHome Method, SftTree Class

Navigates to the very first item or cell in the control.

Class: SftTree
Namespace: Softelvdm.SftTreeNET
Assembly: Softelvdm.SftTreeNET

Syntax

public object NavigateHome(
    bool fSelect,
    bool fSelectCumulative );

Public Function NavigateHome(
    ByVal fSelect As Boolean,
    ByVal fSelectCumulative As Boolean
  ) As Object

Parameters

fSelect

Defines whether the item or cell found is automatically selected, True to select, otherwise False.

fSelectCumulative

Defines whether the selection is cumulative. True if the selection is cumulative, otherwise False. This parameter is ignored if fSelect is False and can only be used when multiple item or multiple cell selection is active (SftTree.SelectionStyle).

Return Value

The item or cell.

Comments

Navigates to the very first item or cell in the control.

This method returns the first item or cell in the control that can be selected. It considers cell merging and the selectable area (SftTree.SelectableArea).

If fSelect and fSelectCumulative are True, the items or cells from the current focus object (SftTree.FocusObject) through the item or cell found are added to the selection.

If the control contains no items, the method returns null/Nothing.

See Also SftTree Class | Classes | SftTree/NET 3.0