DeleteTabButton

Description

Removes a tab button from the RibbonBar control.

Applies to

RibbonBar control

Syntax

controlname.DeleteTabButton ( Long ItemHandle )

Argument

Description

controlname

The name of the RibbonBar control.

ItemHandle

The handle of the tab button you want to delete.


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 delete an item according to the handle by using the DeleteItem function.

Examples

This example gets the tab button whose index number is 1 and then deletes it 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.GetTabButtonByIndex (1, lr_TabButton)
If li_Return = 1 Then
	li_Return = rbb_1.DeleteTabButton (ll_Handle)
End If

See also

InsertTabButton

InsertTabButtonFirst

InsertTabButtonLast

SetTabButton

GetTabButton

GetTabButtonByIndex

GetTabButtonCount