GetTabButton

PowerScript function

Description

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

Applies to

RibbonBar controls

Syntax

controlname.GetTabButton ( Long ItemHandle, ref RibbonTabButtonItem Item )

1	controlname.GetTabButton ( Long ItemHandle, ref RibbonTabButtonItem Item )

Argument	Description
controlname	The name of the RibbonBar control.
ItemHandle	The handle of the tab button you want to obtain.
Item	A RibbonTabButtonItem variable in which you want to store the tab 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 the tab button according to its index using the
GetTabButtonByIndex
function.

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

Examples

This example inserts a “MyTabButton” tab button and then gets a copy
of the tab button according to its handle.

Integer li_Return
Long ll_Handle
RibbonTabButtonItem lr_TabButton

ll_Handle = rbb_1.InsertTabButtonFirst ("MyTabButton", "ArrowUpSmall!", "Ue_TabButtonClicked")
li_Return = rbb_1.GetTabButton (ll_Handle, lr_TabButton)