BKM SETNOTEBOOKBUTTONS

This message creates a set of buttons in the common area of the notebook page.

Syntax

param1
ULONG ulCount;           /* Number of buttons to set. */

param2
PNOTEBOOKBUTTON pButtonArray; /* Notebook button array. */

Parameters

ulCount (ULONG) - Input

Number of buttons to set.

pButtonArray (PNOTEBOOKBUTTON) - Input

Array of NOTEBOOKBUTTON structures that specify the style and content of the buttons in the common button area. The ulCount parameter indicates the number of entries in the array.

Returns

rc (BOOL) - returns

Success indicator:

TRUE: Buttons were successfully set.

FALSE: Unable to set buttons.

Remarks

This message works only for notebooks with the styles BKS_TABBEDDIALOG and BKS_BUTTONAREA.

All notebook buttons are created as children of the notebook window and must have an ID of less than BKA_MAXBUTTONID. An application can send messages to the notebook buttons but is also responsible for making sure that they are in the expected state when a new page is turned to.

The notebook buttons created using this message will be displayed for all pages in the notebook, except for pages containing other push buttons with the BS_NOTEBOOKBUTTON style. WM_COMMAND, WM_SYSCOMMAND, and WM_HELP messages from these buttons are passed on to the top page window procedure for processing.

The notebook is responsible for destroying buttons created by this message.

Default Processing

The default window procedure does not expect to receive this message and therefore takes no action on it other than to return FALSE.