XCommands for visualization runtime control

Owned by Reinhard Mayr (Unlicensed)
Last updated: Dec 14, 2021
2 min read

The XCommand Button function of a button allows to execute specific XCommands upon events triggered by the button. The XCommands related to visualization runtime control are located in the VISU folder of the XCommand selection. While other XCommands are executed in the server, the VISU XCommands are always executed on the client. That is, they do not affect server contents, and they to not affect other clients.

 Following XCommands are available:

XCommandDescriptionParameters
Groups.InvisibleHides all groups matching the provided matching criteria.
  • GroupNameFilter_1 - 10: group name; wildcards * and ? are allowed
Groups.SetVariablesSets variables of groups matching the provided criteria.
  • GroupNameFilter: group name; wildcards * and ? are allowed
  • VariableName_1 - 5: variable name
  • VariableValue_1 - 5: variable value
Groups.VisibleShows all groups matching the provided criteria.
  • GroupNameFilter_1 - 10: group name; wildcards * and ? are allowed
Layers.DisableDisables all layers matching the provided criteria.
  • LayerNameFilter_1 - 10: layer name; wildcards * and ? are allowed
Layers.EnableEnables all layers matching the provided criteria.
  • LayerNameFilter_1 - 10: layer name; wildcards * and ? are allowed
Layers.InvisibleHides all layers matching the provided criteria.
  • LayerNameFilter_1 - 10: layer name; wildcards * and ? are allowed
Layers.SetVariablesSets variables of layers matching the provided criteria.
  • LayerNameFilter_1 - 10: layer name; wildcards * and ? are allowed
  • VariableName_1 - 5: variable name
  • VariableValue_1 - 5: variable value
Layers.VisibleShows all layers matching the provided matching criteria.
  • LayerNameFilter_1 - 10: layer name; wildcards * and ? are allowed
Objects.SetPropertiesSets properties of visualization objects matching the provided criteria.
  • ObjectIdFilter: matching criteria for the NAME property; wildcards * and ? are allowed
  • PropertyName_1 - 5: property name
  • PropertyValue_1 - 5: property value
Pages.GotoNavigates to the specified page.
  • PageName: page name. Alternatively use <PREVIOUS> and <NEXT> to navigate in the page history or <HOME> to navigate to the home page.
  • ViewId: view in which the page shall be opened. Valid values are Current, Main, View2, View3. If not used, Current will be used.
Pages.SetVariablesSets variables of pages matching the provided criteria.
  • PageNameFilter: page name; wildcards * and ? are allowed
  • VariableName_1 - 5: variable name
  • VariableValue_1 - 5: variable value
Workspace.SetVariablesSets workspace variables.
  • VariableName_1 - 5: variable name
  • VariableValue_1 - 5: variable value