Hide

SftTree/NET 2.0 - Tree Control for Windows Forms

Display
Print

FindItemTagObject Method, SftTree Class

Searches the ItemClass.TagObjects property of items for an object.

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

Syntax

public ItemClass FindItemTagObject(
    object Data,
    bool Wrap,
    ItemClass StartItem,
    bool DepthScan,
    bool VisibleOnly );
Public Function FindItemTagObject(
    ByVal Data As Object,
    ByVal Wrap As Boolean,
    ByVal StartItem As ItemClass,
    ByVal DepthScan As Boolean,
    ByVal VisibleOnly As Boolean
  ) As ItemClass

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).

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 item where the first match is found or null/Nothing if no match was found.

Comments

Searches the ItemClass.TagObjects property of items for an object.

The FindItemTagObject method searches all items, starting at the item defined by StartItem for the object (Data) in each item's ItemClass.TagObjects property.

The SftTree.FindItemTagString, SftTree.FindCellTagObject, 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



Spring Break!

Our offices will be closed this week (March 18 through March 22).

We'll be back March 24 to address any pending sales and support issues.