Altium Designer Documentation

Print

Created: January 30, 2023 | Updated: January 30, 2023
Applies to Altium Designer version: 21

Parent page: WorkspaceManager Commands

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


Applied Parameters: Action=PageSetup

Summary

This command is used to run the appropriate dialog for setting up the page for the currently active document, in readiness for printing.

Access

From an editor whose document type is supported for printing, this command is accessed by choosing the File » Page Setup command from the main menus.

Use

After launching the command, the Page Setup dialog will appear. Use the dialog to set up the page properties for the document, ready for previewing and/or printing. Paper size, scaling, margin settings, and the print color set, can all be defined in the dialog.

The dialog also provides access to the following:

  • Click the Printer Setup button to open the associated Printer Configuration dialog, from where you can define the specific printer to use and related printing options.
  • Click the Preview button to open the Print Preview dialog, with the document page(s) loaded in accordance to the page setup options you have defined.
  • Click the Advanced button to access an additional properties dialog, with printing options in relation to content included in the print. The actual dialog accessed and the options it provides depends on the document type from which you are trying to print:
  • Click the Print button to print the required content. The Printer Configuration dialog will appear for confirmation of what is to be printed and to which printing device.


Applied Parameters: Action=Preview

Summary

This command is used to generate a print preview of the defined default print set for the currently active document.

Access

From an editor whose document type is supported for printing, this command can be accessed by:

  • Choosing the File » Print Preview command from the main menus.
  • Clicking the  button on the editor's main toolbar.

Use

After launching the command, the Print Preview dialog will appear, with the default print set for the current document already loaded, and in accordance with the options defined in the associated page setup properties dialog. Use this dialog to view the printouts and edit their setup definitions if required, before actually printing.

Click the Print button to print the content. The Printer Configuration dialog will appear for confirmation of what is to be printed and to which printing device.

Tips

  1. The default print set for the active document type, is defined and configured on the Default Prints tab of the Options for Project dialog.
  2. You can pan around the zoomed printout by using the mouse to right-click, hold and drag the document.
  3. You can also export the current preview as Windows Enhanced Metafiles (*.EMF), using vector objects to render the images in the EMF files.


Applied Parameters: Action=PrintWithDialog|

Summary

This command is used to print the defined default print set for the currently active document.

Access

From an editor whose document type is supported for printing, this command can be accessed by:

  • Choosing the File » Print command from the main menus.
  • Using the Ctrl+P keyboard shortcut.

Use

After launching the command, the Printer Configuration dialog will appear, from where you can define the specific printer to use and related printing options. After clicking OK, the defined default print set will be sent to the chosen printing device, in accordance with the options defined in the associated page setup properties dialog.

Tips

  1. The default print set for the active document type, is defined and configured on the Default Prints tab of the Options for Project dialog.


Applied Parameters: Action=PageSetup|ObjectKind=FocusedDocument

Summary

This command is used to run the appropriate dialog for setting up the page for the currently focused document in the Projects panel, in readiness for printing.

Access

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

Use

First, ensure that the document you wish to configure the page for, is focused in the Projects panel.

After launching the command, the Page Setup dialog will appear. Use the dialog to set up the page properties for the document, ready for previewing and/or printing. Paper size, scaling, margin settings, and the print color set, can all be defined in the dialog.

The dialog also provides access to the following:

  • Click the Printer Setup button to open the associated Printer Configuration dialog, from where you can define the specific printer to use and related printing options.
  • Click the Preview button to open the Print Preview dialog, with the document page(s) loaded in accordance to the page setup options you have defined.
  • Click the Advanced button to access an additional properties dialog, with printing options in relation to content included in the print. The actual dialog accessed and the options it provides depends on the document type from which you are trying to print:
  • Click the Print button to print the required content. The Printer Configuration dialog will appear for confirmation of what is to be printed and to which printing device.


Applied Parameters: Action=Preview|ObjectKind=FocusedDocument

Summary

This command is used to generate a print preview of the defined default print set for the 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 Print Preview command, from the context menu.

Use

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

After launching the command, the Print Preview dialog will appear, with the default print set for the focused document already loaded, and in accordance with the options defined in the associated page setup properties dialog. Use this dialog to view the printouts and edit their setup definitions if required, before actually printing.

Click the Print button to print the content. The Printer Configuration dialog will appear for confirmation of what is to be printed and to which printing device.

Tips

  1. The default print set for the active document type, is defined and configured on the Default Prints tab of the Options for Project dialog.
  2. You can pan around the zoomed printout by using the mouse to right-click, hold and drag the document.
  3. You can also export the current preview as Windows Enhanced Metafiles (*.EMF), using vector objects to render the images in the EMF files.


Applied Parameters: Action=PrintWithDialog|ObjectKind=FocusedDocument

Summary

This command is used to print the defined default print set for the 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 Print command, from the context menu.

Use

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

After launching the command, the Printer Configuration dialog will appear, from where you can define the specific printer to use and related printing options. After clicking OK, the defined default print set will be sent to the chosen printing device, in accordance with the options defined in the associated page setup properties dialog.

Tips

  1. The default print set for the focused document type, is defined and configured on the Default Prints tab of the Options for Project dialog.


Applied Parameters: Action=PrintDocument

Summary

This command is used to print the defined default print set for the currently active document directly, without having the Printer Configuration dialog appear.

Access

From an editor whose document type is supported for printing, this command is accessed by clicking the  button, on the editor's main toolbar.

Use

After launching the command, the defined default print set for the active document will be printed directly, according to the options last specified in the associated Page Setup dialog, and to the printer last specified in the Printer Configuration dialog.

Tips

  1. The default print set for the active document type, is defined and configured on the Default Prints tab of the Options for Project dialog.


Applied Parameters: Action=PageSetup|ObjectKind=OutputSingle

Summary

This command is used to run the appropriate dialog for setting up the page (where possible) - for the currently focused printable output in the active Output Job Configuration file - in readiness for printing.

Access

With a printable output selected, this command can be accessed from the Output Job Editor by:

  • Choosing the File » Page Setup command from the main menus.
  • Right-clicking over the required output, in the main job configuration window, and choosing the Page Setup command from the context menu.
The command is only available for supported print-based outputs. If multiple print-based outputs are selected, the command will act on the focused output (distinguished by a dotted cell border).

Use

After launching the command, the Page Setup dialog will appear. Use the dialog to set up the page properties for the output, ready for previewing and/or printing. Paper size, scaling, margin settings, and the print color set, can all be defined in the dialog.

The dialog also provides access to the following:

  • Click the Preview button to open the Print Preview dialog, with the document page(s) - specified by the chosen Data Source for the output - loaded in accordance to the page setup options you have defined.
  • Click the Advanced button to access an additional properties dialog, with printing options in relation to content included in the print. The actual dialog accessed and the options it provides depends on the document type from which you are trying to print:
  • Click the Print button to print the required content. The Printer Configuration dialog will appear for confirmation of what is to be printed and to which printing device.

Tips

  1. Double-clicking on the output's entry in the main job configuration window, has the same effect as clicking the Advanced button from the Page Setup dialog - giving access to the additional properties dialog specific to the type of printable document.
  2. Configuration of the target printing device is performed by configuring the print job to which a print-based output is enabled/linked.


Applied Parameters: Action=PrinterSetup|ObjectKind=OutputMedium

Summary

This command is used to configure the properties of the currently selected print job, in the active Output Job Configuration file.

Access

With the required print job selected, this command is accessed from the OutputJob Editor by right-clicking in the Hard Copy region (over the selected print job) and choosing the Properties command, from the context menu.

Use

First, ensure that the print job that you wish to configure is selected, in the Hard Copy region of the main job configuration window.

After launching the command, the Printer Configuration dialog will appear. Use the dialog to manage and configure the properties of the selected print job, which will be applied when generating output from its linked output generators.

Tips

  1. The Printer Configuration dialog can also be accessed by clicking on the Change link, at the top-right of the print job's entry in the region.


Applied Parameters: Action=PublishToPDFSetup|ObjectKind=OutputMedium

Summary

This command is used to configure the properties of the currently selected PDF output container, in the active Output Job Configuration file.

Access

With the required PDF output container selected, this command is accessed from the OutputJob Editor by right-clicking in the Output Containers region (over the selected container) and choosing the Properties command, from the context menu.

Use

First, ensure that the PDF container that you wish to configure is selected, in the Output Containers region of the main job configuration window.

After launching the command, the PDF settings dialog will appear. Use the dialog to manage and configure the properties of the selected PDF output container, which will be applied when generating output from its linked output generators.

Tips

  1. The PDF settings dialog can also be accessed by clicking on the Change link, at the top-right of the container's entry in the region.


Applied Parameters: Action=PublishMultimediaSetup|ObjectKind=OutputMedium

Summary

This command is used to configure the properties of the currently selected Video output container, in the active Output Job Configuration file.

Access

With the required Video output container selected, this command is accessed from the OutputJob Editor by right-clicking in the Output Containers region (over the selected container) and choosing the Properties command, from the context menu.

Use

First, ensure that the Video container that you wish to configure is selected, in the Output Containers region of the main job configuration window.

After launching the command, the Video settings dialog will appear. Use the dialog to manage and configure the properties of the selected Video output container, which will be applied when generating output from its linked output generators.

Tips

  1. The Video settings dialog can also be accessed by clicking on the Change link, at the top-right of the container's entry in the region.


Applied Parameters: Action=PrintDocument|ObjectKind=OutputBatch

Summary

This command is used to generate the outputs that are enabled, and linked to, the selected print job, in the active Output Job Configuration file.

Access

With the required print job selected, and at least one output linked and enabled, this command can be accessed from the OutputJob Editor by:

  • Choosing the Tools » Print command, from the main menus.
  • Clicking the  button on the Job Manager Toolbar toolbar.
  • Using the F9 keyboard shortcut.
  • Right-clicking on the entry for the print job, and choosing the Print command from the context menu.

Use

First, ensure that the print job whose linked (and enabled) outputs you wish to generate, is selected in the Hard Copy region of the main job configuration window.

After launching the command, each of the outputs that are linked to the selected print job, and that are enabled for generation, will be generated. The process of generation proceeds in batch-fashion, and in sequence according to the numbering of the enabled outputs.

Generated output will be sent to the printing device defined as part of the settings for the print job.

Tips

  1. The batch output generation process can also be invoked by clicking on the Print link, at the right of the print job's entry in the region.
  2. When the target for an applicable print-based output is changed from a PDF output container to a physical printer (print job), it is quite possible that the paper size defined for the generator - through the relevant properties dialog (right-click, Page Setup) - may not be supported by the target medium. In this case, the connecting arrow from generator to medium is colored red when the output is enabled. You will be prevented from previewing/printing in this state. You can either change the paper size for the output generator, and thus return the connecting arrow to a green state, before the applicable output can be successfully generated. Or, simply change the target medium to one that does support your chosen paper size. Where a paper size mismatch exists, and you opt to change the paper size for the configured output, using the Page Setup command for the output will bring up an information dialog. This alerts you to the issue, and notifies you that the paper sizing has been restored to its default. What this means is that the paper size drop-down in the configurator dialog is loaded afresh with the standard set of paper sizes supported by the target printer.


Applied Parameters: Action=Preview|ObjectKind=OutputBatch

Summary

This command is used to generate a print preview of the outputs that are enabled, and linked to, the selected print job, in the active Output Job Configuration file.

Access

With the required print job selected, and at least one output linked and enabled, this command can be accessed from the OutputJob Editor by:

  • Choosing the Tools » Print Preview command, from the main menus.
  • Clicking the  button on the Job Manager Toolbar toolbar.
  • Right-clicking on the entry for the print job, and choosing the Print Preview command from the context menu.

Use

First, ensure that the print job whose linked (and enabled) outputs you wish to generate a preview for, is selected in the Hard Copy region of the main job configuration window.

After launching the command, the Print Preview dialog will appear, containing previews for each of the outputs that are linked to the selected print job, and that are enabled for generation.

Tips

  1. The batch print preview process can also be invoked by clicking on the Preview link, at the right of the print job's entry in the region.
  2. When the target for an applicable print-based output is changed from a PDF output container to a physical printer (print job), it is quite possible that the paper size defined for the generator - through the relevant properties dialog (right-click, Page Setup) - may not be supported by the target medium. In this case, the connecting arrow from generator to medium is colored red when the output is enabled. You will be prevented from previewing/printing in this state. You can either change the paper size for the output generator, and thus return the connecting arrow to a green state, before the applicable output can be successfully generated. Or, simply change the target medium to one that does support your chosen paper size. Where a paper size mismatch exists, and you opt to change the paper size for the configured output, using the Page Setup command for the output will bring up an information dialog. This alerts you to the issue, and notifies you that the paper sizing has been restored to its default. What this means is that the paper size drop-down in the configurator dialog is loaded afresh with the standard set of paper sizes supported by the target printer.


Applied Parameters: Action=PublishToPDF|ObjectKind=OutputBatch|DisableDialog=True

Summary

This command is used to generate the outputs that are enabled, and linked to, the selected PDF output container, in the active Output Job Configuration file.

Access

With the required PDF output container selected, and at least one output linked and enabled, this command can be accessed from the OutputJob Editor by:

  • Choosing the Tools » Generate PDF command, from the main menus.
  • Clicking the  button on the Job Manager Toolbar toolbar.
  • Using the F9 keyboard shortcut.
  • Right-clicking on the entry for the PDF container, and choosing the Generate PDF command from the context menu.

Use

First, ensure that the PDF container whose linked (and enabled) outputs you wish to generate, is selected in the Output Containers region of the main job configuration window.

After launching the command, each of the outputs that are linked to the selected PDF output container, and that are enabled for generation, will be generated. The process of generation proceeds in batch-fashion, and in sequence according to the numbering of the enabled outputs.

Generated output will be written to the location defined as part of the settings for the output container. These settings will also control whether the output is opened after generation.

Tips

  1. The batch output generation process can also be invoked by clicking on the Generate Content link, at the right of the container's entry in the region.
  2. When the target for an applicable print-based output is changed from a physical printer (print job) to a PDF output container, it is quite possible that the paper size defined for the generator - through the relevant properties dialog (right-click, Page Setup) - may not be supported by the target medium. In this case, the connecting arrow from generator to medium is colored red when the output is enabled. You will be prevented from generating content in this state. You can either change the paper size for the output generator, and thus return the connecting arrow to a green state, before the applicable output can be successfully generated. Or, simply change the target medium to one that does support your chosen paper size. Where a paper size mismatch exists, and you opt to change the paper size for the configured output, using the Page Setup command for the output will bring up an information dialog. This alerts you to the issue, and notifies you that the paper sizing has been restored to its default. What this means is that the paper size drop-down in the configurator dialog is loaded afresh with the standard set of supported paper sizes.


Applied Parameters: Action=PublishMultimedia|ObjectKind=OutputBatch|DisableDialog=True

Summary

This command is used to generate the outputs that are enabled, and linked to, the selected Video output container, in the active Output Job Configuration file.

Access

With the required Video output container selected, and at least one output linked and enabled, this command can be accessed from the OutputJob Editor by:

  • Choosing the Tools » Generate Video command, from the main menus.
  • Clicking the  button on the Job Manager Toolbar toolbar.
  • Using the F9 keyboard shortcut.
  • Right-clicking on the entry for the Video container, and choosing the Generate Video command from the context menu.

Use

First, ensure that the Video container whose linked (and enabled) outputs you wish to generate, is selected in the Output Containers region of the main job configuration window.

After launching the command, each of the outputs that are linked to the selected Video output container, and that are enabled for generation, will be generated. The process of generation proceeds in batch-fashion, and in sequence according to the numbering of the enabled outputs.

Generated output will be written to the location defined as part of the settings for the output container. These settings will also control whether the output is opened after generation.

Tips

  1. The batch output generation process can also be invoked by clicking on the Generate Content link, at the right of the container's entry in the region.

 

Found an issue with this document? Highlight the area, then use Ctrl+Enter to report it.

Contact Us

Contact our corporate or local offices directly.

We're sorry to hear the article wasn't helpful to you.
Could you take a moment to tell us why?
200 characters remaining
You are reporting an issue with the following selected text
and/or image within the active document: