Table of Contents

Revision History ISO 26262

Automation and Scripting

Automating Tasks through Scripting

Before You Begin

Compatible Scripting Languages

Running Scripts

Search Order for Scripts

The scripts.ini File

Debugging Scripts

Invalid Objects in Scripts

Specifying Script and Form Execution

Execution at Application Startup

Executing a Script or Form at Project Startup

Execution from the OS Command Window

Running a Script from the Command Line

Running a Form from the Command Line

Advantages of Using Forms

Key Binding Definition File

Examples of Xpedition Designer Automation

Script Examples in this Document

Example 1: Create/Add Menus

Example 2: Opening a Data Sheet

Example 3: Opening a Data Sheet

Example 4: Using Objects in Scripts

Schematic Editor Data Objects

AddinInfo Object

InitiallyDisabled Property (AddinInfo Object)

InitiallyVisible Property (AddinInfo Object)

LicenseFeature Property (AddinInfo Object)

Name Property (AddinInfo Object)

Placement Property (AddinInfo Object)

ProgId Property (AddinInfo Object)

RuntimeCreateDecision Property (AddinInfo Object)

ShortCutKey Property (AddinInfo Object)

ToolbarButton Property (AddinInfo Object)

Application Object

Activate Method (Application Object)

AddAddin Method (Application Object)

AppendOutput Method (Application Object)

CloseProject Method (Application Object)

CommandsManager Method (Application Object)

DesignComponents Method (Application Object)

DesignNets Method (Application Object)

DesignPaths Method (Application Object)

GetActiveDesign Method (Application Object)

GetDefaultColor Method (Application Object)

GetProjectData Method (Application Object)

Initialize Method (Application Object)

NewProject Method (Application Object)

OpenBlocks Method (Application Object)

OpenProject Method (Application Object)

OpenURL Method (Application Object)

ParamGetMode Method (Application Object)

ParamGetValue Method (Application Object)

ParamSetMode Method (Application Object)

ParamSetValue Method (Application Object)

PrintProject Method (Application Object)

PushPath Method (Application Object)

Query Method (Application Object)

QueryPages Method (Application Object)

Quit Method (Application Object)

RunISE Method (Application Object)

SchematicSheetDocuments Method (Application

SelectPath Method (Application Object)

SelectPathCompPin Method (Application Object)

SetDefaultColor Method (Application Object)

SetRedraw Method (Application Object)

StartMigration Method (Application Object)

ActiveDocument Property (Application Object)

ActiveView Property (Application Object)

Addins Property (Application Object)

CommandBars Property (Application Object)

CommandLineArguments Property (Application

Interactive Property (Application Object)

QueueSelectEvents Property (Application Object)

ShellCmd Property (Application Object)

SilentMode Property (Application Object)

SourceDocuments Property (Application Object)

StatusBarText Property (Application Object)

Version Property (Application Object)

Visible Property (Application Object)

ActivateView Event (Application Object)

ActivateView2 Event (Application Object)

AfterDocumentOpened Event (Application Object)

AfterPrintProject Event (Application Object)

AfterSheetRead Event (Application Object)

AfterSheetReRead Event (Application Object)

BeforeDocumentOpened Event (Application Object)

BeforePrintProject Event (Application Object)

BeforeProjectChanged Event (Application Object)

BlockLocked Event (Application Object)

BlockModified Event (Application Object)

CreateObject Event (Application Object)

DeactivateView Event (Application Object)

DeactivateView2 Event (Application Object)

Delete Event (Application Object)

DocumentClose Event (Application Object)

LockRequest Event (Application Object)

MouseMoved Event (Application Object)

PaintRegion Event (Application Object)

PrintFile Event (Application Object)

ProjectChanged Event (Application Object)

ProjectClosed Event (Application Object)

Select Event (Application Object)

Shutdown Event (Application Object)

SourceDocumentSave Event (Application Object)

SourceFileModified Event (Application Object)

Startup Event (Application Object)

SymbolPreviewed Event (Application Object)

Unlock Event (Application Object)

GetLocation Method (Arc Object)

GetObjectColor Method (Arc Object)

IsColorAutomatic Method (Arc Object)

SetAutomaticColor Method (Arc Object)

SetLocation Method (Arc Object)

SetObjectColor Method (Arc Object)

Application Property (Arc Object)

LineStyle Property (Arc Object)

Parent Property (Arc Object)

Selected Property (Arc Object)

Type Property (Arc Object)

Attribute Object

Delete Method (Attribute Object)

DeleteInstanceValue Method (Attribute Object)

GetLocation Method (Attribute Object)

GetOatFull Method (Attribute Object)

GetObjectColor Method (Attribute Object)

IsColorAutomatic Method (Attribute Object)

SetAutomaticColor Method (Attribute Object)

SetLocation Method (Attribute Object)

SetObjectColor Method (Attribute Object)

Application Property (Attribute Object)

Child Property (Attribute Object)

EitherValue Property (Attribute Object)

Font Property (Attribute Object)

InstanceValue Property (Attribute Object)

Name Property (Attribute Object)

Orientation Property (Attribute Object)

Origin Property (Attribute Object)

Parent Property (Attribute Object)

Selected Property (Attribute Object)

Size Property (Attribute Object)

TextString Property (Attribute Object)

Type Property (Attribute Object)

Value Property (Attribute Object)

Visible Property (Attribute Object)

AddArc Method (Block Object)

AddAttribute Method (Block Object)

AddBatchAttributes Method (Block Object)

AddBox Method (Block Object)

AddCircle Method (Block Object)

AddFub Method (Block Object)

AddLine Method (Block Object)

AddLine2 Method (Block Object)

AddNet Method (Block Object)

AddNetEx Method (Block Object)

AddPartInstance Method (Block Object)

AddPin Method (Block Object)

AddPinAtLocation Method (Block Object)

AddSymbolInstance Method (Block Object)

AddText Method (Block Object)

ApplySymbolUpdate Method (Block Object)

ChangeBorder Method (Block Object)

ChangeComponent Method (Block Object)

ChangeComponentPreserveRefdes Method (Block

ClearHighlight Method (Block Object)

DeleteBorder Method (Block Object)

DeleteSelected Method (Block Object)

DeSelectAll Method (Block Object)

FindAttribute Method (Block Object)

GetBatchAttributes Method (Block Object)

GetBboxPoint Method (Block Object)

GetChildBlock Method (Block Object)

GetName Method (Block Object)

InsertBorder Method (Block Object)

PromoteSymbolNumbers Method (Block Object)

RepositionAttributesAsOnSymbol Method (Block

SetZSheetSize Method (Block Object)

UpdateBorder Method (Block Object)

Application Property (Block Object)

Attributes Property (Block Object)

DataType Property (Block Object)

IsFub Property (Block Object)

LibraryName Property (Block Object)

OpenMode Property (Block Object)

Parent Property (Block Object)

SheetNum Property (Block Object)

SheetSize Property (Block Object)

SymbolType Property (Block Object)

Type Property (Block Object)

GetLocation Method (Box Object)

GetObjectColor Method (Box Object)

GetObjectFillColor Method (Box Object)

IsColorAutomatic Method (Box Object)

IsFillColorAutomatic Method (Box Object)

SetAutomaticColor Method (Box Object)

SetAutomaticFillColor Method (Box Object)

SetLocation Method (Box Object)

SetObjectColor Method (Box Object)

SetObjectFillColor Method (Box Object)

Application Property (Box Object)

FillStyle Property (Box Object)

LineStyle Property (Box Object)

Parent Property (Box Object)

Selected Property (Box Object)

Type Property (Box Object)

b Property (CColor Object)

g Property (CColor Object)

r Property (CColor Object)

GetCenter Method (Circle Object)

GetObjectColor Method (Circle Object)

GetObjectFillColor Method (Circle Object)

IsColorAutomatic Method (Circle Object)

IsFillColorAutomatic Method (Circle Object)

SetAutomaticColor Method (Circle Object)

SetAutomaticFillColor Method (Circle Object)

SetCenter Method (Circle Object)

SetObjectColor Method (Circle Object)

SetObjectFillColor Method (Circle Object)

Application Property (Circle Object)

FillStyle Property (Circle Object)

LineStyle Property (Circle Object)

Parent Property (Circle Object)

Radius Property (Circle Object)

Selected Property (Circle Object)

Type Property (Circle Object)

CommandsManager Object

CommandDisable Method (CommandsManager Object)

CommandEnable Method (CommandsManager Object)

CommandRemove Method (CommandsManager Object)

ExecuteCommand Method (CommandsManager Object)

ExecuteMenuCommand Method (CommandsManager

RegisterOLECommand Method (CommandsManager

UnregisterOLECommand Method (CommandsManager

Component Object

AddAttribute Method (Component Object)

AddBatchAttributes Method (Component Object)

AddBatchOats Method (Component Object)

AddLabel Method (Component Object)

AddOat Method (Component Object)

FindAttribute Method (Component Object)

GetBatchAttributes Method (Component Object)

GetBatchOats Method (Component Object)

GetBboxPoint Method (Component Object)

GetConnections Method (Component Object)

GetForwardPCB Method (Component Object)

GetLocation Method (Component Object)

GetName Method (Component Object)

SetLocation Method (Component Object)

Application Property (Component Object)

Attributes Property (Component Object)

Id Property (Component Object)

Label Property (Component Object)

Orientation Property (Component Object)

Parent Property (Component Object)

Refdes Property (Component Object)

Scale Property (Component Object)

Selected Property (Component Object)

SymbolBlock Property (Component Object)

Type Property (Component Object)

UID Property (Component Object)

ComponentPin Object

AddAttribute Method (ComponentPin Object)

AddOAT Method (ComponentPin Object)

FindAttribute Method (ComponentPin Object)

GetLocation Method (ComponentPin Object)

Application Property (ComponentPin Object)

Attributes Property (ComponentPin Object)

Component Property (ComponentPin Object)

Connection Property (ComponentPin Object)

Number Property (ComponentPin Object)

Parent Property (ComponentPin Object)

Pin Property (ComponentPin Object)

Selected Property (ComponentPin Object)

Side Property (ComponentPin Object)

Type Property (ComponentPin Object)

Connection Object

CompPin Property (Connection Object)

Net Property (Connection Object)

Ripper Property (Connection Object)

Segment Property (Connection Object)

HDLSourceDocument Object

BookmarkLine Method (HDLSourceDocument Object)

GotoLine Method (HDLSourceDocument Object)

Name Property (HDLSourceDocument Object)

Path Property (HDLSourceDocument Object)

GetLocation Method (Label Object)

GetObjectColor Method (Label Object)

IsColorAutomatic Method (Label Object)

SetAutomaticColor Method (Label Object)

SetLocation Method (Label Object)

SetObjectColor Method (Label Object)

Application Property (Label Object)

Font Property (Label Object)

Orientation Property (Label Object)

Origin Property (Label Object)

Parent Property (Label Object)

ResolvedName Property (Label Object)

Scope Property (Label Object)

Selected Property (Label Object)

Sense Property (Label Object)

Size Property (Label Object)

TextString Property (Label Object)

Type Property (Label Object)

Visible Property (Label Object)

AddPoint Method (Line Object)

GetNumPoints Method (Line Object)

GetObjectColor Method (Line Object)

GetObjectFillColor Method (Line Object)

GetPoint Method (Line Object)

IsColorAutomatic Method (Line Object)

IsFillColorAutomatic Method (Line Object)

SetAutomaticColor Method (Line Object)

SetAutomaticFillColor Method (Line Object)

SetObjectColor Method (Line Object)

SetObjectFillColor Method (Line Object)

Application Property (Line Object)

LineStyle Property (Line Object)

Parent Property (Line Object)

Selected Property (Line Object)

Type Property (Line Object)

AddAttribute Method (Net Object)

AddLabel Method (Net Object)

Connections Method (Net Object)

FindAttribute Method (Net Object)

GetConnectedLabel Method (Net Object)

GetConnectedNetName Method (Net Object)

GetLabel Method (Net Object)

GetObjectColor Method (Net Object)

GetRippers Method (Net Object)

GetSegments Method (Net Object)

GetSignals Method (Net Object)

GetSingleJointLocs Method (Net Object)

IsColorAutomatic Method (Net Object)

IsSegmentSelected Method (Net Object)

SelectSegment Method (Net Object)

SelectSegmentByJointLoc Method (Net Object)

SetAutomaticColor Method (Net Object)

SetObjectColor Method (Net Object)

Application Property (Net Object)

Attributes Property (Net Object)

Id Property (Net Object)

LineStyle Property (Net Object)

Parent Property (Net Object)

Selected Property (Net Object)

Type Property (Net Object)

UID Property (Net Object)

PDBPartitions Object

AppendPDBPartition Method (PDBPartitions Object)

GetPDBPartition Method (PDBPartitions Object)

GetPDBPartitionsArray Method (PDBPartitions

InsertPDBPartition Method (PDBPartitions Object)

PDBPartitionExists Method (PDBPartitions Object)

RemovePDBPartitionByIndex Method (PDBPartitions

RemovePDBPartitionByName Method (PDBPartitions

AddAttribute Method (Pin Object)

AddLabel Method (Pin Object)

FindAttribute Method (Pin Object)

GetLocation Method (Pin Object)

GetName Method (Pin Object)

GetObjectColor Method (Pin Object)

SetLocation Method (Pin Object)

Application Property (Pin Object)

Attributes Property (Pin Object)

Id Property (Pin Object)

Label Property (Pin Object)

Parent Property (Pin Object)

Selected Property (Pin Object)

Sense Property (Pin Object)

Side Property (Pin Object)

Type Property (Pin Object)

UID Property (Pin Object)

X Property (Point Object)

Y Property (Point Object)

ProjectData Object

AddiCDBDesign Method (ProjectData Object)

GetBordersFilePath Method (ProjectData Object)

GetBusContentsFilePath Method (ProjectData

GetiCDBDesignRootBlock Method (ProjectData

GetiCDBDesigns Method (ProjectData Object)

GetiCDBDesignType Method (ProjectData Object)

GetiCDBDiscardFilePath Method (ProjectData

GetPCBDesignPath Method (ProjectData Object)

GetPDBPartitions Method (ProjectData Object)

GetPinComponentsFilePath Method (ProjectData

GetProjectFilePath Method (ProjectData Object)

GetProjectName Method (ProjectData Object)

GetProjectPath Method (ProjectData Object)

GetSearchPathScheme Method (ProjectData Object)

GetSymbolPartitions Method (ProjectData Object)

RemoveiCDBDesign Method (ProjectData Object)

RenameiCDBDesign Method (ProjectData Object)

SetBordersFilePath Method (ProjectData Object)

SetBusContentsFilePath Method (ProjectData

SetiCDBDesignRootBlock Method (ProjectData

SetiCDBDesignType Method (ProjectData Object)

SetiCDBDiscardFilePath Method (ProjectData

SetPCBDesignPath Method (ProjectData Object)

SetPinComponentsFilePath Method (ProjectData

SetSearchPathScheme Method (ProjectData Object)

UpdateOtherObjects Method (ProjectData Object)

CentralLibraryPath Property (ProjectData Object)

iCDBDir Property (ProjectData Object)

Bottom Property (Rect Object)

Left Property (Rect Object)

Right Property (Rect Object)

Top Property (Rect Object)

GetConnectedObject Method (Ripper Object)

GetConnectedObjects Method (Ripper Object)

GetMappedSignal Method (Ripper Object)

SchematicSheetDocument Object

Activate Method (SchematicSheetDocument Object)

Close Method (SchematicSheetDocument Object)

DiscardSymbolChanges Method (SchematicSheetDocument Object)

ExportMetafile Method (SchematicSheetDocument

GetViews Method (SchematicSheetDocument Object)

IsReadOnly Method (SchematicSheetDocument Object)

Print Method (SchematicSheetDocument Object)

ReRead Method (SchematicSheetDocument Object)

Save Method (SchematicSheetDocument Object)

SaveAs Method (SchematicSheetDocument Object)

UpdateSymbolInDesign Method (SchematicSheetDocument Object)

Application Property (SchematicSheetDocument

FullName Property (SchematicSheetDocument Object)

Name Property (SchematicSheetDocument Object)

Parent Property (SchematicSheetDocument Object)

GetJointType Method (Segment Object)

IsBus Method (Segment Object)

Location Method (Segment Object)

Application Property (Segment Object)

Attributes Property (Segment Object)

Parent Property (Segment Object)

Type Property (Segment Object)

SymbolPartitions Object

AppendSymbolPartition Method (SymbolPartitions

GetSymbolPartition Method (SymbolPartitions

GetSymbolPartitionsArray Method (SymbolPartitions

GetSymbolPartitionsCount Method (SymbolPartitions

InsertSymbolPartition Method (SymbolPartitions

RemoveSymbolPartitionByIndex Method (SymbolPartitions

RemoveSymbolPartitionByName Method (SymbolPartitions

SymbolPartitionExists Method (SymbolPartitions

GetLocation Method (Text Object)

GetObjectColor Method (Text Object)

IsColorAutomatic Method (Text Object)

SetAutomaticColor Method (Text Object)

SetLocation Method (Text Object)

SetObjectColor Method (Text Object)

Application Property (Text Object)

Font Property (Text Object)

Orientation Property (Text Object)

Origin Property (Text Object)

Parent Property (Text Object)

Selected Property (Text Object)

Size Property (Text Object)

TextString Property (Text Object)

Type Property (Text Object)

Activate Method (View Object)

AddAttributeMoveMode Method (View Object)

Application Method (View Object)

BufferCopy Method (View Object)

BufferCut Method (View Object)

BufferPaste Method (View Object)

BufferPasteXY Method (View Object)

ComputeMBB Method (View Object)

Document Method (View Object)

GetJointLocs Method (View Object)

GetName Method (View Object)

GetSelectedNetName Method (View Object)

GetTopLevelDesignName Method (View Object)

ModifyVisibility Method (View Object)

Query Method (View Object)

Refresh Method (View Object)

SelectbyName Method (View Object)

SelectbyName2 Method (View Object)

SelectObject Method (View Object)

SelectSegmentByJointLoc Method (View Object)

SelectText Method (View Object)

SetCenter Method (View Object)

ViewFull Method (View Object)

ZoomIn Method (View Object)

ZoomOut Method (View Object)

ZoomSelect Method (View Object)

Block Property (View Object)

TopBlock Property (View Object)

Viewport Property (View Object)

OnActivate Event (View Object)

OnSelect Event (View Object)

Viewport Object

Arc Method (Viewport Object)

Arrow Method (Viewport Object)

Box Method (Viewport Object)

Circle Method (Viewport Object)

Ellipse Method (Viewport Object)

EraseRectangle Method (Viewport Object)

GetObjectColor Method (Viewport Object)

Line Method (Viewport Object)

PixelRectangle Method (Viewport Object)

PixelToUser Method (Viewport Object)

Point Method (Viewport Object)

PolyLine Method (Viewport Object)

SetClipRectangle Method (Viewport Object)

SetObjectColor Method (Viewport Object)

Spline Method (Viewport Object)

Text Method (Viewport Object)

UserRectangle Method (Viewport Object)

UserToPixel Method (Viewport Object)

FillStyle Property (Viewport Object)

LineCap Property (Viewport Object)

LineJoin Property (Viewport Object)

LinePattern Property (Viewport Object)

LineThickness Property (Viewport Object)

RasterMode Property (Viewport Object)

TextAngle Property (Viewport Object)

TextFont Property (Viewport Object)

TextSize Property (Viewport Object)

Xpedition Designer Schematic Editor Object Collections

HDLSourceDocuments Collection

Item Method (HDLSourceDocuments Collection)

New Method (HDLSourceDocuments Collection)

Open Method (HDLSourceDocuments Collection)

Remove Method (HDLSourceDocuments Collection)

RemoveAll Method (HDLSourceDocuments Collection)

SaveAll Method (HDLSourceDocuments Collection)

Count Property (HDLSourceDocuments Collection)

SchematicSheetDocuments Collection

Close Method (SchematicSheetDocuments Collection)

CopyToClipboard Method (SchematicSheetDocuments

DeleteSheet Method (SchematicSheetDocuments

GetAvailableSchematics Method (SchematicSheetDocuments

GetAvailableSheets Method (SchematicSheetDocuments

InsertSheet Method (SchematicSheetDocuments

IsSymbolUnderEdit Method (SchematicSheetDocuments Collection)

Item Method (SchematicSheetDocuments Collection)

Open Method (SchematicSheetDocuments Collection)

Open_Hierarchically Method (SchematicSheetDocuments

OpenSymbol Method (SchematicSheetDocuments Collection)

PasteFromClipboard Method (SchematicSheetDocuments

Application Property (SchematicSheetDocuments

Count Property (SchematicSheetDocuments Collection)

Parent Property (SchematicSheetDocuments Collection)

StringCollection Collection

Item Method (StringCollection Collection)

Remove Method (StringCollection Collection)

Count Property (StringCollection Collection)

StringList Collection

Append Method (StringList Collection)

Clear Method (StringList Collection)

GetCount Method (StringList Collection)

GetItem Method (StringList Collection)

Insert Method (StringList Collection)

Remove Method (StringList Collection)

Xpedition Designer Schematic Editor Enumerated Types

Xpedition Designer Enumerated Types Summary

DesignerErrCode Enum

PinMappingType Enum

PropertyMappingType Enum

ScopeReplaceSymbol Enum

VdAllOrSelected Enum

VdAnnoObject Enum

VdAppEventDispatchID Enum

VdArcPoint Enum

VdArrowType Enum

VdBusOrWire Enum

VdCompInstanceForwardPCB Enum

VdCreateTime Enum

VdDataType Enum

VdDocumentAccess Enum

VdFillStyle Enum

VdGradientType Enum

VdJointType Enum

VdLabelVisibility Enum

VdLineJoin Enum

VdLinePattern Enum

VdLineStyle Enum

VdNameType Enum

VdNotifyFlag Enum

VdObjectClass Enum

VdObjectType Enum

VdObjectTypeMask Enum

VdOpenMode Enum

VdOrientation Enum

VdParamMode Enum

VdParamValue Enum

VdPEFlowMode Enum

VdPinEndType Enum

VdRasterop Enum

VdSegmentEndType Enum

VdSelectionType Enum

VdSheetSize Enum

VdSilentMode Enum

VdSourceDocumentType Enum

VdSplineOrder Enum

VdSplineType Enum

VdSymbolType Enum

VdTextFlags Enum

VdUpdateOOScope Enum

VdUpdateOtherObjects Enum

VdVisibilityFlag Enum

VdWhichJoint Enum

Scripting with DataBook

DataBook Objects

Attribute Object

Name Property (Attribute Object)

NameVisible Property (Attribute Object)

Value Property (Attribute Object)

ValueVisible Property (Attribute Object)

Attributes Object

Add Method (Attributes Object)

Count Property (Attributes Object)

Component Object

Attributes Property (Component Object)

Instances Property (Component Object)

Library Property (Component Object)

Properties Property (Component Object)

Symbol Property (Component Object)

Components Object

Count Property (Components Object)

Item Method (Components Object)

Application_AddComponent Event

Application_AfterAddComponent Event

Application_AfterAnnotateComponent Event

Application_AnnotateComponent Event

Application_LoadComponent Event

Property Object

Item Method (Property Object)

Remove Method (Property Object)

Application_SelectComponent Event

Application_ViewDocument Event

Configuring the DataBook Script

Changes to Xpedition Designer Automation

Changes to Objects

Removed Objects

Changes to the Application Object

Changes to the Block Object

Changes to the Arc Object

Changes to the Attribute Object

Changes to the Box Object

Changes to the Circle Object

Changes to the Component Object

Changes to the Connection Object

Changes to the Label Object

Changes to the Line Object

Changes to the Net Object

Changes to the Pin Object

Changes to the Ripper Object

Changes to the Text Object

Changes to the Viewport Object

Changes to Enumerated Types

Removed Enumerated Types

Changes to the VdAppEventDispatchID Enumerated Type

Changes to the VdDocumentAccess Enumerated Type

Changes to the VdNotifyFlag Enumerated Type

Changes to the VdObjectClass Enumerated Type

Changes to the VdObjectType Enumerated Type

Changes to the VdObjectTypeMask Enumerated Type

Third-Party Information