RibbonMenu control

A RibbonMenu control defines a ribbon menu which can be associated with the tab button, large button, or small button in the RibbonBar control. For more about the ribbon menu, see the section called “Introduction to RibbonBar items” in Users Guide.

The RibbonMenu control could be the child object of the RibbonTabButtonItem, RibbonLargeButtonItem, and RibbonSmallButtonItem controls, and is the parent object of the RibbonMenuItem control: RibbonBar > Category > Panel > [Group >] LargeButton/SmallButton > RibbonMenu > MenuItem, or RibbonBar > TabButton > RibbonMenu > MenuItem. For the hierarchical structure of the ribbon controls and how to get and set them, refer to the section called “Accessing the RibbonBar items in the hierarchy” in Users Guide.

Events

This control has no events or user events.

Properties

RibbonMenu property

Datatype

Description

ClassDefinition

PowerObject

An object of type PowerObject containing information about the class definition of the object or control.


Functions

RibbonMenu function

Datatype returned

Description

AddSeparatorItem

Long

Adds a menu separator to the ribbon menu.

ClassName

String

Returns the name assigned to the control.

DeleteItem

Long

Deletes an item from the ribbon menu.

GetContextService

Integer

Creates a reference to a context-specific instance of the specified service.

GetItem

Integer

Gets an item of the ribbon menu.

GetItemCount

Long

Determines the total number of items in the ribbon menu.

GetParent

PowerObject

Returns a reference to the name of the parent object.

InsertItem

Long

Inserts an item at the specified position in the ribbon menu.

InsertItemFirst

Long

Inserts an item as the first item in the ribbon menu.

InsertItemLast

Long

Inserts an item as the last item in the ribbon menu.

PostEvent

Integer

Adds the specified event to the end of the event queue for the specified object

SetItem

Integer

Sets a menu item for the ribbon menu.

TriggerEvent

Integer

Triggers a specified event in the control and executes the script for the event.

TypeOf

Object

Returns the type of the control.