GetSmallButton

Description

Gets the small button according to the handle in the RibbonBar control.

Applies to

RibbonBar control

Syntax

controlname.GetSmallButton ( Long ItemHandle, ref RibbonSmallButtonItem Item )

Argument

Description

controlname

The name of the RibbonBar control.

ItemHandle

The handle of the small button you want to obtain.

Item

A RibbonSmallButtonItem variable in which you want to store the small button identified by the item handle.


Return value

Integer.

Returns 1 if it succeeds and -1 if an error occurs. If any argument's value is null, returns null.

Usage

You can also get an item according to the handle by using the GetItem function.

Examples

This example inserts an "Add" small button and then gets a copy of the small button according to its handle.

Integer li_Return
Long ll_Handle_Category, ll_Handle_Panel, ll_Handle_SmallButton
RibbonSmallButtonItem lr_SmallButton

ll_Handle_Category = rbb_1.InsertCategoryFirst ("MyCategory")
ll_Handle_Panel = rbb_1.InsertPanelFirst(ll_Handle_Category, "MyPanel", "AddSmall!")
ll_Handle_SmallButton = rbb_1.InsertSmallButtonFirst (ll_Handle_Panel, "Add", "AddSmall!", "Ue_SmallButtonClicked")
li_Return = rbb_1.GetSmallButton (ll_Handle_SmallButton, lr_SmallButton)

See also

InsertSmallButton

InsertSmallButtonFirst

InsertSmallButtonLast

DeleteSmallButton

SetSmallButton

GetChildItemByIndex