Hide

SftTree/OCX 7.5 - ActiveX Tree Control

Display
Print

FindString Method, SftTree Object

Searches items for a string.

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

Syntax

VB.NETFoundIndex = object.FindString(ByVal ItemIndex As Integer, ByVal ColIndex As Short, ByVal SearchString As String) As Integer
VBFoundIndex = object.FindString(ByVal ItemIndex As Long, ByVal ColIndex As Integer, ByVal SearchString As String) As Long
C#.NETint FoundIndex = object.FindString(int ItemIndex, short ColIndex, string SearchString);
VC++long FoundIndex = object->FindString(long ItemIndex, short ColIndex, _bstr_t SearchString);
CHRESULT object->raw_FindString(long ItemIndex, short ColIndex, BSTR SearchString, long* FoundIndex);

object

A SftTree object.

ItemIndex

The zero-based index of the item where the search begins (including ItemIndex).

ColIndex

The zero-based column number to be searched.

SearchString

The text to be searched.

FoundIndex

Returns the zero-based index of the item, where the specified SearchString is found. -1 is returned if no item is found matching the specified SearchString.

Comments

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

The FindString method searches items for a string.

The string described by SearchString is compared to the Cell.Text property of all items and columns involved in the search. The search starts at the item described by ItemIndex and is restricted to the column specified by ColIndex. If an item with a matching Cell.Text property is found, its zero-based index is returned, otherwise -1 is returned.

Only one column can be searched at a time.

The comparison of SearchString and the Cell.Text property is not case sensitive. If the Cell.Text property starts with the string in SearchString, it is considered a match. To find an exact match for SearchString use the Items.FindCellTextExact method.

SearchStringCell.Text PropertyMatchComment
ABCabcYesSame string, case is ignored
abcabc123YesProperty starts with SearchString
abcThisabcNoProperty doesn't start with SearchString
abcabNoProperty doesn't contain the complete SearchString

See Also SftTree Object | Object Hierarchy


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