Macro API Type : BCS.Sym3.ISym3OperatorEditor

Methods:

ActionOpen3DDesignView

Summary:

Opens the 3d design view

ActionClose3DDesignView

Summary:

Close the 3d design view

ActionNewColor

Summary:

Creates a new color

ActionManageColors

Summary:

Opens/Close color manager

ActionExportPropertiesColors

Summary:

Export color properties

ActionImportPropertiesColors

Summary:

Import color properties

ActionNewImage

Summary:

Create a new image

ActionReplaceImages(System.Collections.ICollection)

Summary:

Replace images

Parameters:

items:

ActionManageImages

Summary:

Opens/Closes image manager

ActionExportPropertiesImages

Summary:

Exports image properties

ActionImportPropertiesImages

Summary:

Imports image properties

ActionImportImages(System.String[])

Summary:

Imports images

Parameters:

files: An array of image files (on the disk)

Returns:

Returns the list of created Sym3 images

ActionNewAudio

Summary:

Creates a new audio

ActionManageAudios

Summary:

Opens/Close audio manager

ActionExportPropertiesAudios

Summary:

Exports audio properties

ActionImportPropertiesAudios

Summary:

Imports audio properties

ActionImportAudios(System.String[])

Summary:

Imports audios

Parameters:

files: An array of audio files (on the disk) (.wav files)

Returns:

Returns the list of created Sym3 audios

ActionNewWindow

Summary:

Creates a new window

Returns:

Created window

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

Summary:

Opens a list of window

Parameters:

items: list of window to open

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

Summary:

Closes a list of window

Parameters:

items: list of window to close

ActionManageWindows

Summary:

Opens/closes window manager

ActionExportPropertiesWindows

Summary:

Export window properties

ActionImportPropertiesWindows

Summary:

Imports window properties

ActionPreviewWindow(Sym3.IWindow)

Summary:

Opens a preview of a window into a popup form.

Parameters:

window: the window to preview

ActionNewFrame

Summary:

Creates a new frame

ActionManageFrames

Summary:

Opens/Closes frame manager

ActionExportPropertiesFrames

Summary:

Exports frame properties

ActionImportPropertiesFrames

Summary:

Imports frame properties

ActionNewDataSource

Summary:

Creates a new datasource

ActionManageDataSources

Summary:

Opens/Closes datasource manager

ActionExportPropertiesDataSources

Summary:

Exports datasource properties

ActionImportPropertiesDataSources

Summary:

Imports datasource properties

ActionBrowseOpcServer

Summary:

Opens the OPC Server browser window

ActionManageTags

Summary:

Opems/Closes tag manager

ActionExportPropertiesTags

Summary:

Exports tag properties

ActionImportPropertiesTags

Summary:

Imports tag properties

ActionExportTags

Summary:

Exports tags

ActionImportTags

Summary:

Imports tags

ActionDeleteAllTags

Summary:

Deletes all existing tags

ActionManageAlarms

Summary:

Opens/Closes alarm manager

ActionExportPropertiesAlarms

Summary:

Exports alarm properties

ActionImportPropertiesAlarms

Summary:

Imports alarm properties

ActionImportAlarms

Summary:

Imports alarms

ActionExportAlarms

Summary:

Export alarms

ActionDeleteAllAlarms

Summary:

Deletes all existing alarms

ActionNewAlarmPriority

Summary:

Creates a new alarm priority

Returns:

the newly created alarm priority

ActionManageAlarmPriorities

Summary:

Opens/Closes alarm priority manager

ActionExportPropertiesAlarmPriorities

Summary:

Export alarm priority properties

ActionImportPropertiesAlarmPriorities

Summary:

Imports alarm priority properties

ActionDeleteAllAlarmPriorities

Summary:

Deletes all existing alarm priorities

ActionManageDatalogs

Summary:

Opems/Closes Datalog manager

ActionExportPropertiesDatalogs

Summary:

Exports Datalog properties

ActionImportPropertiesDatalogs

Summary:

Imports Datalog properties

ActionExportDatalogs

Summary:

Exports Datalogs

ActionImportDatalogs

Summary:

Imports Datalogs

ActionDeleteAllDatalogs

Summary:

Deletes all existing Datalogs

ActionNewUser

Summary:

Creates a new user

Returns:

the newly created user

ActionManageUsers

Summary:

Opens/Closes user manager

ActionExportPropertiesUsers

Summary:

Exports user properties

ActionImportPropertiesUsers

Summary:

Imports user properties

ActionNewPermission

Summary:

Creates a new permission

Returns:

the newly created permission

ActionManagePermissions

Summary:

Opens/Closes permission manager

ActionExportPropertiesPermissions

Summary:

Export permission properties

ActionImportPropertiesPermissions

Summary:

Imports permission properties

ActionNewRole

Summary:

Creates a new role

Returns:

the newly created role

ActionManageRoles

Summary:

Opens/Closes role manager

ActionExportPropertiesRoles

Summary:

Exports role properties

ActionImportPropertiesRoles

Summary:

Imports role properties

ActionNewControlTemplate(System.String)

Summary:

Creates a new template for a control

ActionNewEquipmentTemplate(System.String)

Summary:

Creates a new template for an equipment

ActionNewHotKey(Sym3.HotKeyType)

Summary:

Creates a new hot key

Returns:

Created hot key

ActionExitApplication

Summary:

Exits application

ActionNewProject

Summary:

Creates a new project

ActionNewProject(DistanceUnit)

Summary:

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

ActionOpenProject

Summary:

Opens an existing project

ActionSaveProject

Summary:

Saves current project

ActionSaveProjectAs

Summary:

Saves current project as

ActionAddUserMessage(LogType,System.String)

Summary:

Displayes user message

Parameters:

type:
text:

ActionOpenProject(System.String)

Summary:

Opens a project

Parameters:

fileName: project to open

ActionCloseProject

Summary:

Closes current project

ActionCloseProject(System.Boolean)

Summary:

Closes current project with confirmation to save or not

ActionEditProperties(System.Object)

Summary:

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

Parameters:

item:

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

Summary:

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

Parameters:

items:
forceOpen:

ActionNewComponent3D(System.String)

Summary:

Creates a new equipment

Parameters:

typeName: type of the equipment to create

ActionImportModel(System.String)

Summary:

Imports a model

Parameters:

fileType: type to file to import. Values can be "Virtual Airport Model" or "CAD Template"

ActionEnable3DRendering(System.Boolean)

Summary:

Enables/disables the 3d rendering

Parameters:

value:

ActionEnable3DEditMode(System.Boolean)

Summary:

Enables/disables the 3d edit mode

Parameters:

value:

ActionDevicePingIP(Sym3.IDevice)

Summary:

Parameters:

plc:

ActionDevicePingMessage(Sym3.IDevice)

Summary:

Parameters:

plc:

ActionDeviceIOConfigurationImport(System.String)

Summary:

Parameters:

fileName:

ActionDeviceIOConfigurationExport(System.String)

Summary:

Parameters:

fileName:

ActionDeleteDeviceIOs(System.Collections.ICollection)

Summary:

Parameters:

items:

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

Summary:

Parameters:

errors:

ActionOpenPropertyPanel(System.Boolean)

Summary:

Parameters:

open:

ActionOpenProjectExplorer(System.Boolean)

Summary:

Parameters:

open:

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

Summary:

Parameters:

objects:

ActionExportProperties(System.String)

Summary:

Parameters:

typeName:

ActionExportEquipmentProperties(System.String)

Summary:

Parameters:

typeName:

ActionNewMyEquipmentTypeFromShape(System.Collections.Generic.List{IBaseObject})

Summary:

Creates a new user equipment type from a 3d model

ActionNewMyEquipmentTypeFromType(System.String,System.Collections.Generic.List{IBaseObject})

Summary:

Creates a new user equipment type from another type

ActionDataSourceIOImport(System.String)

Summary:

Parameters:

fileName:

ActionDataSourceIOExport(System.String)

Summary:

Parameters:

fileName:

ActionDeleteDataSourceIOs(System.Collections.ICollection)

Summary:

Parameters:

items:

Properties

AlarmClientService

Summary:

Get the alarm service

Type:

IAlarmClientService

Access:

Read

Events

Summary:

Get the event log service

Type:

IEventLogService

Access:

Read

Version

Summary:

Get editor build version

Type:

IVersionInfo

Access:

Read

Logger

Summary:

Gets the logger

Type:

ILogger

Access:

Read

EditMode3D

Summary:

Enables/disables the 3d edit mode. Same as ActionEnable3DEditMode method.

Type:

System.Boolean

Access:

Read and Write

AlwaysDropProductInMiddle

Summary:

Options: if true: in 3D view, always drop product in middle of transporter otherwsie will apply a lateral offset to the product.

Type:

System.Boolean

Access:

Read and Write