RibbonSetProp Method (WINDOW)

PLBCMP GUI Only, 9.6

The RibbonSetProp method sets a property of a ribbon or element in a ribbon. This method only provides 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 indicates the success or failure of the method.

id

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 property to be set.

value

Optional. A Numeric Variable, decimal number, Character String Variable, or a Character String Literal used when setting the property.

Flags Affected: OVER, ZERO

Note the following:

1. If the value returned is zero, the ZERO Condition Flag is set.

2. If {return} is too small to contain a numeric value, the OVER Condition Flag is set.

3. See the RibbonGetProp method for a complete list of UI_PKEY property values that can be use for this method.

4. An {id} value of zero identifies the ribbon resource. A non-zero {id} value identifies an element on the ribbon resource. This

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

See Also: Method Syntax, WINDOW Methods