GetLargeButton

Description

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

Applies to

RibbonBar control

Syntax

controlname.GetLargeButton ( Long ItemHandle, ref RibbonLargeButtonItem Item )

Argument

Description

controlname

The name of the RibbonBar control.

ItemHandle

The handle of the large button you want to obtain.

Item

A RibbonLargeButtonItem variable in which you want to store the large 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 gets a copy of the "Add" large button according to its handle and stores it in lr_LargeButton variable.

Integer li_Return
Long ll_Handle_Category, ll_Handle_Panel, ll_Handle_LargeButton
RibbonLargeButtonItem lr_LargeButton

ll_Handle_Category = rbb_1.InsertCategoryFirst ("MyCategory")
ll_Handle_Panel = rbb_1.InsertPanelFirst (ll_Handle_Category, "MyPanel", "AddSmall!")
ll_Handle_LargeButton = rbb_1.InsertLargeButtonFirst (ll_Handle_Panel, "Add", "AddBig!", "Ue_LargeButtonClicked")
li_Return = rbb_1.GetLargeButton (ll_Handle_LargeButton, lr_LargeButton)

See also

InsertLargeButton

InsertLargeButtonFirst

InsertLargeButtonLast

DeleteLargeButton

SetLargeButton

GetChildItemByIndex