<file name="nxa.BMSClientXCommand">
<h1>Description - INTERNAL DOCUMENTATION</h1>
<h1>Signature</h1> nxa.BMSClientXCommand (string, string) <p>Send command to BMS Client.</p>
<h1>Parameters</h1>
<table>
<colgroup> <col/> <col/> <col/> <col/> </colgroup>
<tbody>
<tr>
<th>Name</th>
<th>Type</th>
<th>Mandatory/Optional</th>
<th>Description</th>
</tr>
<tr><td></td><td>string</td><td>M</td><td>The BMS web client which should execute the command.</td></tr>
<tr><td></td><td>string</td><td>M</td><td>The command and parameters as string: "<command>;<pa
</tbody>
</table>
<h1>Return</h1> None.
</file>
Available commands are:
- user_logout, user_logoff: Logout
Example: nxa.BMSClientXCommand("test","user_logoff")
- client_info: Get client info params: <what>;<target>
what: user_name, actualpage_name, actualpage_wid target: Target ItemID which gets the info pushed. Backslashes \ must be escaped as
. Examples:
client_info;user_name;NETx\\VAR
String Item1 client_info;actualpage_name;NETx\\VAR
String Item2 client_info;actualpage_wid;NETx\\VAR
Numeric Item1
- layer_visibility: Change Layer Visibility params: <address_type>;<address_list>;<visibility> address_type: wid, index, name (How to address the layer) address_list: a list of names, indices, or WIDs of the layers, separated by pipes |. For each address the visibility (true or false) can be specified after an @ symbol. For names the asterisk * wildcard can be used.
visibility: true, false. Is used for all provided layers without prior visibility specification. Examples:
nxa.BMSClientXCommand("test","layer_visibility;id;1000;false") nxa.BMSClientXCommand("test","layer_visibility;name;Layer1;true") – Sets Layer1 to true.
nxa.BMSClientXCommand("test","layer_visibility;name;Layer1@false;true") – Sets
Layer1 to false.
nxa.BMSClientXCommand("test","layer_visibility;name;Layer1@false|Layer2;true") – Sets Layer1 to false, Layer2 to true.
nxa.BMSClientXCommand("test","layer_visibility;name;Layer1|Layer2@false|Layer3;true") – Sets Layer1 and Layer3 to true, Layer2 to false.
- popup_visibility: Change Pop-Up Visibility params: <address_type>;<address_list>;<visibility> address_type: wid, name (How to address the pop-up) address_list: a list of names, or WIDs of the pop-up groups, separated by pipes |. For each address the visibility (true or false) can be specified after an @ symbol. For names the asterisk * wildcard can be used. visibility: true, false. Is used for all provided pop-up groups without prior visibility specification.
- page_change: change the active page params: <address_type>;<value>
<address_type>: wid, name value: Value of the page to be navigated to. For address type wid there are following reserved values:
- = previous page in page stack
- = forward page in page stack
- = Homepage
Example: nxa.BMSClientXCommand("test","page_change;wid;-3")
• page_reload: reload the current page
Example: nxa.BMSClientXCommand("test","page_reload")