A RibbonApplicationButtonItem control defines the application button in the RibbonBar control. Only one application button is allowed in a ribbon bar, therefore, you can get, set, or remove the application button without needing to insert the application button first or identify the application button by its handle. For more about the application button, see the section called “Introduction to RibbonBar items” in Users Guide.
The RibbonApplicationButtonItem control is the child object of the RibbonBar control, and is the parent object of the RibbonApplicationMenu 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.
|
RibbonApplicationButtonItem property |
Datatype |
Description |
|---|---|---|
|
ClassDefinition |
PowerObject |
An object of type PowerObject containing information about the class definition of the object or control. |
|
Boolean |
Specifies whether the control is enabled (can be clicked). |
|
|
Long |
Identifies the handle associated with the item. |
|
|
RightToLeft |
Boolean |
Unsupported. |
|
String |
Specifies the tag value assigned to the control. |
|
|
String |
Specifies the text that displays in the control. |
|
|
Boolean |
Specifies whether the control is visible. Values are: TRUE -- Control is visible. FALSE -- Control is not visible. |
|
RibbonApplicationButtonItem function |
Datatype returned |
Description |
|---|---|---|
|
String |
Returns the name assigned to the control. |
|
|
Integer |
Creates a reference to a context-specific instance of the specified service. |
|
|
Integer |
Gets the application menu that is associated with the ribbon application button. |
|
|
PowerObject |
Returns a reference to the name of the parent object. |
|
|
Boolean |
Adds the specified event to the end of the event queue for the specified object |
|
|
Integer |
Sets an application menu to the ribbon application button. |
|
|
Integer |
Triggers a specified event in the control and executes the script for the event. |
|
|
Object |
Returns the type of the control. |
