SetButtonBarDefinition

All Editions  image\bltlrgss.gif Related Transactions  image\bltlrgss.gif Example

The SetButtonBarDefinition transaction builds a new button bar from the button bar definitions provided. To see the changes, you have to use the RefreshMenus transaction.

Type XTYP_EXECUTE

Syntax [SetButtonBarDefinition(buttonBar, numCmds, cmdIDs)]

Parameter

Data type

Values

Meaning

buttonBar

WORD

1

2

View Ribbon

Tool Bar

count

WORD

1 | 2 | 3 | …

number of items (buttons and separators) in the list

cmdIDs

WORD

cmdID1, cmdID2, …

list of the command buttons and separators to place in the button bar. Each value is separated by a comma. See Remarks.

Remarks

You can use internal command IDs (see Command IDs), or external command IDs (with values of 4096 or more). The commands to include must be registered and must have a button set for them.

Separators, which place a space between the buttons, are given values of 1.

Release information

Added in Release 4.5.

See also

Defining button bars

Adding and removing buttons