DeleteLargeButton

Description

Removes a large button from the panel of the RibbonBar control.

Applies to

RibbonBar control

Syntax

controlname.DeleteLargeButton ( Long ItemHandle )

Argument

Description

controlname

The name of the RibbonBar control.

ItemHandle

The handle of the large 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

The example gets the large 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_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_AddButtonClicked")
li_Return = rbb_1.GetChildItemByIndex (ll_Handle_Panel, 1, lr_LargeButton)
If li_Return = 1 Then
 li_Return = rbb_1.DeleteLargeButton (lr_LargeButton.ItemHandle)
End If

See also

InsertLargeButton

InsertLargeButtonFirst

InsertLargeButtonLast

SetLargeButton

GetLargeButton

GetChildItemByIndex