Defines the index number of the item shown at the top of the tree control.

C

int WINAPI SftTree_GetTopIndex(HWND hwndCtl);
int WINAPI SftTree_SetTopIndex(HWND hwndCtl, int index);
int WINAPI SftTreeSplit_GetTopIndex(HWND hwndCtl);
int WINAPI SftTreeSplit_SetTopIndex(HWND hwndCtl, int index);

C++

int CSftTree::GetTopIndex() const;
int CSftTree::SetTopIndex(int index);
int CSftTreeSplit::GetTopIndex() const;
int CSftTreeSplit::SetTopIndex(int index);

Parameters

hwndCtl

The window handle of the tree control.

index

The zero-based index of the item which will become the first item displayed.

Returns

GetTopIndex returns the zero-based index of the item that is displayed as the first item in the tree control's client area.

SetTopIndex returns 0 if the function was successful, otherwise -1 is returned.

Comments

The GetTopIndex and SetTopIndex functions define the index number of the item shown at the top of the tree control.

An item must be visible before it can be displayed as the first item.  SetItemShown can be used to make an item visible. 

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