Public Functions in the Situational Awareness Include Project
The Situational Awareness include project, sa-include, contains public Cicode functions that can be used to customize your installation of Citect Studio, navigation, themes and workspaces. The following categories of functions are available:
- Debugging functions: Allow you to trace the user's actions for a workspace and its components. Traced output is written to syslog.dat, which you can review to address any issues encountered.
- Equipment functions: Allow you to pass or retrieve equipment context and retrieve workspace content using the equipment context.
- Help functions: Allow you customize the display of help in a floating window or a pane within a workspace.
- Navigation functions: Allow you to display a specific page in the workspace and add the transition to the navigation stack.
- NavigationLink functions: Allow you to hide the navigation link genies on a page.
- Security functions: Allow for security-related operations within workspaces and faceplates.
- TabBar functions: Allow you to add tabs to a workspace and control the display if open items do not fit on the display.
- Theme functions: Allow for set the basic theme of a workspace and its components, or add custom themes.
- Workspace functions: Allow you to:
- display customized content in any pane
- set equipment-based context for a workspace
- set the content type for a workspace pane
Below is a list of available functions:
Debugging Functions
|
|
Equipment Functions
|
|
Help Functions
|
|
Navigation Functions
|
|
Security Functions
|
GetPrivEx
|
TabBar Functions
|
|
Theme Functions
|
|
Workspace Functions
|
|
Published June 2018