SaveObject

Created: May 03, 2019 | Updated: May 03, 2019 | Applies to versions: 19.0, 19.1, 20.0 and 20.1

Parent page: WorkspaceManager Commands

The following pre-packaged resources, derived from this base command, are available:

Save Active Document

Applied Parameters: ObjectKind=Document|SaveMode=Standard

Summary

This command is used to save the currently active document.

Access

This command can be accessed from the active document's editor by:

Choosing the File » Save command, from the main menus.
Clicking the button on the Quick Access Bar.
Clicking the button on the editor's main toolbar.
Using the Ctrl+S keyboard shortcut.

Use

After launching the command, the active document will be saved.

Tips

A modified document is flagged by an asterisk suffix next to its entry in the Projects panel. A modified document also has an asterisk next to its name in its open document tab (or on the associated pop-up menu if documents are grouped).
For schematic documents, if the current file format is not Binary Version 5.0, the File Format dialog will appear, from where you can choose the format in which to save. It is recommended to choose the option to save in SCH Binary Version 5.0. If you have used features that were not available in previous versions of Altium Designer, saving in an earlier format may result in loss of data.
For PCB documents, if the current file format is not Binary Version 6.0, the File Format dialog will appear, from where you can choose the format in which to save. It is recommended to choose the option to save in PCB Binary Version 6.0. If you have used features that were not available in previous versions of Altium Designer, saving in an earlier format may result in loss of data.
The active document can also be saved (if in a modified state) by using the corresponding command from its document tab - right-click on the tab to access a context menu of commands. Note that this command will not be available if multiple documents of the same type are open and currently grouped.

Save Active Document As

Applied Parameters: ObjectKind=Document|SaveMode=SaveAs

Summary

This command is used to save a copy of the currently active document with a new name and/or different format (where available), to a specified location on the hard disk.

Access

This command is accessed from the active document's editor by choosing the File » Save As command, from the main menus.

Use

After launching the command, the standard Windows Save As dialog appears. Use this dialog to browse to a particular destination in which to save the file, give the file a new name (if required) and also to select the format in which to store the file (where available).

The newly saved file will be opened in place of the original file as the active document.

Tips

The parent project must be saved in order to point to the copy of the document the next time the project is opened, otherwise the project will include the original document still.

Save Copy of Active Document As

Applied Parameters: ObjectKind=Document|SaveMode=SaveCopyAs

Summary

This command is used to save a copy of the currently active document with a new name and/or different format (where available), to a specified location on the hard disk.

Access

This command is accessed from the active document's editor by choosing the File » Save Copy As command, from the main menus.

Use

After launching the command, the standard Windows Save A Copy Of dialog appears. Use this dialog to browse to a particular destination in which to save the file, give the file a new name (if required) and also to select the format in which to store the file (where available).

The newly saved file will not be opened in place of the original file.

Save Focused Document

Applied Parameters: ObjectKind=FocusedDocument|SaveMode=Standard

Summary

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

Access

This command is accessed from the Projects panel by right-clicking on the entry for the required document and choosing the Save command, from the context menu.

The command will only be available provided the focused document is actually open.

Use

First, ensure that the document you wish to save is actually open as one of the available tabbed documents in the main design window - it does not need to be made the active document.

After launching the command, the focused document will be saved.

Tips

A modified document is flagged by an asterisk suffix next to its entry in the Projects panel. A modified document also has an asterisk next to its name in its open document tab (or on the associated pop-up menu if documents are grouped).
For schematic documents, if the current file format is not Binary Version 5.0, the File Format dialog will appear, from where you can choose the format in which to save. It is recommended to choose the option to save in SCH Binary Version 5.0. If you have used features that were not available in previous versions of Altium Designer, saving in an earlier format may result in loss of data.
For PCB documents, if the current file format is not Binary Version 6.0, the File Format dialog will appear, from where you can choose the format in which to save. It is recommended to choose the option to save in PCB Binary Version 6.0. If you have used features that were not available in previous versions of Altium Designer, saving in an earlier format may result in loss of data.
A non-active document can also be saved (if in a modified state) by using the corresponding command from its document tab - right-click on the tab to access a context menu of commands. Note that this command will not be available if multiple documents of the same type are open and currently grouped.

Save Focused Document As

Applied Parameters: ObjectKind=FocusedDocument|SaveMode=SaveAs

Summary

This command is used to save a copy of the currently focused document in the Projects panel, with a new name and/or different format (where available), to a specified location on the hard disk.

Access

This command is accessed from the Projects panel by right-clicking on the entry for the required document and choosing the Save As command, from the context menu.

The command will only be available provided the focused document is actually open.

Use

First, ensure that the document you wish to save is actually open as one of the available tabbed documents in the main design window - it does not need to be made the active document.

The newly saved file will be opened in place of the original file.

Tips

The parent project must be saved in order to point to the copy of the document the next time the project is opened, otherwise the project will include the original document still.

Save All in Focused Category

Applied Parameters: ObjectKind=FocusedCategory|SaveMode=Standard

Summary

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

Access

This command is accessed from the Projects panel by right-clicking on the entry for the required category (sub-folder) and choosing the Save All command, from the context menu.

The command will only be available provided the focused category contains at least one document that is actually open.

Use

First, ensure that the sub-folder whose documents you wish to save 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 or descendant folders thereof, and that are currently open, will be saved.

Tips

A modified document is flagged by an asterisk suffix next to its entry in the Projects panel. A modified document also has an asterisk next to its name in its open document tab (or on the associated pop-up menu if documents are grouped).
The affected documents are saved, irrespective of whether they have been modified or not.

Save Active Project As

Applied Parameters: ObjectKind=Project|SaveMode=SaveAs

Summary

This command is used to save a copy of the currently active project, with a new name (if required), and to a specified location on the hard disk.

Access

With a document for the required project open as the active document, this command is accessed from that document's editor by choosing the File » Save Project As command, from the main menus.

Use

First, ensure that one of the target project's associated design documents is open as the active document in the main design window.

After launching the command, the standard Windows Save As dialog appears. Use this dialog to browse to a particular destination in which to save the project file, and give the file a new name (if required).

The newly saved project will be opened in place of the original project as the active project.

Tips

Only the project document is saved. The constituent design documents are not saved by this command.
The project document can be placed anywhere on the hard disk - the paths to the constituent design files will be updated accordingly.

Save Focused Project

Applied Parameters: ObjectKind=FocusedProject|SaveMode=Standard

Summary

This command is used to save the currently focused project in the Projects panel.

Access

This command is accessed from the Projects panel by right-clicking on the entry for the required project and choosing the Save Project command, from the context menu.

Use

First, ensure that the project you wish to save is focused in the Projects panel.

After launching the command, the project will be saved.

Tips

A modified project is flagged by an asterisk suffix next to its entry in the Projects panel.
Only the project document is saved. The constituent design documents are not saved by this command.

Save Focused Project As

Applied Parameters: ObjectKind=FocusedProject|SaveMode=SaveAs

Summary

This command is used to save a copy of the currently focused project in the Projects panel, with a new name (if required), and to a specified location on the hard disk.

Access

This command is accessed from the Projects panel by right-clicking on the entry for the required project and choosing the Save Project As command, from the context menu.

Use

First, ensure that the required project is focused in the Projects panel.

The newly saved project will be opened in place of the original project.

Tips

Only the project document is saved. The constituent design documents are not saved by this command.
The project document can be placed anywhere on the hard disk - the paths to the constituent design files will be updated accordingly.

Save Project Group

Applied Parameters: ObjectKind=Workspace

Summary

This command is used to save the current design Project Group (*.DsnWrk).

Access

This command is accessed from the Projects panel by right-clicking on the entry for the design project group and choosing the Save Project Group command, from the context menu.

Use

After launching the command, the active design Project Group will be saved.

Tips

A modified design project group is flagged by an asterisk suffix next to its entry in the Projects panel.
The currently open design Project Group has an entry in the Projects panel.
Only the design Project Group document is saved (*.DsnWrk). The constituent projects and their design documents are not saved by this command.
A default design Project Group (ProjectGroup1.DsnWrk) is assigned to the Projects panel when:
1. No specific design Project Group has been opened.
2. The creation of a new design Project Group is specified.
3. When all open projects and documents - part of a specific design Project Group or not - are closed.

This default design Project Group is initially unsaved and so use of this command will behave like the Save Project Group As command. Its name is used as the default entry in the Save As dialog, when you proceed to save the design Project Group.

Save Project Group As

Applied Parameters: ObjectKind=Workspace|SaveMode=SaveAs

Summary

This command is used to save a copy of the currently active design Project Group in the Projects panel, with a new name (if required), and to a specified location on the hard disk.

Access

This command can be accessed by:

Choosing the File » Save Project Group As command, from the main menus.
Right-clicking on the entry for the design project group in the Projects panel, and choosing the Save Project Group As command, from the context menu.

Use

After launching the command, the standard Windows Save As dialog appears. Use this dialog to browse to a particular destination in which to save the design Project Group file, and give the file a new name (if required).

The newly saved design Project Group will be opened in place of the original design Project Group.

Tips

Only the design Project Group document is saved (*.DsnWrk). The constituent projects and their design documents are not saved by this command.
The design Project Group document can be placed anywhere on the hard disk - the paths to the constituent project files will be updated accordingly.

Save All Modified

Applied Parameters: ObjectKind=All|ModifiedOnly=True

Summary

This command is used to save all projects and documents that have been modified. The Project Group will be saved too, if its project membership has changed.

Access

This command can be accessed by:

Choosing the File » Save All command, from an editor's main menus.
Clicking the button on the Quick Access Bar.
Right-clicking on the entry for the design project group in the Projects panel, and choosing the Save All command, from the context menu.

Use

After launching the command, all projects and documents that are detected as having been modified, will be saved.

If the projects are part of an existing (previously saved) Project Group, and project membership has changed (projects added or removed since last save), then the Project Group document (*.DsnWrk) will also be saved.

Tips

A modified entity (document, project, design project group) is flagged by an asterisk suffix next to its entry in the Projects panel. A modified document also has an asterisk next to its name in its open document tab (or on the associated pop-up menu if documents are grouped).
Saving is carried out in the order: Documents in project ---> Project documents ---> Project Group document.
For schematic documents, if the current file format is not Binary Version 5.0, the File Format dialog will appear, from where you can choose the format in which to save. It is recommended to choose the option to save in SCH Binary Version 5.0. If you have used features that were not available in previous versions of Altium Designer, saving in an earlier format may result in loss of data.
For PCB documents, if the current file format is not Binary Version 6.0, the File Format dialog will appear, from where you can choose the format in which to save. It is recommended to choose the option to save in PCB Binary Version 6.0. If you have used features that were not available in previous versions of Altium Designer, saving in an earlier format may result in loss of data.

Save Focused Item

Applied Parameters: None

Summary

This command is used to save the currently focused item in the Projects panel.

Access

This command is accessed by clicking the button, at the top of the Projects panel.

The command will only be available provided the focused item is actually modified.

Use

First, ensure that the item that you want to save is the focused entry in the Projects panel.

After launching the command, the focused item will be saved.

Tips

An entity in the Projects panel is focused either by clicking on it, or right-clicking on it. To distinguish it as being the focused entry, it appears with a blue border.
A modified document/project/project group is flagged by an asterisk suffix next to its entry in the Projects panel. A modified document also has an asterisk next to its name in its open document tab (or on the associated pop-up menu if documents are grouped).
When the focused item is a project, only the project document is saved. The constituent design documents are not saved by this command.
When the focused item is the design project group, only the design Project Group document is saved (*.DsnWrk). The constituent projects and their design documents are not saved by this command.
For schematic documents, if the current file format is not Binary Version 5.0, the File Format dialog will appear, from where you can choose the format in which to save. It is recommended to choose the option to save in SCH Binary Version 5.0. If you have used features that were not available in previous versions of Altium Designer, saving in an earlier format may result in loss of data.
For PCB documents, if the current file format is not Binary Version 6.0, the File Format dialog will appear, from where you can choose the format in which to save. It is recommended to choose the option to save in PCB Binary Version 6.0. If you have used features that were not available in previous versions of Altium Designer, saving in an earlier format may result in loss of data.