Scripting capabilities allow you to execute commands and logical operations based on specified criteria being met, such as when a key is pressed, a symbol is displayed, or a value changes.

• ArchestrA Symbols use the same scripting engine as ArchestrA Objects: QuickScript .NET. All QuickScript .NET functions and capabilities found within ArchestrA Objects are available here.

• Note: All scripts run synchronously at runtime.

• There are three types of scripts that can be used with ArchestrA Symbols: Symbol, Action, and Event.

Symbol Scripts

• Symbol scripts are associated with the ArchestrA Symbol itself. Access Symbol scripts through the Runtime Behavior category of the Properties Editor or by right-clicking the canvas and selecting Scripts. There are two types of Symbol Scripts: Predefined and Named.

• Predefined Scripts are executed when the specific built-in condition is triggered. Every ArchestrA Symbol has three built-in trigger types available:

• • On Show: Executes one time when the symbol is shown or opened.
  • While Showing: Executes periodically while the symbol is showing. The period (in milliseconds) indicates how often the script executes.
  • On Hide: Executes one time when the symbol is hidden or closed.

Named Scripts

• Names Scripts are executed when a specific condition is met by evaluating an expression against a specific trigger type. You can add as many named scripts as you need to any ArchestrA Symbol. There are five different trigger types available:

• • WhileTrue: Executes if the Expression is still true since the last execution. The Period (in milliseconds) indicates how often the expression is evaluated.
  • WhileFalse: Executes if the Expression is still false since the last execution. The Period (in milliseconds) indicates how often the expression is evaluated.
  • OnTrue: Executes when the Expression transitions from false to true.
  • OnFalse: Executes when the Expression transitions from true to false.
  • DataChange: Executes when the Expression value and/or quality changes.

Action Scripts

• Action Scripts are associated with elements within the ArchestrA Symbol, and are added as animations through the Edit Animations dialog box.
• Action scripts are triggered in runtime by user interaction with a mouse; although every action script can be associated with a key combination that will trigger the execution of the script as well.
• There are fifteen different trigger types available:
  • On Left Click/Key Down to activate the action script when the primary mouse button or a specific key is pressed.
  • While Left Click/Key Down to activate the action script when the primary mouse button or a specific key is pressed and held.
  • On Left Click/Key Up to activate the action script when the primary mouse button or a specific key is released.
  • On Left Double Click to activate the action script when the primary mouse button is double-clicked.
  • On Right Click to activate the action script when the secondary mouse button is pressed.
  • While Right Down to activate the action script when the secondary mouse button is pressed twice held.
  • On Right Up to activate the action script when the secondary mouse button is released.
  • On Right Double Click to activate the action script when the secondary mouse button is double-clicked.
  • On Center Click to activate the action script when the center mouse button is pressed.
  • While Center Down to activate the action script when the center mouse button is pressed and held.
  • On Center Up to activate the action script when the center mouse button is released.
  • On Center Double Click to activate the action script when the center mouse button is double-clicked.
  • On Mouse Over to activate the action script when the mouse pointer is moved over the element.
  • On Mouse Leave to activate the action script when the mouse pointer is moved out of the element.
  • While Mouse Over to activate the action script while the mouse pointer is over the element.

Event Scripts (Client Control Event):

• Event scripts are associated with Client Controls within an ArchestrA Symbol. Event scripts are configured as pre-built animations through the Edit Animations dialog box where a list of all the events exposed by the client controls are listed.
• Event scripts are triggered in runtime when the client control triggers the corresponding event. Each client control exposes its own particular list of events. These are an example of some common events found in most client controls:
  • Click
  • DoubleClick
  • Enter
  • Leave
  • KeyDown
  • KeyPress
  • KeyUp