createMultiSet

Changes the values of multiple parameters at once.

Syntax

params.createMultiSet (OID, Index, Value);

Parameters

Parameter

Type

Required

Description

OID

String

Yes

Object ID of object of interest.

Index

Integer

Yes

Array parameter index. If the parameter is not an array parameter, use an Index of 0. In most cases, enter 0 as the Index.

Value

Object

Yes

New value for the OID.

Returns

Multiset object.

Example

In the following example, four parameters named "Value 1" through "Value 4" are created with text values that are displayed on buttons when the example is run. When the user taps the Multi-Set button, the params.createMultiSet function changes the parameter values to those referenced by the function.

<abscontexttype="opengear" gridsize="20" style="">

<meta>

<params>

<param access="1" maxlength="0" name="Value 1" oid="Value_1" stateless="true" type="STRING" value="Original Value 1" widget="100"/>

<param access="1" maxlength="0" name="Value 2" oid="Value_2" stateless="true" type="STRING" value="Original Value 2" widget="100"/>

<param access="1" maxlength="0" name="Value 3" oid="Value_3" stateless="true" type="STRING" value="Original Value 3" widget="100"/>

<param access="1" maxlength="0" name="Value 4" oid="Value_4" stateless="true" type="STRING" value="Original Value 4" widget="100"/>

</params>

</meta>

<param expand="true" height="40" left="20" oid="Value_1" top="20" width="340"/>

<param expand="true" height="40" left="20" oid="Value_2" top="80" width="340"/>

<param expand="true" height="40" left="20" oid="Value_3" top="140" width="340"/>

<param expand="true" height="40" left="20" oid="Value_4" top="200" width="340"/>

<button buttontype="push" height="60" left="20" name="Multi-Set" top="260" width="340">

<task tasktype="ogscript">

var multi = params.createMultiSet(); multi.setValue('Value_1', 0, 'Multi-set 1');

multi.setValue('Value_2', 0, 'Multi-set 2');

multi.setValue('Value_3', 0, 'Multi-set 3');

multi.setValue('Value_4', 0, 'Multi-set 4'); multi.execute();

</task>

</button>

</abs>