param

Displays a widget to display and manipulate a param. Must be placed within a layout container tag. If the param is an array, multiple widgets are displayed (one for each element).

Syntax

<param oid="oid" attributes/>

 

<param oid="oid" attributes>

<constraint/>

<constraint/>

. . .

<config/>

<config/>

. . .

</param>

Attributes

Attribute

Values

Restrictions

Description

showlabel

true

false

 

Display the parameter name as a label beside the parameter elements.

oid

String

Must be a defined OID

The OID of the parameter to show.

*mid

String

Must be the static menu ID of a defined OID Menu.

This is used to determine the user rights for a parameter.  The menu with the a staticid matching the specified mid is treated as the parent menu of the parameter when checking read/write rights and whether it is on a status menu or a configuration menu.

 

If no mid is defined, the parameter is always rendered as though it is on a configuration menu with full read/write rights.

element

List of array indices separated by commas

All array elements referenced must exist in the parameter value.

By default all elements of an array parameter are returned.  This attribute can be used to return a subset of the array. If a list is provided, only the elements at the provided indices are returned (note- you can specify the elements in any order).

 

This value should either be “0” or should not be provided for a non-array parameter.

widget

Positive integer

The value must be a widget hint defined for the parameter’s  type

By default, the widget hint provided by the parameter will be used.  This attribute can be used to override the parameter’s widget hint with another one.

expand

true

false

Only applies to radio and toggle button parameters.

Return each radio or toggle button created by a choice constraint as a separate element.

constrainttype

INT_CHOICE

or

eo://external-object-OID

Can only be applied to parameters that already use choice constraints.

Allows a device developer to override the choice constraint defined in the OGP Parameter Descriptor. 

 

The parameter must either contain the available choices in constriant tags inside of the param tag or an external object URL pointing to an external object that contains an integer choice constraint.

onchange

ogScript String

 

The provided snippet of ogScript is triggered when the parameter value changes. A ParamScriptable object named this is created within the context of the onchange to view and manipulate the param.

relative

true

 

Parameter is interpreted as a relative parameter within a widget. The widget instance’s baseOID will be prefixed to the param OID to create a fully-qualified OID.

false

 

Default values shown in bold.

*mid is optional but its use is strongly recommended for User Rights Management support.