RibbonLargeButtonItem control

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

The RibbonLargeButtonItem is the child object of the RibbonPanelItem
control (RibbonBar > Category > Panel > LargeButton). 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. But you can create user events and
bind them with this control. You can create the Clicked user event and
the Selected user event. For how to create the Clicked user event, see
Clicked in PowerScript Reference; for how to create the
Selected user event, see Selected in PowerScript Reference.

Properties

RibbonLargeButtonItem property	Datatype	Description
ClassDefinition	PowerObject	An object of type PowerObject containing information about the class definition of the object or control.
Checked	Boolean	Specifies whether the control is checked.
Clicked	String	Specifies the name of the clicked user event to be bound with the control.
DefaultCommand	Boolean	Specifies whether the default command for a button is enabled.
Enabled	Boolean	Specifies whether the control is enabled (can be clicked).
ItemHandle	Long	Identifies the handle associated with the button.
PictureName	String	Specifies the file name of the picture.
PowerTipText	String	Specifies the text to be displayed as a PowerTip for the item.
PowerTipDescription	String	Specifies the text to be displayed as a PowerTip description for the item.
RightToLeft	Boolean	Unsupported.
Selected	String	Specifies the name of the selected user event to be bound with the control.
Shortcut	String	Specifies the shortcut key for the button.
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

RibbonLargeButtonItem 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.
GetMenu	Integer	Gets the menu that is associated with the ribbon large button.
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
SetMenu	Integer	Sets a menu to the ribbon large button.
TriggerEvent	Integer	Triggers a specified event in the control and executes the script for the event.
TypeOf	Object	Returns the type of the control.

Document get from Powerbuilder help

Thank you for watching.

Powerbuilder Documentation 2019

August 21, 2023

Was this article helpful?

Connection Information

RibbonLargeButtonItem control – PB Docs 2019