Type: BCS.Sym3.ISym3BaseEditor

Sym3 Base Editor. Common for all 3 products of the suite

Properties

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

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

ActionCloseProject

Closes current project

ActionCloseProject(System.Boolean)

Closes current project with confirmation to save or not

ActionDataSourceIOExport(System.String)

  • Parameters:
    • fileName:

ActionDataSourceIOImport(System.String)

  • Parameters:
    • fileName:

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

ActionExportEquipmentProperties(System.String)

  • Parameters:
    • typeName:

ActionExportProperties(System.String)

  • Parameters:
    • typeName:

ActionExportPropertiesDataSources

Exports datasource properties

ActionExportPropertiesTags

Exports tag properties

ActionExportTags

Exports tags

ActionImportModel(System.String)

Imports a model

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

ActionImportPropertiesDataSources

Imports datasource properties

ActionImportPropertiesTags

Imports tag 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:

ActionManageTags

Opems/Closes tag 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

ActionNewComponent3D(System.String)

Creates a new equipment

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

ActionNewDatabaseDevice

Actions for creating a new database device.

ActionNewDataSource

Creates a new datasource

ActionNewDevice

Actions for creating a new device.

ActionNewMessage

Actions for creating a new message

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);

ActionNewSystemProperty

Actions for creating system property.

ActionNewUDT

Actions for creating udt.

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:

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

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.