FindCell Method, SftTreeItems Object
Searches items for a string.
Syntax
| VB.NET | object.FindCell(ByVal ItemIndex As Integer, ByVal EndIndex As Integer, ByVal ColIndex As Short, ByVal Level As Short, ByVal SearchString As String, ByVal Wrap As Boolean, ByVal IgnoreCase As Boolean, ByVal ExactMatch As Boolean, ByVal SearchEnabledOnly As Boolean, ByVal SearchVisibleOnly As Boolean, ByRef FoundIndex As Integer, ByRef FoundColumn As Short) |
| VB | object.FindCell(ByVal ItemIndex As Long, ByVal EndIndex As Long, ByVal ColIndex As Integer, ByVal Level As Integer, ByVal SearchString As String, ByVal Wrap As Boolean, ByVal IgnoreCase As Boolean, ByVal ExactMatch As Boolean, ByVal SearchEnabledOnly As Boolean, ByVal SearchVisibleOnly As Boolean, FoundIndex As Long, FoundColumn As Integer) |
| C#.NET | void object.FindCell(int ItemIndex, int EndIndex, short ColIndex, short Level, string SearchString, bool Wrap, bool IgnoreCase, bool ExactMatch, bool SearchEnabledOnly, bool SearchVisibleOnly, out int FoundIndex, out short FoundColumn); |
| VC++ | HRESULT object->FindCell(long ItemIndex, long EndIndex, short ColIndex, short Level, _bstr_t SearchString, VARIANT_BOOL Wrap, VARIANT_BOOL IgnoreCase, VARIANT_BOOL ExactMatch, VARIANT_BOOL SearchEnabledOnly, VARIANT_BOOL SearchVisibleOnly, long* FoundIndex, short* FoundColumn); |
| C | HRESULT object->raw_FindCell(long ItemIndex, long EndIndex, short ColIndex, short Level, BSTR SearchString, VARIANT_BOOL Wrap, VARIANT_BOOL IgnoreCase, VARIANT_BOOL ExactMatch, VARIANT_BOOL SearchEnabledOnly, VARIANT_BOOL SearchVisibleOnly, long* FoundIndex, short* FoundColumn); |
object
A SftTreeItems object.
ItemIndex
The zero-based index of the item after which the search begins (non-inclusive). If -1 is specified, search starts at the first item (index 0).
EndIndex
The zero-based item index where the search ends (inclusive). If -1 is specified, items up to the last item in the list are searched.
ColIndex
The zero-based column number. The Cell.Text property for cells in this column are searched. If -1 is specified, all columns are searched.
Level
The item level to search. Only items on this level (see Item.Level property) are searched. If -1 is specified, all levels are searched.
SearchString
The text to be searched.
Wrap
If set to True, the search starts at ItemIndex and wraps around (if necessary) and ends at EndIndex, otherwise the search does not wrap around and ends at EndIndex.
IgnoreCase
If set to True, the string comparison between the Cell.Text property and SearchString is not case sensitive. If False, comparison is case sensitive.
ExactMatch
If set to True, the Cell.Text property must be exactly the same as SearchString, otherwise the Cell.Text property must start with the string SearchString.
SearchEnabledOnly
If set to True, only enabled items (see Item.Enabled) are searched, otherwise items are searched regardless of their enabled/disabled status.
SearchVisibleOnly
If set to True, only visible child items (expanded branches, see Item.Shown) are searched, otherwise items are searched regardless of their .
FoundIndex
Returns the zero-based index of the cell whose string Cell.Text property and SearchString match. -1 is returned if no cell was found.
FoundColumn
Returns the zero-based column number of the cell whose string Cell.Text property and SearchString match. -1 is returned if no cell was found.
Comments
The FindCell method searches items for a string.
See Also SftTreeItems Object | Object Hierarchy
On
Off