CharSearchMode


	CharSearchMode	Softel vdm, Inc.

Defines the method used to search for matching items in response to characters typed by the user.

int WINAPI SftTree_GetCharSearchMode(HWND hwndCtl);
void WINAPI SftTree_SetCharSearchMode(HWND hwndCtl, int mode, int realCol);
int WINAPI SftTreeSplit_GetCharSearchMode(HWND hwndCtl);
void WINAPI SftTreeSplit_SetCharSearchMode(HWND hwndCtl, int mode, int realCol);

C++

int CSftTree::GetCharSearchMode() const;
void CSftTree::SetCharSearchMode(int mode = SFTTREE_CHARSEARCH_ONECHAR, int realCol = -1);
int CSftTreeSplit::GetCharSearchMode() const;
void CSftTreeSplit::SetCharSearchMode(int mode = SFTTREE_CHARSEARCH_ONECHAR, int realCol = -1);

Parameters

hwndCtl

The window handle of the tree control.

mode

Defines the method used to search for matching items in response to characters typed by the user. mode can be one of the following values:

SFTTREE_CHARSEARCH_ONECHAR

Starting at the current item, the next item starting with the one single character typed is located and made current.

SFTTREE_CHARSEARCH_ALLCHARS

The first item in the tree control that matches the character(s) typed within a short time period is located and made current. As the user types additional characters, the search continues. If the user pauses for more than the time interval defined using SFTTREE_CONTROL, nCharSearchMaxInterval (default one second), the search ends. The next character typed starts a new search.

SFTTREE_CHARSEARCH_NONE

Characters typed are ignored.

SFTTREE_CHARSEARCH_ALLCHARS2

Same as SFTTREE_CHARSEARCH_ALLCHARS, but dependent items of a collapsed parent item are not searched.

SFTTREE_CHARSEARCH_ONECHAR2

Same as SFTTREE_CHARSEARCH_ONECHAR, but dependent items of a collapsed parent item are not searched.

SFTTREE_CHARSEARCH_ONECHARWRAP

Starting at the current item, the next item starting with the one single character typed is located and made current. If the end of the list of items is reached, the search wraps around and starts at the beginning of the list.

SFTTREE_CHARSEARCH_ONECHARWRAP2

Same as SFTTREE_CHARSEARCH_ONECHARWRAP, but dependent items of a collapsed parent item are not searched.

SFTTREE_CHARSEARCH_ALLCHARSWRAP

The next item in the tree control that matches the character(s) typed within a short time period is located and made current. As the user types additional characters, the search continues. If the user pauses for more than the time interval defined using SFTTREE_CONTROL, nCharSearchMaxInterval (default one second), the search ends. The next character typed starts a new search.

SFTTREE_CHARSEARCH_ALLCHARSWRAP2

Same as SFTTREE_CHARSEARCH_ALLCHARSWRAP, but dependent items of a collapsed parent item are not searched.

realCol

The zero-based column number to be searched. If -1 is specified, the first displayed column is searched.

Returns

GetCharSearchMode returns a value indicating the current search method used.

Comments

The GetCharSearchMode and SetCharSearchMode functions define the method used to search for matching items in response to characters typed by the user.

See Also C/C++ API | Categories | Notifications

SFTTREE_CHARSEARCH_ONECHAR	Starting at the current item, the next item starting with the one single character typed is located and made current.
SFTTREE_CHARSEARCH_ALLCHARS	The first item in the tree control that matches the character(s) typed within a short time period is located and made current. As the user types additional characters, the search continues. If the user pauses for more than the time interval defined using SFTTREE_CONTROL, nCharSearchMaxInterval (default one second), the search ends. The next character typed starts a new search.
SFTTREE_CHARSEARCH_NONE	Characters typed are ignored.
SFTTREE_CHARSEARCH_ALLCHARS2	Same as SFTTREE_CHARSEARCH_ALLCHARS, but dependent items of a collapsed parent item are not searched.
SFTTREE_CHARSEARCH_ONECHAR2	Same as SFTTREE_CHARSEARCH_ONECHAR, but dependent items of a collapsed parent item are not searched.
SFTTREE_CHARSEARCH_ONECHARWRAP	Starting at the current item, the next item starting with the one single character typed is located and made current. If the end of the list of items is reached, the search wraps around and starts at the beginning of the list.
SFTTREE_CHARSEARCH_ONECHARWRAP2	Same as SFTTREE_CHARSEARCH_ONECHARWRAP, but dependent items of a collapsed parent item are not searched.
SFTTREE_CHARSEARCH_ALLCHARSWRAP	The next item in the tree control that matches the character(s) typed within a short time period is located and made current. As the user types additional characters, the search continues. If the user pauses for more than the time interval defined using SFTTREE_CONTROL, nCharSearchMaxInterval (default one second), the search ends. The next character typed starts a new search.
SFTTREE_CHARSEARCH_ALLCHARSWRAP2	Same as SFTTREE_CHARSEARCH_ALLCHARSWRAP, but dependent items of a collapsed parent item are not searched.