Type: BCS.Sym3.ISym3OperatorEditor

Sym3 Operator Editor

Properties

AlarmClientService

  • Description: Get the alarm service
  • Type: IAlarmClientService
  • Access: Read

AlwaysDropProductInMiddle

  • Description: Options: if true: in 3D view, always drop product in middle of transporter otherwsie will apply a lateral offset to the product.
  • Type: Boolean
  • Access: Read and Write

ApplicationOpenFilter

  • Description: Gets the file open filter
  • Type: String
  • Access: Read

ApplicationSaveFilter

  • Description: Gets the file save filter
  • Type: String
  • Access: Read

EditMode3D

  • Description: Enables/disables the 3d edit mode. Same as ActionEnable3DEditMode method.
  • Type: Boolean
  • Access: Read and Write

Events

  • Description: Get the event log service
  • Type: IEventLogService
  • Access: Read

IsInEquipmentDragMode

  • Description: Flag for the selected equipment is/are being draged
  • Type: Boolean
  • Access: Read and Write

Logger

  • Description: Gets the logger
  • Type: ILogger
  • Access: Read

PanelProjectExplorer

  • Description: Returns the object responsible for the project explorer panel.
  • Type: IPanelProjectExplorer
  • Access: Read

ReplayRecordingEnabled

  • Description: Check if recording is enabled
  • Type: Boolean
  • Access: Read

Version

  • Description: Get editor build version
  • Type: IVersionInfo
  • Access: Read

Methods

ActionAddUserMessage(BCS.LogType,System.String)

Displayes user message

  • Parameters:
    • type:
    • text:

ActionBrowseOpcServer

Opens the OPC Server browser window

ActionBTSImport

Imports BTS using Sym3 extraction file

ActionClose3DDesignView

Close the 3d design view

ActionCloseProject

Closes current project

ActionCloseProject(System.Boolean)

Closes current project with confirmation to save or not

ActionCloseWindows(System.Collections.Generic.List{BCS.IBaseObject}@)

Closes a list of window

  • Parameters:
    • items: list of window to close

ActionDataSourceIOExport(System.String)

  • Parameters:
    • fileName:

ActionDataSourceIOImport(System.String)

  • Parameters:
    • fileName:

ActionDeleteAllAlarmPriorities

Deletes all existing alarm priorities

ActionDeleteAllAlarms

Deletes all existing alarms

ActionDeleteAllDatalogs

Deletes all existing Datalogs

ActionDeleteAllDeviceIOs

Deletes all existing Device IOs

ActionDeleteAllTags

Deletes all existing tags

ActionDeleteDataSourceIOs(System.Collections.ICollection)

  • Parameters:
    • items:

ActionDeleteDeviceIOs(System.Collections.ICollection)

  • Parameters:
    • items:

ActionDeviceIOConfigurationExport(System.String)

  • Parameters:
    • fileName:

ActionDeviceIOConfigurationImport(System.String)

  • Parameters:
    • fileName:

ActionDevicePingIP(BCS.Sym3.IDevice)

  • Parameters:
    • plc:

ActionDevicePingMessage(BCS.Sym3.IDevice)

  • Parameters:
    • plc:

ActionEditProperties(System.Collections.Generic.List{BCS.IBaseObject}@,System.Boolean)

Edit properties of a list of object. That will display their properties in the PropertyEditor

  • Parameters:
    • items:
    • forceOpen:

ActionEditProperties(System.Object)

Edit properties of an object. That will display its properties in the PropertyEditor

  • Parameters:
    • item:

ActionEnable3DEditMode(System.Boolean)

Enables/disables the 3d edit mode

  • Parameters:
    • value:

ActionEnable3DRendering(System.Boolean)

Enables/disables the 3d rendering

  • Parameters:
    • value:

ActionExecuteMacroFile(System.String)

Execute the macro contained in a file

  • Parameters:
    • Name: Macro file to execute

ActionExitApplication

Exits application

ActionExportAlarms

Export alarms

ActionExportDatalogs

Exports Datalogs

ActionExportEquipmentProperties(System.String)

  • Parameters:
    • typeName:

ActionExportProperties(System.String)

  • Parameters:
    • typeName:

ActionExportPropertiesAlarmPriorities

Export alarm priority properties

ActionExportPropertiesAlarms

Exports alarm properties

ActionExportPropertiesAudios

Exports audio properties

ActionExportPropertiesColors

Export color properties

ActionExportPropertiesDatalogs

Exports Datalog properties

ActionExportPropertiesDataSources

Exports datasource properties

ActionExportPropertiesFrames

Exports frame properties

ActionExportPropertiesImages

Exports image properties

ActionExportPropertiesPermissions

Export permission properties

ActionExportPropertiesRoles

Exports role properties

ActionExportPropertiesTags

Exports tag properties

ActionExportPropertiesUsers

Exports user properties

ActionExportPropertiesWindows

Export window properties

ActionExportTags

Exports tags

ActionImportAlarms

Imports alarms

ActionImportAudios(System.String[])

Imports audios

  • Parameters:
    • files: An array of audio files (on the disk) (.wav files)
  • Returns:
    • Returns the list of created Sym3 audios

ActionImportDatalogs

Imports Datalogs

ActionImportImages(System.String[])

Imports images

  • Parameters:
    • files: An array of image files (on the disk)
  • Returns:
    • Returns the list of created Sym3 images

ActionImportModel(System.String)

Imports a model

  • Parameters:
    • fileType: type to file to import. Values can be “Virtual Airport Model” or “CAD Template”

ActionImportPropertiesAlarmPriorities

Imports alarm priority properties

ActionImportPropertiesAlarms

Imports alarm properties

ActionImportPropertiesAudios

Imports audio properties

ActionImportPropertiesColors

Import color properties

ActionImportPropertiesDatalogs

Imports Datalog properties

ActionImportPropertiesDataSources

Imports datasource properties

ActionImportPropertiesFrames

Imports frame properties

ActionImportPropertiesImages

Imports image properties

ActionImportPropertiesPermissions

Imports permission properties

ActionImportPropertiesRoles

Imports role properties

ActionImportPropertiesTags

Imports tag properties

ActionImportPropertiesUsers

Imports user properties

ActionImportPropertiesWindows

Imports window properties

ActionImportTags

Imports tags

ActionLocateEquipment(System.Collections.Generic.List{BCS.IBaseObject}@)

Locate equipment in 3D view

  • Parameters:
    • items:

ActionLocateObjectInProjectExplorer(System.Collections.Generic.List{BCS.IBaseObject})

  • Parameters:
    • objects:

ActionManageAlarmPriorities

Opens/Closes alarm priority manager

ActionManageAlarms

Opens/Closes alarm manager

ActionManageAudios

Opens/Close audio manager

ActionManageColors

Opens/Close color manager

ActionManageDatalogs

Opems/Closes Datalog manager

ActionManageFrames

Opens/Closes frame manager

ActionManageImages

Opens/Closes image manager

ActionManagePermissions

Opens/Closes permission manager

ActionManageRoles

Opens/Closes role manager

ActionManageTags

Opems/Closes tag manager

ActionManageUsers

Opens/Closes user manager

ActionManageWindows

Opens/closes window manager

ActionMergeProject(System.Boolean)

Open a second project to merge with

  • Parameters:
    • showMergeWindow: Show the conflicts window

ActionMergeProject(System.String,System.String,System.Boolean)

Merges to a project

  • Parameters:
    • fileA: LEFT file for merge
    • fileB: RIGHT file for merge
    • showMergeWindow: Show conflict resolution window

ActionNewAlarmPriority

Creates a new alarm priority

  • Returns:
    • the newly created alarm priority

ActionNewAudio

Creates a new audio

ActionNewColor

Creates a new color

ActionNewComponent3D(System.String)

Creates a new equipment

  • Parameters:
    • typeName: type of the equipment to create

ActionNewControlTemplate(System.String)

Creates a new template for a control

ActionNewDatabaseDevice

Actions for creating a new database device.

ActionNewDataSource

Creates a new datasource

ActionNewDevice

Actions for creating a new device.

ActionNewEquipmentTemplate(System.String)

Creates a new template for an equipment

ActionNewFrame

Creates a new frame

ActionNewHotKey(BCS.Sym3.HotKeyType)

Creates a new hot key

  • Returns:
    • Created hot key

ActionNewImage

Create a new image

ActionNewMessage

Actions for creating a new message

ActionNewPermission

Creates a new permission

  • Returns:
    • the newly created permission

ActionNewProject

Creates a new project

ActionNewProject(BCS.DistanceUnit)

Creates a new project with a specified unit

  • Example:
This example shows you how to create a project with a specified unit


            Editor.ActionNewProject(BCS.DistanceUnit.Metrics);

ActionNewProject(BCS.DistanceUnit,System.Boolean)

Creates a new project with a specified unit and optionally enable version control

  • Example:
This example shows you how to create a project with a specified unit and enable version control


            Editor.ActionNewProject(BCS.DistanceUnit.Metrics, true);

ActionNewRole

Creates a new role

  • Returns:
    • the newly created role

ActionNewSystemProperty

Actions for creating system property.

ActionNewUDT

Actions for creating udt.

ActionNewUser

Creates a new user

  • Returns:
    • the newly created user

ActionNewWindow

Creates a new window

  • Returns:
    • Created window

ActionOpen3DDesignView

Opens the 3d design view

ActionOpenMessageManager

Actions for opening the message manager

ActionOpenProject

Opens an existing project

ActionOpenProject(System.String)

Opens a project

  • Parameters:
    • fileName: project to open

ActionOpenProjectExplorer(System.Boolean)

  • Parameters:
    • open:

ActionOpenPropertyPanel(System.Boolean)

  • Parameters:
    • open:

ActionOpenWindows(System.Collections.Generic.List{BCS.IBaseObject}@)

Opens a list of window

  • Parameters:
    • items: list of window to open

ActionPreviewWindow(BCS.Sym3.IWindow)

Opens a preview of a window into a popup form.

  • Parameters:
    • window: the window to preview

ActionRedoTo(System.Int32)

Redoes all changes up to and including the change with the given id

  • Parameters:
    • id: Id of the change in the the undo buffer to stop at

ActionReplaceImages(System.Collections.ICollection)

Replace images

  • Parameters:
    • items:

ActionSaveProject

Saves current project

ActionSaveProjectAs(System.String)

Saves current project as

  • Parameters:
    • fileName: If fileName is null, an dialog will ask user to choose the file name to save to.

ActionTestDatabaseConnection(BCS.Sym3.IDatabase)

  • Parameters:
    • databaseDevice:

ActionUndoTo(System.Int32)

Undoes all changes down to and including the change with the given id

  • Parameters:
    • id: Id of the change in the the undo buffer to stop at

ActionUpdateMyEquipmentExistingIntances(System.String)

Updates and show progress for existing MyEquipment Instances

  • Parameters:
    • value:

ActionValidateDeviceIOConfig(System.Collections.Generic.List{System.String}@,System.Collections.Generic.List{System.String}@)

  • Parameters:
    • errors:

ActionValidateTagConfig(System.Collections.Generic.List{System.String}@)

  • Parameters:
    • errors:

GetGitCommitMessage(System.String@)

Opens Git Commit Message window and returns the commit message

  • Parameters:
    • initialMessage: Optional initial message

LogDebug(System.String)

Log a debug message in MessageViewer

  • Parameters:
    • text: Text to log
  • Example:
How to log a debug in Message Viewer

LogError(System.String)

Log an error message in MessageViewer

  • Parameters:
    • text: Text to log
  • Example:
How to log an error in Message Viewer

LogInfo(System.String)

Log an info message in MessageViewer

  • Parameters:
    • text: Text to log
  • Example:
How to log an info in Message Viewer

LogWarn(System.String)

Log a warning message in MessageViewer

  • Parameters:
    • text: Text to log
  • Example:
How to log a warning in Message Viewer

UndoKeyDownHandler(System.Object,System.Windows.Input.KeyEventArgs)

Undo key event handler. To enable undo/redo, attach this to the key down event handler of the desired window.