RibbonCategoryItem control

A RibbonCategoryItem control defines a category in the RibbonBar control. For more about the category, see the section called “Introduction to RibbonBar items” in Users Guide.

The RibbonCategoryItem control is the child object of the RibbonBar control and is the parent object of the RibbonPanelItem control (RibbonBar > Category > Panel > ...). 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

RibbonCategoryItem property

Datatype

Description

ClassDefinition

PowerObject

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

Enabled

Boolean

Specifies whether the control is enabled (can be clicked).

ItemHandle

Long

Identifies the handle associated with the item.

MenuItemName

String

The unique identifier of the ribbon item (including RibbonCategoryItem, RibbonSmallButtonItem, RibbonLargeButtonItem, and RibbonMenuItem) that is converted from the menu item.

Note

This property is valid only when the ribbon item is converted from the menu (when DisplayMenuAsRibbonBar is enabled). The standalone ribbon item control does not support this property.

RightToLeft

Boolean

Unsupported.

Tag

String

Specifies the tag value assigned to the control.

Text

String

Specifies the text that displays in the control.

Visible

Boolean

Specifies whether the control is visible. Values are:

TRUE -- Control is visible.

FALSE -- Control is not visible.


Functions

RibbonCategoryItem function

Datatype returned

Description

ClassName

String

Returns the name assigned to the control.

GetContextService

Integer

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

GetParent

PowerObject

Returns a reference to the name of the parent object.

PostEvent

Boolean

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

TriggerEvent

Integer

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

TypeOf

Object

Returns the type of the control.