RibbonApplicationMenu control

A RibbonApplicationMenu control defines an application menu which can be associated with the application button (RibbonApplicationButtonItem) in the RibbonBar control. The application menu is the main menu of your application; it contains a master menu and a recent menu. For more about the application menu, see the section called “Introduction to RibbonBar items” in Users Guide.

The RibbonApplicationMenu control is the child object of the RibbonApplicationButtonItem control, and is the parent object of the RibbonMenuItem control: RibbonBar > ApplicationButton > ApplicationMenu > MenuItem. For the hierarchical structure of the ribbon item controls and how to get and set them, refer to the section called “Accessing the RibbonBar items via PowerScripts” in Users Guide.

Events

This control has no events or user events.

Properties

RibbonApplicationMenu property

Datatype

Description

ClassDefinition

PowerObject

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


Functions

RibbonApplicationMenu function

Datatype returned

Description

AddMasterSeparatorItem

Long

Adds a menu separator to the master menu of the application menu. A menu separator is a horizontal line used to visually distinguish between groups of menu items.

ClassName

String

Returns the name assigned to the control.

ClearRecentItems

Integer

Removes all recent menu items from the application menu.

DeleteMasterItem

Long

Removes a master menu item from the application menu.

DeleteRecentItem

Integer

Removes a recent menu item from the application menu.

GetContextService

Integer

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

GetMasterItem

Integer

Gets the master menu item of the application menu.

GetMasterItemCount

Long

Determines the total number of the master menu items in the application menu.

GetParent

PowerObject

Returns a reference to the name of the parent object.

GetRecentItem

Integer

Gets the recent menu item of the application menu.

GetRecentItemCount

Long

Determines the total number of the recent menu items in the application menu.

GetRecentTitle

Integer

Gets the title of the recent menu list in the application menu. The title is displayed on top of the recent menu list.

InsertMasterItem

Long

Inserts a master menu item at the specified position in the application menu.

InsertMasterItemFirst

Long

Inserts a master menu item as the first item in the application menu.

InsertMasterItemLast

Long

Inserts a master menu item as the last item in the application menu.

InsertRecentItem

Long

Inserts a recent menu item at the specified position in the application menu.

InsertRecentItemFirst

Long

Inserts a recent menu item as the first item in the application menu.

InsertRecentItemLast

Long

Inserts a recent menu item as the last item in the application menu.

PostEvent

Boolean

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

SetMasterItem

Integer

Sets a master menu item for the application menu in the RibbonBar control.

SetRecentItem

Integer

Sets a recent menu item for the application menu in the RibbonBar control.

SetRecentTitle

Integer

Sets the title for the recent menu list in the application menu. The title will be displayed on top of the recent menu list.

TriggerEvent

Integer

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

TypeOf

Object

Returns the type of the control.