DeleteSmallButton

Description

Removes a small button from the panel or group of the RibbonBar control.

Applies to

RibbonBar controls

Syntax

controlname.DeleteSmallButton ( Long ItemHandle )

Argument

Description

controlname

The name of the RibbonBar control.

ItemHandle

The handle of the small 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 small button whose index number is 1 in the "MyPanel" panel and then deletes it 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_AddButtonClicked")
li_Return = rbb_1.GetChildItemByIndex (ll_Handle_Panel, 1, lr_SmallButton)
If li_Return = 1 Then
 li_Return = rbb_1.DeleteSmallButton (lr_SmallButton.ItemHandle)
End If

See also

InsertSmallButton

InsertSmallButtonFirst

InsertSmallButtonLast

SetSmallButton

GetSmallButton

GetChildItemByIndex