ISplitButton Interface Reference

The split button is a composite control which allows user to trigger either the default action bound to the primary button, or an action out of the drop-down list of mutually exclusive actions bound to the secondary button. More...

Inheritance diagram for ISplitButton:

Public Member Functions
HRESULT	AddAction ([in] IAction *pAction)
	Adds an action to the split button.
HRESULT	AddSeparator ()
	Adds a separaror to the split button.

Properties
GUID	Id [get]
	The identifier of the split button.
BSTR	IdS [get]
	The Id of the split button as a string.

Detailed Description

The split button is a composite control which allows user to trigger either the default action bound to the primary button, or an action out of the drop-down list of mutually exclusive actions bound to the secondary button.

Primary button consists of an icon and a descriptive caption, both provided by the default action. The default action always appears first in the drop-down list.

A split button always occupies its own line in a tool panel, with both the icon and text shown on it.

A split button exists in Renga until the application is closed. The same split button can be added to multiple UI panel extensions simultaneously.

See also

IUI::CreateSplitButton(), IUIPanelExtension, IDropDownButton, IAction

Member Function Documentation

AddAction()

HRESULT AddAction

(

[in] IAction *

pAction

)

Adds an action to the split button.

Parameters

[in]

pAction

The action to add to the split button.