RibbonShowContext Method (WINDOW)

PLBCMP GUI Only, 9.6

The RibbonShowContext method invokes a Context Popup for the ribbon element identified with the ID parameter at the given location. This method only affects the currently active ribbon of a WINDOW object. The method uses the following format:

Where:

label

Optional. A Program Execution Label.

object

Required. A WINDOW object that is accessed.

return

Optional. A Numeric Variable that is set to zero.

id

Required. A Numeric Variable or decimal number that identifies the ribbon Context Popup element.

left

Required. A Numeric Variable or decimal number that identifies the left pixel coordinate of the Context Popup.

top

Required. A Numeric Variable or decimal number that identifies the top pixel coordinate of the Context Popup.

Flags Affected: OVER, ZERO

Note the following:

1. The ZERO Condition Flag is set.

2. The OVER Condition Flag is cleared.

3. The Context Popup is composed of two components: the ContextMenu and MiniToolbar elements of a ribbon. The Context Popup is typically displayed by right-clicking the mouse (or through the keyboard shortcut SHIFT+F10) on an object of interest. The UI actions required to display the Context Popup are defined by the PLB application. Therefore, to active a Context Popup requires a UI action that executes this method.

4. The ContextMenu is a list of menu items that are contextual and based on the specific control that is clicked or the control with focus (when using the keyboard).

5. The MiniToolbar is a floating toolbar that incorporates various Commands, galleries, and complex controls such as the Font Control and the ComboBox.

6. This method is not available when using the PL/B Web Server.

See Also: Method Syntax, WINDOW Methods