SftTree/DLL 7.5 - Tree Control

FooterButton

Defines the column number of the currently pressed column footer button.

C

int WINAPI SftTree_GetFooterButton(HWND hwndCtl);
BOOL WINAPI SftTree_SetFooterButton(HWND hwndCtl, int realCol);
int WINAPI SftTreeSplit_GetFooterButton(HWND hwndCtl);
BOOL WINAPI SftTreeSplit_SetFooterButton(HWND hwndCtl, int realCol);

C++

int CSftTree::GetFooterButton() const;
void CSftTree::SetFooterButton(int realCol);
int CSftTreeSplit::GetFooterButton() const;
void CSftTreeSplit::SetFooterButton(int realCol);

Parameters

hwndCtl

The window handle of the tree control.

realCol

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

Returns

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

Comments

The GetFooterButton and SetFooterButton functions define the column number of the currently pressed column footer button.

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

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

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