ICommand Interface
- Last UpdatedJul 18, 2023
- 2 minute read
Inbuilt Commands are listed below:
|
ID |
Description |
|---|---|
|
Citect_Command_LoadConfig |
Displays the "Load File" dialog. The user can then specify a configuration file to load into the Process Analyst Control. |
|
Citect_Command_SaveConfig |
Displays the "Save File" dialog allowing the user to specify a location to save the current Process Analyst Configuration to. |
|
Citect_Command_ToggleZoom |
Toggles the Process Analyst into box-zoom mode. The mouse cursor will be changed into the cross hair. The Zoom is cancelled with a right mouse click, or toggling this command button again |
|
Citect_Command_ZoomIn50 |
Executes a horizontal and vertical zoom in of 50% of the current spans(s) of the pen(s). |
|
Citect_Command_ZoomOut50 |
Executes a horizontal and vertical zoom out of 50% of the current spans(s) of the pen(s). |
|
Citect_Command_ZoomUndo |
Undoes the last zoom operation |
|
Citect_Command_SpanReset |
Restores the pen(s) spans to their original default settings. |
|
Citect_Command_SpanEdit |
Displays a dialog allowing the operator to explicitly enter a span to apply to the pen(s). |
|
Citect_Command_ScaleEdit |
Edit Vertical Scale |
|
Citect_Command_ScrollLeft100 |
Moves the pen(s) back in time exactly one span. ‘Span’ refers to the distance in time between the ‘Start’ and ‘End’ of the time-axis. |
|
Citect_Command_ScrollLeft50 |
Moves the pen(s) back half a span. |
|
Citect_Command_ScrollRight100 |
Moves the pen(s) forward in time exactly one span. ‘Span’ refers to the distance in time between the ‘Start’ and ‘End’ of the time-axis |
|
Citect_Command_ScrollRight50 |
Moves the pen(s) forward half a span. |
|
Citect_Command_SynchroniseToNow |
Synchronises pens such that the end date time reflects "now" which is positioned on the right hand edge of the screen. "Now" is calculated using the current system time |
|
Citect_Command_ToggleAutoScroll |
Toggles the automatic scrolling off and on for pens |
|
Citect_Command_CopyToFile |
Exports visible pens to an Excel compatible file. |
|
Citect_Command_CopyToClipboard |
Exports visible pens to the clipboard. |
|
Citect_Command_ToggleCursorVisibility |
Shows or Hides cursors. If no cursor exists a cursor will be created. Note: Showing a cursor will automatically make the labels visible. |
|
Citect_Command_ToggleCursorLabels |
Shows or Hides cursor labels. |
|
Citect_Command_ToggleCursorLabelsLock |
Locks or Unlocks the movement of the labels with the cursor. |
|
Citect_Command_TogglePensLock |
Allows or disallows the independent movement of pens against each other. |
|
Citect_Command_AddPane |
Adds a new pane to the view |
|
Citect_Command_RemovePane |
Removes the pane of the primary selected pen. A dialog will confirm the delete. |
|
Citect_Command_TogglePenAutoScale |
Toggles the auto-scaling behaviour for the selected pen. This is on a per pen basis. Applying this will remove the Vertical axis scrolling. |
|
Citect_Command_ToggleVerticalScrollLock |
Toggles interactive scrolling of the vertical axis. Applying this will remove the autoscale behaviour. |
|
Citect_Command_AddPen |
Displays the add pen dialog |
|
Citect_Command_PenRemove |
Removes the selected pen from the display. |
|
Citect_Command_ToggleObjectView |
When pressed, the Object View will be displayed at the bottom of the Process Analyst Control. When un-pressed, the Object View will be hidden and the Process Analyst Control will expand to take up the vacant space |
|
Citect_Command_Print |
Displays the print dialog, allowing the user to print the current state of the Process Analyst Control |
|
Citect_Command_RefreshData |
Refreshes the selected pen, or pens (if locked) |
|
Citect_Command_Properties |
Displays the properties dialog |
Defined As
-
[VBA] Object
-
[Cicode] OBJECT
-
[C++] ICommand
Methods (0)
Properties (6)
ICommand.CommandId [Property][Get]
ICommand.ButtonType [Property][Get]
ICommand.Enabled [Property][Get/Set]