WorkspaceManager_Cmd-OpenObjectOpenObject_AD

Applied Parameters: ObjectKind=NewAnything

Summary

This command is used to display the Files panel, from where you can open existing projects and documents, or create new ones.

Access

This command can be accessed by:

• Choosing the File » New » Other command, from an editor's main menus.
• Clicking the  button on an editor's main toolbar.
• Using the Ctrl+N keyboard shortcut.
• Choosing the Project » Add New To Project » Other command, from an editor's main menus.
• Choosing the Project » Design Workspace » Add New Project » Other command, from an editor's main menus.
• From the Projects panel, right-clicking on the entry for the project and choosing the Add New To Project » Other command, from the context menu.
• From the Projects panel, with the required project focused, clicking the Project button, then choosing the Add New To Project » Other command, from the context menu.
• From the Projects panel, clicking the Workspace button, then choosing the Add New Project » Other command, from the context menu.

Use

After launching the command, the Files panel will be made the active panel - if it is currently open in a group of docked panels - or opened if it is not currently visible. Use the panel to select whether to open an existing project or document, or to create a new one.

Tips

1. If the Files panel is already open, but is in floating mode, the command will have no effect.
2. Clicking on any of the project entries in the New From Template region of the Files panel will access the New Project dialog, populated with the relevant information applicable to the chosen project type. This dialog provides a powerful, yet intuitive interface, that caters for the creation of any of the project types supported by Altium Designer. As well as creating the new project file on the hard drive, the dialog supports adding the new project to version control, or creating it as a managed project.
3. The Files panel is the only means of accessing the PCB Board Wizard, providing a streamlined utility by which to create a new PCB document.

Applied Parameters: ObjectKind=NewAnything|Kind=SCH

Summary

This command is used to create a new schematic document. The electronic circuit is captured across one or more schematic sheets, built up from libraries of component symbols which are placed and wired together.

Access

This command is accessed from any editor by choosing the File » New » Schematic command, from the main menus.

Use

First, ensure that the project that you wish to add the new document to, is either the active project - by having one of its existing documents open as the active document - or, if no documents are currently open, is the focused project in the Projects panel.

After launching the command, a new schematic document (Sheet1.SchDoc) will be created and opened as the active document in the main design window. The project will be added as an additional source document, to the active (or focused) project.

Tips

1. If no projects are currently open, or if the active document is a free document, the new document will be opened as a free document.
2. If a default document has been specified on the System - New Document Defaults page of the Preferences dialog, the schematic will be created using that default as a template. A different default can be assigned, for a schematic created as part of a PCB project, FPGA project, Core project, or created as a free document.
3. The document is initially unsaved.

Applied Parameters: ObjectKind=NewAnything|Kind=DefaultPcb

Summary

This command is used to create a new PCB document. The PCB provides the mechanical mounting for the electronic components that make up the design, as well as the electrical connections between them.

Access

This command is accessed from any editor by choosing the File » New » PCB command, from the main menus.

Use

First, ensure that the project that you wish to add the new document to, is either the active project - by having one of its existing documents open as the active document - or, if no documents are currently open, is the focused project in the Projects panel.

After launching the command, a new PCB document (PCB1.PcbDoc) will be created and opened as the active document in the main design window. The project will be added as an additional source document, to the active (or focused) project. The document will contain a default board shape, sized 6,000 x 4,000 mils.

Tips

1. If no projects are currently open, or if the active document is a free document, the new document will be opened as a free document.
2. If a default document has been specified on the System - New Document Defaults page of the Preferences dialog, the PCB will be created using that default as a template. A different default can be assigned, for a PCB created as part of a PCB project, or created as a free document.
3. The document is initially unsaved.

Applied Parameters: ObjectKind=NewAnything|Kind=SCHLIB

Summary

This command is used to create a new Schematic Library document. A Schematic Library can contain one or more schematic symbols and their respective links (can be thought of as a pointer only but not the actual model itself) to any model definitions that reside in separate model libraries.

Access

This command is accessed from any editor by choosing the File » New » Library » Schematic Library command, from the main menus.

Use

First, ensure that the project that you wish to add the new document to, is either the active project - by having one of its existing documents open as the active document - or, if no documents are currently open, is the focused project in the Projects panel.

After launching the command, a new schematic library document (Schlib1.SchLib) will be created and opened as the active document in the main design window. The document contains a default component, Component_1, added to the Components list of the SCH Library panel and opened ready for editing.

Tips

1. If no projects are currently open, or if the active document is a free document, the new document will be opened as a free document.
2. If a default document has been specified on the System - New Document Defaults page of the Preferences dialog, the Schematic Library will be created using that default as a template. A different default can be assigned, for a Schematic Library created as part of a PCB project, FPGA project, Core project, Integrated Library Package, or created as a free document.
3. The document is initially unsaved.

Applied Parameters: ObjectKind=NewAnything|Kind=DefaultPcbLib

Summary

This command is used to create a new PCB Library document. A PCB Library is used to store one or more footprint models (or rather, 2D/3D component models, since each model can comprise a 2D footprint and any additional 3D body information).

Access

This command is accessed from any editor by choosing the File » New » Library » PCB Library command, from the main menus.

Use

First, ensure that the project that you wish to add the new document to, is either the active project - by having one of its existing documents open as the active document - or, if no documents are currently open, is the focused project in the Projects panel.

After launching the command, a new PCB library document (PcbLib1.PcbLib) will be created and opened as the active document in the main design window. The document contains a default component, PCBCOMPONENT_1, added to the Components list of the PCB Library panel and opened ready for editing.

Tips

1. If no projects are currently open, or if the active document is a free document, the new document will be opened as a free document.
2. If a default document has been specified on the System - New Document Defaults page of the Preferences dialog, the PCB Library will be created using that default as a template. A different default can be assigned, for a PCB Library created as part of a PCB project, Integrated Library Package, or created as a free document.
3. The document is initially unsaved.

Applied Parameters: ObjectKind=NewAnything|Kind=PvLib

Summary

This command is used to create a new Pad Via Library document. A Pad Via Library is used to store one or more defined pad and/or via templates, for quick reuse in designs.

Access

This command is accessed from any editor by choosing the File » New » Library » Pad Via Library command, from the main menus.

Use

First, ensure that the project that you wish to add the new document to, is either the active project - by having one of its existing documents open as the active document - or, if no documents are currently open, is the focused project in the Projects panel.

After launching the command, a new Pad Via library document (PvLib1.PvLib) will be created and opened as the active document in the main design window.

Tips

1. If no projects are currently open, or if the active document is a free document, the new document will be opened as a free document.
2. The document will be empty - use the associated Pad Via Library panel to add new Pad and/or Via templates.
3. The document is initially unsaved.

Applied Parameters: ObjectKind=NewAnything|Kind=PCB3DLIB

Summary

This command is used to create a new PCB3D Library document.

Access

This command is accessed from any editor by choosing the File » New » Library » PCB3D Library command, from the main menus.

Use

First, ensure that the project that you wish to add the new document to, is either the active project - by having one of its existing documents open as the active document - or, if no documents are currently open, is the focused project in the Projects panel.

After launching the command, a new PCB3D library document (PCB3DViewLib1.PCB3DLib) will be created and opened as the active document in the main design window.

Tips

1. If no projects are currently open, or if the active document is a free document, the new document will be opened as a free document.
2. If a default document has been specified on the System - New Document Defaults page of the Preferences dialog, the PCB3D Library will be created using that default as a template. A default can be assigned, only for a PCB3D Library created as a free document.
3. The document is initially unsaved.

Applied Parameters: ObjectKind=NewAnything|Kind=CmpLib

Summary

This command is used to create a new Component Library document. A single Component Library file can be used to create (and therefore map to) one or more unique Component Items in a target Altium Vault, by entering one or more component definitions. Each component definition will have a common set of parameters and links to required domain models.

Access

This command is accessed from any editor by choosing the File » New » Library » Component Library command, from the main menus.

Use

First, ensure that the project that you wish to add the new document to, is either the active project - by having one of its existing documents open as the active document - or, if no documents are currently open, is the focused project in the Projects panel.

After launching the command, a new Component library document (CmpLib1.CmpLib) will be created and opened as the active document in the main design window.

Tips

1. If no projects are currently open, or if the active document is a free document, the new document will be opened as a free document.
2. If a default document has been specified on the System - New Document Defaults page of the Preferences dialog, the Component Library will be created using that default as a template. A different default can be assigned, for a Component Library created as part of a PCB project, FPGA project, Core project, Integrated Library Package, or created as a free document.
3. The document is initially unsaved.

Applied Parameters: ObjectKind=NewAnything|Kind=TEXT

Summary

This command is used to create a new Text document.

Access

This command is accessed from any editor by choosing the File » New » Text Document command, from the main menus.

Use

First, ensure that the project that you wish to add the new document to, is either the active project - by having one of its existing documents open as the active document - or, if no documents are currently open, is the focused project in the Projects panel.

After launching the command, a new Text document (Doc1.Txt) will be created and opened as the active document in the main design window.

Tips

1. If no projects are currently open, or if the active document is a free document, the new document will be opened as a free document.
2. The document is initially unsaved.

Applied Parameters: ObjectKind=NewAnything|Kind=OutputJob

Summary

This command is used to create a new Output Job Configuration file. An OutJob (as it is commonly known) is simply a pre-configured set of outputs. Each output is configured with its own settings and its own output format, for example output to a file, or to a printer. OutJobs are very flexible - they can include as many or as few outputs as required, and any number of OutJobs can be included in an Altium Designer project. The best approach is to use one OutJob to configure all outputs required for each specific type of output being generated from the project. For example all outputs required to fabricate the bare board go in one OutJob, all outputs required to assemble the board go into a second OutJob, and so on. OutJobs can also hold validation-type checks, such as ERC and DRC reports - useful for a final 'thumbs up' check just before generating the outputs, such reports can then be held as a record that the design was ready for release.

Portable in nature, OutJobs can also be re-used between designs - simply copy the Output Job file from one project to the next one, and reset the Data Source as required.

Access

This command is accessed from any editor by choosing the File » New » Output Job File command, from the main menus.

Use

First, ensure that the project that you wish to add the new document to, is either the active project - by having one of its existing documents open as the active document - or, if no documents are currently open, is the focused project in the Projects panel.

After launching the command, a new Output Job Configuration file (Job1.OutJob) will be created and opened as the active document in the main design window.

Tips

1. If no projects are currently open, or if the active document is a free document, the new document will be opened as a free document.
2. If a default document has been specified on the System - New Document Defaults page of the Preferences dialog, the Output Job file will be created using that default as a template. A different default can be assigned, for an Output Job file created as part of a PCB project, or created as a free document.
3. The document is initially unsaved.

Applied Parameters: ObjectKind=NewAnything|Kind=DatabaseLib

Summary

This command is used to create a new Database Library document. Database Libraries provide the ability to place components directly from an external company database. In a database library, all the detail that makes the component complete is stored in the database itself - each record in the database thus represents a component, storing all of the parameters along with model links, datasheet references, or other component information. The record can include links to inventory or other corporate component data. When a component is placed from a database library, its parameter and model information is created on-the-fly, using the corresponding fields in the matched database record and in accordance with defined mapping in the intermediary link file. One or more of these parameters will then be used to maintain an ongoing link back to the database, enabling future design synchronization after placement.

Access

This command is accessed from any editor by choosing the File » New » Library » Database Library command, from the main menus.

Use

First, ensure that the project that you wish to add the new document to, is either the active project - by having one of its existing documents open as the active document - or, if no documents are currently open, is the focused project in the Projects panel.

After launching the command, a new Database library document (Database_Libs1.DbLib) will be created and opened as the active document in the main design window.

Tips

1. If no projects are currently open, or if the active document is a free document, the new document will be opened as a free document.
2. If a default document has been specified on the System - New Document Defaults page of the Preferences dialog, the Database Library will be created using that default as a template. A different default can be assigned, for a Database Library created as part of a PCB project, Integrated Library Package, or created as a free document.
3. The document is initially unsaved.

Applied Parameters: ObjectKind=NewAnything|Kind=SVNDatabaseLib

Summary

This command is used to create a new SVN Database Library document. An SVN Database Library takes the ability to place components directly from a database, and extends this method of linking to allow source-controlled libraries - housing the schematic symbols and footprint models within a Subversion-based repository. The link to the repository and to the external database is defined within an SVN Database Library file (*.SVNDbLib), an extension of the Database Library file (*.DBLib) and often referred to as a Version-Controlled Database Library.

Access

This command is accessed from any editor by choosing the File » New » Library » SVN Database Library command, from the main menus.

Use

First, ensure that the project that you wish to add the new document to, is either the active project - by having one of its existing documents open as the active document - or, if no documents are currently open, is the focused project in the Projects panel.

After launching the command, a new SVN Database library document (SVNDatabase_Libs1.SVNDbLib) will be created and opened as the active document in the main design window.

Tips

1. If no projects are currently open, or if the active document is a free document, the new document will be opened as a free document.
2. The document is initially unsaved.

Applied Parameters: ObjectKind=NewAnything|Kind=DatabaseLink

Summary

This command is used to create a new Database Link file. This file provides an efficient means of linking and keeping the components used in your design (or libraries) synchronized with the data entered in the external database declared in the link file.

Access

This command is accessed from any editor by choosing the File » New » Database Link File command, from the main menus.

Use

First, ensure that the project that you wish to add the new document to, is either the active project - by having one of its existing documents open as the active document - or, if no documents are currently open, is the focused project in the Projects panel.

After launching the command, a new Database Link file (Database_Links1.DbLink) will be created and opened as the active document in the main design window.

Tips

1. If no projects are currently open, or if the active document is a free document, the new document will be opened as a free document.
2. If a default document has been specified on the System - New Document Defaults page of the Preferences dialog, the Database Link file will be created using that default as a template. A different default can be assigned, for a Database Link file created as part of a PCB project, Integrated Library Package, or created as a free document.
3. The document is initially unsaved.

Applied Parameters: ObjectKind=NewAnything|Kind=SIMModel

Summary

This command is used to create a new SimModel file. This type of file is used to contain a simulation model definition, which is then mapped to a Simulation Model Item in an Altium Vault. Each release of the file stores the model data into a new revision of that Item.

Access

This command is accessed from any editor by choosing the File » New » Library » SimModel File command, from the main menus.

Use

First, ensure that the project that you wish to add the new document to, is either the active project - by having one of its existing documents open as the active document - or, if no documents are currently open, is the focused project in the Projects panel.

After launching the command, a new SimModel file (SimModel1.SimModel) will be created and opened as the active document in the main design window.

Tips

1. If no projects are currently open, or if the active document is a free document, the new document will be opened as a free document.
2. The document is initially unsaved.

Applied Parameters: ObjectKind=NewAnything|Kind=CAMTastic

Summary

This command is used to create a new CAM document.

Access

This command is accessed from any editor by choosing the File » New » CAM Document command, from the main menus.

Use

First, ensure that the project that you wish to add the new document to, is either the active project - by having one of its existing documents open as the active document - or, if no documents are currently open, is the focused project in the Projects panel.

After launching the command, a new CAM document (CAMtastic1.Cam) will be created and opened as the active document in the main design window.

Tips

1. If no projects are currently open, or if the active document is a free document, the new document will be opened as a free document.
2. If a default document has been specified on the System - New Document Defaults page of the Preferences dialog, the CAM document will be created using that default as a template. A different default can be assigned, for a CAM document created as part of a PCB project, or created as a free document.
3. The document is initially unsaved.

Applied Parameters: ObjectKind=NewAnything|Kind=PcbProject

Summary

This command is used to create a new PCB project - the set of design documents required to manufacture a printed circuit board. The electronic circuit is captured as a schematic, built up from libraries of component symbols which are placed and wired together. The design is transferred to the PCB editor where each component is instantiated as a footprint (pattern) and the circuit wiring becomes point-to-point connection lines. A shape for the final PCB is defined, along with the physical layers the board will include. Design rules specify the layout requirements, such as routing widths and clearance. The components are positioned within the board shape and the connection lines are then replaced by routing, either manually or automatically. When the design is complete, standard format output files are generated which can be used to fabricate the blank board, configure an assembly machine, and so on.

Access

This command is accessed from the Projects panel by clicking the Workspace button, then choosing the Add New Project » PCB Project command, from the context menu.

Use

After launching the command, a new PCB project (PCB_Project1.PrjPcb) will be created and opened as the focused project in the Projects panel. The project will initially be empty, as reflected by the No Documents Added sub-folder.

Tips

1. If a default PCB project has been specified on the System - New Document Defaults page of the Preferences dialog, the new PCB project will be created using that default as a template.
2. The project is initially unsaved. When saving, the default location for new projects is defined as the entry for the Document Path, on the System - Default Locations page of the Preferences dialog. This is \Users\Public\Documents\Altium, for a default installation of the software.

Applied Parameters: ObjectKind=NewAnything|Kind=IntegratedLibrary

Summary

This command is used to create a new Integrated Library Package - the set of design documents required to produce an integrated library. Schematic symbols are drawn in a library editor, and model references defined. Referenced models can include PCB footprints, circuit simulation models, signal integrity models and three-dimensional mechanical models. Files that contain the models are added to the Integrated Library Package (*.LibPkg), or search paths are defined to identify their location. The source schematic symbol libraries and required models are then compiled into a single file, referred to as an Integrated Library.

Access

This command is accessed from the Projects panel by clicking the Workspace button, then choosing the Add New Project » Integrated Library command, from the context menu.

Use

After launching the command, a new Integrated Library Package (Integrated_Library1.LibPkg) will be created and opened as the focused project in the Projects panel. The project will initially be empty, as reflected by the No Documents Added sub-folder.

Tips

1. If a default Integrated Library Package has been specified on the System - New Document Defaults page of the Preferences dialog, the new Integrated Library Package will be created using that default as a template.
2. The project is initially unsaved. When saving, the default location for new projects is defined as the entry for the Document Path, on the System - Default Locations page of the Preferences dialog. This is \Users\Public\Documents\Altium, for a default installation of the software.

Applied Parameters: ObjectKind=NewAnything|Kind=ScriptProject

Summary

This command is used to create a new Script project - the set of design documents that stores one or more Altium Designer scripts. A set of instructions that are interpreted whenever a script is executed in Altium Designer. The scripts are written and debugged in the same environment. There are two types of scripts - script units and script forms. A Script unit can use the Application Programming Interface (API) to modify design objects on a design document. A script form hosts controls, as well as using the API to a provide script dialog that act on design documents open in Altium Designer.

Access

This command is accessed from the Projects panel by clicking the Workspace button, then choosing the Add New Project » Script Project command, from the context menu.

Use

After launching the command, a new Script project (Script_Project1.PrjScr) will be created and opened as the focused project in the Projects panel. The project will initially be empty, as reflected by the No Documents Added sub-folder.

Tips

1. If a default Script project has been specified on the System - New Document Defaults page of the Preferences dialog, the new Script project will be created using that default as a template.
2. The project is initially unsaved. When saving, the default location for new projects is defined as the entry for the Document Path, on the System - Default Locations page of the Preferences dialog. This is \Users\Public\Documents\Altium, for a default installation of the software.

Applied Parameters: ObjectKind=NewAnything|Kind=BOM

Summary

This command is used to create a new BOM document. This is the user interface to Altium Designer's ActiveBOM system. ActiveBOM offers a live presentation of the design from the outset, providing early and ongoing cost estimation. It allows you to define target pricing at the individual item level. You can then track how actual costing fares against these estimates, and so give a timely flag if any cost blow-outs are on the near horizon! In addition, you can quickly assess item availability, complete with notification if there is a risk in the supply of a chosen part.

Access

This command is accessed from any editor by choosing the File » New » BOM Document command, from the main menus.

Use

First, ensure that the project that you wish to add the new document to, is either the active project - by having one of its existing documents open as the active document - or, if no documents are currently open, is the focused project in the Projects panel.

After launching the command, a new BOM document (BOM1.BomDoc) will be created and opened as the active document in the main design window.

Tips

1. If no projects are currently open, or if the active document is a free document, the new document will be opened as a free document.
2. The document is initially unsaved.
3. Only a single BOM document can be added to a board design project.

Applied Parameters: ObjectKind=NewAnything|Kind=PcbDrawing|Source=Rcs

Summary

This command is used to create a new Draftsman document. A Draftsman document (*.PCBDwf) is a multi-sheet format file, which allows it to contain individual pages (sheets) that are assigned to particular types of board project production information.

Access

This command is accessed from any editor by choosing the File » New » Draftsman Document command, from the main menus.

Use

First, ensure that the project that you wish to add the new document to, is either the active project - by having one of its existing documents open as the active document - or, if no documents are currently open, is the focused project in the Projects panel.

After launching the command, the New Draftsman Document dialog will appear. The dialog allows for the selection of a predefined Draftsman Document Template (*.DwfDot). Three such templates are provided with the installation. Alternatively, choose the Default option, which will create a blank A4 document. Along with the desired Draftsman Document template, a specific Project and board Source Document can be selected where multiple files are open in Altium Designer. The new document will be associated with, and therefore draw data from, the nominated project, which will become the active project. After setting the creation options as required and clicking OK, the Draftsman document will be created, added to the nominated project, and opened as the active document in the main design window.

Tips

1. The listing of custom Draftsman Document Templates will be those found in the Templates Location, specified on the Draftsman - Templates page of the Preferences dialog. For a default installation of the Draftsman extension, this will be the \ProgramData\Altium\Altium Designer {GUID}\Extensions\Draftsman\Templates folder.
2. A Draftsman Sheet Template (*.DwsDot) can be applied once the new document has been created, through the PcbDrawing Editor's Sheet Properties dialog (Tools » Sheet Properties).
3. If no projects are currently open, or if the active document is a free document, the new document will be opened as a free document.
4. If a default document has been specified on the System - New Document Defaults page of the Preferences dialog, the Draftsman document will be created using that default as a template. A default can only be assigned for a Draftsman document created as part of a PCB project.
5. The document is initially unsaved.

Applied Parameters: ObjectKind=NewAnything|Kind=MDL

Summary

This command is used to create a new Simulation Model file.

Access

This command is accessed from any editor by choosing the File » New » Mixed-Signal Simulation » AdvancedSim Model command, from the main menus.

Use

First, ensure that the project that you wish to add the new document to, is either the active project - by having one of its existing documents open as the active document - or, if no documents are currently open, is the focused project in the Projects panel.

After launching the command, a new Simulation Model file (Model1.MDL) will be created and opened as the active document in the main design window.

Tips

1. If no projects are currently open, or if the active document is a free document, the new document will be opened as a free document.
2. The document is initially unsaved.

Applied Parameters: ObjectKind=NewAnything|Kind=NSX

Summary

This command is used to create a new Simulation Netlist file.

Access

This command is accessed from any editor by choosing the File » New » Mixed-Signal Simulation » AdvancedSim Netlist command, from the main menus.

Use

First, ensure that the project that you wish to add the new document to, is either the active project - by having one of its existing documents open as the active document - or, if no documents are currently open, is the focused project in the Projects panel.

After launching the command, a new Simulation Netlist file (Sim_Netlist1.Nsx) will be created and opened as the active document in the main design window.

Tips

1. If no projects are currently open, or if the active document is a free document, the new document will be opened as a free document.
2. The document is initially unsaved.

Applied Parameters: ObjectKind=NewAnything|Kind=CKT

Summary

This command is used to create a new Simulation Sub-Circuit file.

Access

This command is accessed from any editor by choosing the File » New » Mixed-Signal Simulation » AdvancedSim Netlist command, from the main menus.

Use

First, ensure that the project that you wish to add the new document to, is either the active project - by having one of its existing documents open as the active document - or, if no documents are currently open, is the focused project in the Projects panel.

After launching the command, a new Simulation Sub-Circuit file (Sub_Circuit1.Ckt) will be created and opened as the active document in the main design window.

Tips

1. If no projects are currently open, or if the active document is a free document, the new document will be opened as a free document.
2. The document is initially unsaved.

Applied Parameters: ObjectKind=NewAnything|Kind=EditScriptDSUnit

Summary

This command is used to create a new DelphiScript Unit.

Access

This command is accessed from any editor by choosing the File » New » Script Files » Delphi Script Unit command, from the main menus.

Use

First, ensure that the project that you wish to add the new document to, is either the active project - by having one of its existing documents open as the active document - or, if no documents are currently open, is the focused project in the Projects panel.

After launching the command, a new DelphiScript Unit (EditScript1.pas) will be created and opened as the active document in the main design window.

Tips

1. If no projects are currently open, or if the active document is a free document, the new document will be opened as a free document.
2. If a default document has been specified on the System - New Document Defaults page of the Preferences dialog, the DelphiScript Unit will be created using that default as a template. A default can be assigned for a DelphiScript Unit created as part of a Script project.
3. The document is initially unsaved.

Applied Parameters: ObjectKind=NewAnything|Kind=EditScriptDSForm

Summary

This command is used to create a new DelphiScript Form.

Access

This command is accessed from any editor by choosing the File » New » Script Files » Delphi Script Form command, from the main menus.

Use

First, ensure that the project that you wish to add the new document to, is either the active project - by having one of its existing documents open as the active document - or, if no documents are currently open, is the focused project in the Projects panel.

After launching the command, a new DelphiScript Form (EditScript1.pas) will be created and opened as the active document in the main design window.

Tips

1. If no projects are currently open, or if the active document is a free document, the new document will be opened as a free document.
2. If a default document has been specified on the System - New Document Defaults page of the Preferences dialog, the DelphiScript Form will be created using that default as a template. A default can be assigned for a DelphiScript Form created as part of a Script project.
3. The document is initially unsaved.

Applied Parameters: ObjectKind=NewAnything|Kind=EditScriptVBSUnit

Summary

This command is used to create a new VisualBasic Script Unit.

Access

This command is accessed from any editor by choosing the File » New » Script Files » VB Script Unit command, from the main menus.

Use

First, ensure that the project that you wish to add the new document to, is either the active project - by having one of its existing documents open as the active document - or, if no documents are currently open, is the focused project in the Projects panel.

After launching the command, a new VisualBasic Script Unit (EditScript1.vbs) will be created and opened as the active document in the main design window.

Tips

1. If no projects are currently open, or if the active document is a free document, the new document will be opened as a free document.
2. If a default document has been specified on the System - New Document Defaults page of the Preferences dialog, the VisualBasic Script Unit will be created using that default as a template. A default can be assigned for a VisualBasic Script Unit created as part of a Script project.
3. The document is initially unsaved.

Applied Parameters: ObjectKind=NewAnything|Kind=EditScriptVBSForm

Summary

This command is used to create a new VisualBasic Script Form.

Access

This command is accessed from any editor by choosing the File » New » Script Files » VB Script Form command, from the main menus.

Use

First, ensure that the project that you wish to add the new document to, is either the active project - by having one of its existing documents open as the active document - or, if no documents are currently open, is the focused project in the Projects panel.

After launching the command, a new VisualBasic Script Form (EditScript1.vbs) will be created and opened as the active document in the main design window.

Tips

1. If no projects are currently open, or if the active document is a free document, the new document will be opened as a free document.
2. If a default document has been specified on the System - New Document Defaults page of the Preferences dialog, the VisualBasic Script Form will be created using that default as a template. A default can be assigned for a VisualBasic Script Form created as part of a Script project.
3. The document is initially unsaved.

Applied Parameters: ObjectKind=NewAnything|Kind=EditScriptJSUnit

Summary

This command is used to create a new JavaScript Unit.

Access

This command is accessed from any editor by choosing the File » New » Script Files » Java Script Unit command, from the main menus.

Use

First, ensure that the project that you wish to add the new document to, is either the active project - by having one of its existing documents open as the active document - or, if no documents are currently open, is the focused project in the Projects panel.

After launching the command, a new JavaScript Unit (EditScript1.js) will be created and opened as the active document in the main design window.

Tips

1. If no projects are currently open, or if the active document is a free document, the new document will be opened as a free document.
2. If a default document has been specified on the System - New Document Defaults page of the Preferences dialog, the JavaScript Unit will be created using that default as a template. A default can be assigned for a JavaScript Unit created as part of a Script project.
3. The document is initially unsaved.

Applied Parameters: ObjectKind=NewAnything|Kind=EditScriptJSForm

Summary

This command is used to create a new JavaScript Form.

Access

This command is accessed from any editor by choosing the File » New » Script Files » Java Script Form command, from the main menus.

Use

First, ensure that the project that you wish to add the new document to, is either the active project - by having one of its existing documents open as the active document - or, if no documents are currently open, is the focused project in the Projects panel.

After launching the command, a new JavaScript Form (EditScript1.js) will be created and opened as the active document in the main design window.

Tips

1. If no projects are currently open, or if the active document is a free document, the new document will be opened as a free document.
2. If a default document has been specified on the System - New Document Defaults page of the Preferences dialog, the JavaScript Form will be created using that default as a template. A default can be assigned for a JavaScript Form created as part of a Script project.
3. The document is initially unsaved.

Applied Parameters: ObjectKind=NewAnything|Kind=EditScriptTcl

Summary

This command is used to create a new TCL Script Unit.

Access

This command is accessed from any editor by choosing the File » New » Script Files » TCL Script Unit command, from the main menus.

Use

First, ensure that the project that you wish to add the new document to, is either the active project - by having one of its existing documents open as the active document - or, if no documents are currently open, is the focused project in the Projects panel.

After launching the command, a new TCL Script Unit (EditScript1.tcl) will be created and opened as the active document in the main design window.

Tips

1. If no projects are currently open, or if the active document is a free document, the new document will be opened as a free document.
2. If a default document has been specified on the System - New Document Defaults page of the Preferences dialog, the TCL Script Unit will be created using that default as a template. A default can be assigned for a TCL Script Unit created as part of a Script project.
3. The document is initially unsaved.

Applied Parameters: ObjectKind=NewAnything|Kind=EditScriptBas

Summary

This command is used to create a new EnableBasic Script Unit.

Access

This command is accessed from any editor by choosing the File » New » Script Files » Enable Basic Script Unit command, from the main menus.

Use

First, ensure that the project that you wish to add the new document to, is either the active project - by having one of its existing documents open as the active document - or, if no documents are currently open, is the focused project in the Projects panel.

After launching the command, a new EnableBasic Script Unit (EditScript1.bas) will be created and opened as the active document in the main design window.

Tips

1. If no projects are currently open, or if the active document is a free document, the new document will be opened as a free document.
2. If a default document has been specified on the System - New Document Defaults page of the Preferences dialog, the EnableBasic Script Unit will be created using that default as a template. A default can be assigned for a EnableBasic Script Unit created as part of a Script project.
3. The document is initially unsaved.

Applied Parameters: ObjectKind=NewAnything|Index=n (where n is in the range 1 to 80)

Summary

This command is used to add a new instance of the indicated document type, to the active, or focused project, as applicable.

Access

The related indexed commands can be accessed in the following ways:

• For the active project, choose the required document type from the Project » Add New to Project sub-menu.
• For the focused project (right-click on the required project in the Projects panel), then choose the required document type from the Add New to Project sub-menu.
• For the focused project (click on the required project in the Projects panel), click the Project button, then choose the required document type from the Add New to Project sub-menu.

Use

If you want to add a new document to the active project, first ensure that one of its source documents is open as the active document in the main design window. For any other non-active project, access through the Projects panel as mentioned previously.

After launching the command, the indicated document type will be created, added to the active/focused project, and opened as the active document in the main design window.

Tips

1. If the chosen document type can have defaults specified on the System - New Document Defaults page of the Preferences dialog, the chosen document type will be created using that default as a template.
2. The document is initially unsaved.

Applied Parameters: None

Summary

This command is used to open any existing Altium Designer project or document file.

Access

This command can be accessed by:

• Choosing the File » Open command, from an editor's main menus.
• Clicking the  button on an editor's main toolbar.
• Using the Ctrl+O keyboard shortcut.

Use

After launching the command, the standard Windows Choose Document to Open dialog will appear. Use this dialog to locate, and open, the required project or document.

Tips

1. Any document that is opened will be opened as a free document (appearing in the relevant sub-folder of the Free Documents folder, in the Projects panel) and made the active document in the main design window. Any project file that is opened will be added to the Projects panel and made the focused project.
2. When opening an Integrated Library (*.IntLib), an information dialog will appear, giving you the option of extracting its source library documents. Clicking Yes will effectively decompile the Integrated Library, creating a corresponding Integrated Library Package (using the name of the compiled document) with the source library (libraries) added. The Package is opened (added to the Projects panel) and is made the focused project. If you click No in the dialog, the compiled Integrated Library will be added to the Installed Libraries list, which can be seen on the Installed tab of the Available Libraries dialog.

Applied Parameters: ObjectKind=FocusedDocument

Summary

This command is used to open the focused document in the Projects panel.

Access

This command can be accessed from the Projects panel by:

• Right-clicking on the entry for the required document and choosing the Open command, from the context menu.
• Clicking to focus the required document, then clicking the Project button and choosing the Open command from the context menu.

Use

First, ensure that the document you wish to open is focused in the Projects panel.

After launching the command, the focused document will be opened and made the active document in the main design window.

Tips

1. You can also open a document from the Projects panel, simply by double-clicking on it. If you have enabled the Opens and shows documents/objects option, in the Single Click region, on the System - Projects Panel page of the Preferences dialog, then a single click on a document's entry in the panel will open it in the main design window.
2. To display the current status of documents in the Projects panel, click the  button at the top-right of the panel, then enable the Show open/modified status option within the General grouping of pop-up controls. Alternatively, enable this option on the System - Projects Panel page of the Preferences dialog. Open documents are given the icon - .

Applied Parameters: ObjectKind=FocusedCategory

Summary

This command is used to open all documents within the focused category (sub-folder) in the Projects panel.

Access

This command can be accessed from the Projects panel by:

• Right-clicking on the entry for the required category (sub-folder) and choosing the Open All command, from the context menu.
• Clicking to focus the required category (sub-folder), then clicking the Project button and choosing the Open All command from the context menu.

Use

First, ensure that the sub-folder whose documents you wish to remove is focused in the Projects panel. Focus is given simply by clicking once on the folder's entry.

After launching the command, all documents residing within the focused sub-folder, and descendant folders thereof, will be opened (if not already).

Tips

1. To display the current status of documents in the Projects panel, click the  button at the top-right of the panel, then enable the Show open/modified status option within the General grouping of pop-up controls. Alternatively, enable this option on the System - Projects Panel page of the Preferences dialog. Open documents are given the icon - .

Applied Parameters: ObjectKind=Project

Summary

This command is used to open any existing Altium Designer project.

Access

This command can be accessed from any editor by:

• Choosing the File » Open Project command, from the main menus.
• Clicking the Workspace button in the Projects panel, then choosing the Add Existing Project command, from the context menu.
• Choosing the Project » Design Workspace » Add Existing Project command, from the main menus (requires a project document to be open).

Use

After launching the command, the standard Windows Choose Project to Open dialog will appear. Use this dialog to locate, and open, the required project. After clicking Open, the project will be opened and added to the Projects panel. If there is currently no active project, or a free document is the active document, then the newly opened project will become the focused project.

Tips

1. Trying to open a project that has already been opened, will result in no action.

Applied Parameters: ObjectKind=FocusedProjectDocuments

Summary

This command is used to open all closed or hidden documents associated with the focused project in the Projects panel.

Access

This command can be accessed from the Projects panel by:

• Right-clicking on the entry for the required project and choosing the Open Project Documents command, from the context menu.
• Clicking to focus the required project, then clicking the Project button and choosing the Open Project Documents command from the context menu.

Use

First, ensure that the project whose documents you wish to open is focused in the Projects panel.

After launching the command, all documents associated with the the focused project - which are currently closed or hidden - will be opened as tabbed documents in the main design window.

Tips

1. To display the current status of documents in the Projects panel, click the  button at the top-right of the panel, then enable the Show open/modified status option within the General grouping of pop-up controls. Alternatively, enable this option on the System - Projects Panel page of the Preferences dialog. Open documents are given the icon - . If a document belonging to the project was already open and has been modified (yet to be saved), it will be represented by the  icon.

Applied Parameters: ObjectKind=WorkspaceDocuments

Summary

This command is used to open all closed or hidden documents of the projects associated with the currently open Design Workspace.

Access

This command can be accessed by:

• Clicking the Workspace button in the Projects panel, then choosing the Open Workspace Documents command, from the context menu.
• Choosing the Project » Design Workspace » Open Workspace Documents command, from the main menus (requires a project document to be open).

Use

After launching the command, all documents for all projects associated with the the currently open Design Workspace - which are currently closed or hidden - will be opened as tabbed views in the main design window.

Tips

1. The currently open Design Workspace is indicated by the top field in the Projects panel. By default, there will always be a Design Workspace open - either an existing (saved) Design Workspace, or the default (unsaved) placeholder Design Workspace: Workspace1.DsnWrk.
2. To display the current status of documents in the Projects panel, click the  button at the top-right of the panel, then enable the Show open/modified status option within the General grouping of pop-up controls. Alternatively, enable this option on the System - Projects Panel page of the Preferences dialog. Open documents are given the icon - . If a document belonging to the project was already open and has been modified (yet to be saved), it will be represented by the  icon.

Applied Parameters: ObjectKind=Workspace

Summary

This command is used to open any existing Design Workspace. A Design Workspace is simply a saved set of Altium Designer projects. This can prove to be a highly efficient option when working with multiple projects that are closely linked in some way. For example, you may have a PCB design that incorporates one or more FPGA devices. The designs targeting those devices may include processor cores, within which, dedicated embedded software programs will run. Instead of having to remember and open the individual projects involved (PCB, FPGA and Embedded), all of the projects can be saved, opened and manipulated as a single design workspace.

Access

This command can be accessed from any editor by:

• Choosing the File » Open Design Workspace command, from the main menus.
• Clicking the Workspace button in the Projects panel, then choosing the Open Design Workspace command, from the context menu.
• Choosing the Project » Design Workspace » Open Design Workspace command, from the main menus (requires a project document to be open).

Use

After launching the command, the standard Windows Choose Design Workspace to Open dialog will appear. Use this dialog to locate, and open, the required Design Workspace file (*.DsnWrk). After clicking Open, any open projects (and documents thereof) of the previously active Design Workspace will be closed. You will be prompted to save any changes. The chosen Design Workspace is then opened, and its constituent projects made available in the Projects panel.

Tips

1. Trying to open a Design Workspace that has already been opened will result in the Design Workspace being closed and reopened. Again, you will be prompted to save any changes made to open documents.
2. The currently open Design Workspace is shown by the top field in the Projects panel.
3. The last project in the list will be made the focused project, when the Design Workspace is opened.

Applied Parameters: Kind=ManagedProject

Summary

This command is used to open an existing Managed Project. Managed Projects are version controlled by default, and can be collaboratively worked upon without having to worry about shared drives, servers, agreements etc. They are stored within SVN version control repositories, which are centrally managed through an Altium Vault. Repositories can be internal to the Altium Vault installation, defined using the local VCS service, or external through use of Altium Designer's built-in SVN, or third party SVN service.

Access

This command is accessed from any editor by choosing the File » Open Managed Project command, from the main menus.

Use

After launching the command, the Open Managed Project dialog will appear, from where you can choose which Managed Project to open. Only those Managed Projects that have been shared with you (you have permission to access) will be listed. After selecting the required project and clicking OK, the project will be checked out from the target repository and opened (added to the Projects panel).

Applied Parameters: ObjectKind=RecentDocument|Index=n (where n is in the range 1 to 9)

Summary

This command is used to open the indicated, recently closed document.

Access

The related indexed commands can be accessed from any editor, from the File » Recent Documents sub-menu.

Use

After launching the command, the listed document will be opened and made active in the main design window.

Tips

1. The Recent Documents list shows the most recently closed documents (up to a maximum of nine documents). Position 1 (at the top) reflects the last document to have been closed.
2. If a document is opened that does not currently reside in an opened project in the Projects panel, it will be opened as a free document.

Applied Parameters: ObjectKind=RecentProject|Index=n (where n is in the range 1 to 9)

Summary

This command is used to open the indicated, recently closed project.

Access

The related indexed commands can be accessed from any editor, from the File » Recent Projects sub-menu.

Use

After launching the command, the listed project will be opened and made available in the Projects panel.

Tips

1. The Recent Projects list shows the most recently closed projects (up to a maximum of nine projects). Position 1 (at the top) reflects the last project to have been closed.

Applied Parameters: ObjectKind=RecentWorkspace|Index=n (where n is in the range 1 to 9)

Summary

This command is used to open the indicated, recently closed design workspace.

Access

The related indexed commands can be accessed from any editor, from the File » Recent Workspaces sub-menu.

Use

After launching the command, any open projects (and documents thereof) of the previously active Design Workspace will be closed. You will be prompted to save any changes. The chosen Design Workspace is then opened and its constituent projects made available in the Projects panel.

Tips

1. The Recent Workspaces list shows the most recently closed design workspaces (up to a maximum of nine design workspaces). Position 1 (at the top) reflects the last design workspace to have been closed.

Applied Parameters: ObjectKind=RecentDocument

Summary

This command is used to choose what to open from a listing of recently closed documents, projects and design workspaces.

Access

This command is accessed from any editor by:

• Choosing the File » Recent Documents » All Recent Documents and Projects command, from the main menus.
• Choosing the File » Recent Projects » All Recent Documents and Projects command, from the main menus.
• Choosing the File » Recent Workspaces » All Recent Documents and Projects command, from the main menus.

Use

After launching the command, the Recent Documents, Projects and Workspaces dialog will appear. The dialog lists all recently closed documents, projects, and design workspaces, conveniently within the one location.

Simply select what you want to open and either click OK, to close the dialog and open your selection, or Open Selected Documents, to open your selection - keeping the dialog open for further selection.

Tips

1. Double-clicking on an entry in the dialog will also open the associated document, project or design workspace.
2. If your selection includes documents and/or projects AND a design workspace, only the design workspace will be opened (and its constituent projects/documents therein).
3. If a document is opened that does not currently reside in an opened project in the Projects panel, it will be opened as a free document.
4. When opening a design workspace, any open projects (and documents thereof) of the previously active Design Workspace will be closed. You will be prompted to save any changes.

Applied Parameters: ObjectKind=SelectProjectDocument

Summary

This command is used to open one or more documents, either in the currently focused project, or all open projects in the active design workspace.

Access

This command can be accessed from any editor by:

• Choosing the Project » Project Documents command, from the main menus.
• Using the Alt+Ctrl+O keyboard shortcut.

Use

After launching the command, the Open Project Documents dialog will appear. Use this dialog to select the documents that you wish to open. You can restrict the view to only list documents in the project that is currently focused in the Projects panel, or all projects open in the active design workspace.

With the required document(s) selected, clicking OK will cause those documents to be opened.

Tips

1. All selected documents will be opened as tabbed document views in the main design window. The last document selected will be the last document opened, with its parent project becoming the active project (and therefore the focused project also, in the Projects panel.
2. To display the current status of documents in the Projects panel, click the  button at the top-right of the panel, then enable the Show open/modified status option within the General grouping of pop-up controls. Alternatively, enable this option on the System - Projects Panel page of the Preferences dialog. Open documents are given the icon - .

Applied Parameters: Action=OpenExistingPDF|ObjectKind=OutputSelected

Summary

This command is used to open an existing PDF document, that has been generated through a defined PDF output container, in the active Output Job Configuration file.

Access

This command is accessed from the Output Job Editor by right-clicking on the required PDF output container (in the Output Containers region), and choosing the Open PDF command, from the context menu.

Use

First, ensure that the PDF output container, from which the PDF you wish to view was generated, is selected in the Output Containers region of the main job configuration window.

After launching the command, the PDF will be opened.

Tips

1. If the Output Job Configuration file is closed and then reopened, the command will no longer be available, even though the PDF exists. You will either need to generate the file again, or simply browse for the file in the location to which it was created.

Applied Parameters: ObjectKind=NewAnything|Kind=LibraryMigrator|Source=Rcs

Summary

This command is used to access the Library Migrator view, which presents an intuitive flow that takes initial selected libraries, and migrates them to a target Altium Vault. Catering for all types of libraries, relating to older component management methodologies - SCHLIB, PCBLIB, INTLIB, DBLIB, SVNDBLIB - the Library Migrator is the perfect solution to quickly building your company's set of vault components, and the many benefits that such components enjoy (high-integrity, lifecycle management, centralized storage and managtement, where-used functionality, ease of design resuse). And while the migration process can be configured - giving you enhanced control over how that migration is performed - at its most simplistic, you can simply accept the default settings and set the migration in motion within a matter of clicks.

Access

This command is accessed from any editor by choosing the View » Library Migrator command, from the main menus.

Use

After launching the command, the Library Migrator view will open as the active document in the main design window. The migration process is a staged flow, with the entries on the left-hand side of the Library Migrator view showing you at-a-glance, which stage you are currently at.

By default, all supported libraries found within the Available Libraries for the active/focused project, will be loaded and enabled ready for migration - so all project libraries, installed libraries, and libraries found along specified search paths.