Defines the column number of the currently pressed header button.

C

int WINAPI SftTree_GetHeaderButton(HWND hwndCtl);
BOOL WINAPI SftTree_SetHeaderButton(HWND hwndCtl, int realCol);
int WINAPI SftTreeSplit_GetHeaderButton(HWND hwndCtl);
BOOL WINAPI SftTreeSplit_SetHeaderButton(HWND hwndCtl, int realCol);

C++

int CSftTree::GetHeaderButton() const;
void CSftTree::SetHeaderButton(int realCol);
int CSftTreeSplit::GetHeaderButton() const;
void CSftTreeSplit::SetHeaderButton(int realCol);

Parameters

hwndCtl

The window handle of the tree control.

realCol

The zero-based column number specifying which header button to set to the "down" state.  This value can be -1, which causes all header buttons to go to their "up" state.

Returns

GetHeaderButton returns the zero-based column number of the header button currently pressed down or -1 if no button is pressed down.

Comments

The GetHeaderButton and SetHeaderButton functions define the column number of the currently pressed header button.

Only one header button can be down at any one time.  A header button can be pressed by the user or under program control using SetHeaderButton.  Once pressed, the new button will remain in its down state until another button is pressed or until SetHeaderButton sets a new (or no) button.

If the column title style is defined using SFTTREE_HEADER_UP, the header button automatically returns to its "up" position when clicked (see SFTTREE_COLUMN_EX). 

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