Hide

SftTree/NET 2.0 - Tree Control for Windows Forms

Display
Print

FindCellTagObject Method, SftTree Class

Searches the CellBaseClass.TagObjects property of cells for an object.

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

Syntax

public CellClass FindCellTagObject(
    object Data,
    bool Wrap,
    ItemClass StartItem,
    int ColumnIndex,
    bool DepthScan,
    bool VisibleOnly );
Public Function FindCellTagObject(
    ByVal Data As Object,
    ByVal Wrap As Boolean,
    ByVal StartItem As ItemClass,
    ByVal ColumnIndex As Integer,
    ByVal DepthScan As Boolean,
    ByVal VisibleOnly As Boolean
  ) As CellClass

Parameters

Data

Defines the object to find.

Wrap

Defines whether the search wraps around at the end of the items and resumes at the first item (True), otherwise False.

StartItem

Defines the item where the search starts (including).

ColumnIndex

The zero-based column index of the column to be searched. Only one column can be searched.

DepthScan

Defines whether all items (including dependent items, starting with the item StartItem) are searched (True), otherwise False and only sibling items of the starting item (StartItem) are searched.

VisibleOnly

Defines whether only visible items are searched (True), otherwise False and all items (even items whose parents are collapsed) are searched.

Return Value

The cell where the first match is found or null/Nothing if no match was found.

Comments

Searches the CellBaseClass.TagObjects property of cells for an object.

The FindCellTagObject method searches all cells in column ColumnIndex, starting at the item defined by StartItem for the object (Data) in each cell's CellBaseClass.TagObjects property.

The SftTree.FindItemTagObject, SftTree.FindItemTagString, SftTree.FindCellTagString methods perform a similar function to search items' and cells' TagObjects and TagString properties. The SftTree.FindText property searches for a matching string in the CellBaseClass.Text property.

See Also SftTree Class | Classes | SftTree/NET 2.0