RibbonSetModes Method (WINDOW)

PLBCMP GUI Only, 9.6

The RibbonSetModes method sets the application modes for ribbon elements. A mode indicates the functionality required and, therefore, which elements should be displayed or hidden at run time depending on the state or context of an application. This method only sets properties for 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.

mode

Required. A Numeric Variable or decimal number that identifies the ribbon or ribbon element from which the property is retrieved.

property

Required. A Numeric Variable or decimal number that identifies the new ribbon mode.

Flags Affected: OVER, ZERO

Note the following:

1. The ZERO Condition Flag is set.

2. The OVER Condition Flag is cleared.

3. Modes are defined and declared in the Ribbon markup (XAML source code) that defines the ribbon elements. Modes are assigned to individual ribbon elements to define groups of ribbon elements. When a specific mode is enabled, this action causes ribbon elements associated with a mode to be displayed while ribbon elements not associated with the mode are hidden.

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

See Also: Method Syntax, WINDOW Methods