RibbonGroupItem control

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

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

RibbonGroupItem 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 group.

NewLine

Boolean

Identifies whether the group is at the new line. (Default is FALSE.)

The groups (one or more) in the same panel will be displayed in one line, unless this property is set to true, or there are controls of different type before or after the group.

RightToLeft

Boolean

Unsupported.

Tag

String

Specifies the tag value assigned to the control.

Visible

Boolean

Specifies whether the control is visible. Values are:

TRUE -- Control is visible.

FALSE -- Control is not visible.


Functions

RibbonGroupItem 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

Integer

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.