Type: ISym3OperatorClient

Summary:

Sym3 Operator Client - In a macro you get access to this by using the variable called 'Client'

Remarks:

Methods:

Exit(System.Boolean)

Summary:

Exit client application

Parameters:

  1. displayConfirmationMessage: if true, a confirmation message will pop up.

FireUserActivity(System.Object,Sym3.Operator.Runtime.UserActivityType,System.Object[])

Summary:

Fire a new user activity

Parameters:

  1. source: source object
  2. type: type of activity
  3. args: array of arguments. These arguments depends on the type

Restart

Summary:

Restart client applciation

IncreaseVolume

Summary:

Increases sound volume

DecreaseVolume

Summary:

Decreases sound volume

MuteVolume

Summary:

Mute sounds

Properties

MaxNumberOfAlarms

Summary:

get max number of alarms this client can receive

Type:

System.Int32

Access:

Read

MaxNumberOfEvents

Summary:

get max number of events this client can receive

Type:

System.Int32

Access:

Read

Settings

Summary:

Access client global settings

Type:

IClientSettings

Access:

Read

Scripting

Summary:

Access the Scripting service

Type:

IScriptingService

Access:

Read

Layout

Summary:

Access the layout service

Type:

ILayoutService

Access:

Read

Debug

Summary:

Access the debug service

Type:

IDebugService

Access:

Read

Authentication

Summary:

Access the authentication service

Type:

IAuthenticationService

Access:

Read

Alarms

Summary:

Access the alarm service

Type:

IAlarmClientService

Access:

Read

Events

Summary:

Access the event log service

Type:

IEventLogService

Access:

Read

Tags

Summary:

Access the tag service

Type:

ITagService

Access:

Read

Connections

Summary:

Access the connection service

Type:

IConnectionService

Access:

Read

Products

Summary:

Access the product service

Type:

IProductService

Access:

Read

Project

Summary:

Gets the project - The project is read only

Type:

ISym3Project

Access:

Read

Logger

Summary:

Gets the logger

Type:

ILogger

Access:

Read

LogFilePath

Summary:

Gets the log file path

Type:

System.String

Access:

Read

Tools

Summary:

Gets access to some useful tools

Type:

ISym3Tools

Access:

Read

CurrentLanguage

Summary:

Gets/Sets current language

Type:

ILanguage

Access:

Read and Write

Events

ClientStarted

Summary:

This event is fired when the client starts

Example:

This example shows you how to subscribe to this event 

             //---- JAVASCRIPT:
             Client.add_ClientStarted(OnStart);
             
             function OnStart() {
             ...
             }
             
             //---- C#:
             Client.ClientStarted += new ClientStartStopEventHandler(OnClientStarted);
             ...
             
             private void OnClientStarted()
             {
                 // TODO...
             }

ClientStopped

Summary:

This event is fired when the client stops

Example:

This example shows you how to subscribe to this event 

             //---- JAVASCRIPT:
             Client.add_ClientStopped(OnStop);
             
             function OnStop() {
             ...
             }
             
             //---- C#:
             Client.ClientStopped += new ClientStartStopEventHandler(OnClientStopped);
             ...
             
             private void OnClientStopped()
             {
                 // TODO...
             }

UserActivity

Summary:

This event is fired when the user did something.

Example:

This example shows you how to subscribe to this event 

             //---- JAVASCRIPT:
             Client.add_UserActivity(OnUserActivity);
             
             function OnUserActivity(source, type, args) {
             
                 if(type == BCS.Sym3.Operator.Runtime.UserActivityType.ButtonClicked) { ... }
                 else if(type == BCS.Sym3.Operator.Runtime.UserActivityType.MenuItemClicked) { ... }
                 else if(type == BCS.Sym3.Operator.Runtime.UserActivityType.HotKeyPressed) { ... }
                 else if(type == BCS.Sym3.Operator.Runtime.UserActivityType.CurrentUserChanged) { ... }
                 else if(type == BCS.Sym3.Operator.Runtime.UserActivityType.ValueChanged) { ... }
             }
             
             //---- C#:
             Client.UserActivity += new ActivityEventHandler(OnUserActivity);
             ...
             
             private void OnUserActivity(object source, UserActivityType type, params object[] args)
             {
                 // TODO...
             }