Altium Designer Documentation

DocumentPreferences

Created: September 8, 2016 | Updated: April 11, 2017
Now reading version 17.1. For the latest, read: DocumentPreferences for version 21
Applies to Altium Designer versions: 17.0 and 17.1

Parent page: Schematic Commands

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


Applied Parameters: None

Summary

This command is used to access the relevant options dialog for either the active schematic library, or active schematic document.

Access

This command can be accessed from the Schematic Editor and Schematic Library Editor:

  • Schematic Editor - by choosing the Design » Document Options command from the main menus.
  • Schematic Library Editor - by choosing the Tools » Document Options command from the main menus.
The command can also be quickly accessed from the Options pop-up menu (press O in the workspace). Access the relevant options dialog using the O, D keyboard sequence.

Use

After launching the command, the dialog that is accessed will depend on the active document:

  • Schematic Editor - accesses the Document Options dialog. This dialog allows you to define options that are specific to the active schematic document. The dialog is divided over four tabs, collectively providing controls for defining the look and feel of the schematic sheet, enabling and sizing grids, specifying the units of measurement to be used, and any relevant document parameters. It also reflects any default schematic document template that is currently being used for the sheet, with the ability to quickly switch templates. Controls can also be accessed when desiring to link the document to a Schematic Sheet Item, for release to an Altium Vault.
  • Schematic Library Editor - accesses the Schematic Library Options dialog. This dialog allows you to define options that are specific to the active schematic library document. The dialog is divided over two tabs, collectively providing controls for defining the look and feel of the schematic library sheet, enabling and sizing grids, and specifying the units of measurement to be used. Controls can also be accessed when desiring to link the document to an Altium Vault (and folder therein), in readiness for release.

Make changes as required using the relevant dialog and click OK to save.

Tips

  1. Document-level settings defined through the respective dialog are saved with the document.
  2. For a schematic document, a parameter added as a rule at the document level translates to a rule scope of All when transferred to the PCB document. To achieve a more specific rule scope, a parameter (added as a rule) should be added to a specific object on the schematic.


Applied Parameters: Action=ProjectSystemParameters

Summary

This command is used to access the Sheet Numbering for Project dialog. This dialog allows you to quickly number the constituent schematic sheets in the active design project. Sheet and Document Numbering allows designers to take control over the sheet designation and store them as parameters within the respective schematic documents. Special strings (=SheetNumber, =DocumentNumber, =SheetTotal) can then be used to expose these values on the sheet (in the sheet's title block for example) as text objects.

This command relates to the numbering of the logical sheets. To number the compiled sheets (the physical instances of sheets), use the Annotate Compiled Sheets command.

Access

This command is accessed from the Schematic Editor by choosing the Tools » Annotation » Number Schematic Sheets command from the main menus.

Use

After launching the command, the Sheet Numbering for Project dialog will appear. Use the controls available in the dialog to define sheet and document numbering as required. If your organization has a specific number or naming system that cannot be automated through either the Auto Sheet Number or Auto Document Number controls, custom sheet names and numbers can be written directly into the SheetNumber or DocumentNumber fields.

Tips

  1. Sheet or Document Numbers cannot be configured for Device Sheets when they are read-only (default state) and will be cross hatched in the Sheet Numbering for Project dialog to indicate they cannot be updated. When Device Sheets are set as editable, the cross hatching is removed and Sheet and Document Numbering can be configured as normal.


Applied Parameters: Tab = Sheet Options

Summary

This command is used to quickly access the Sheet Options tab of the Document Options dialog, for the active schematic document.

Access

This command can be accessed from the Schematic Editor by:

  • Pressing O to access the Options pop-up menu, then choosing the Sheet entry.
  • Using the O, S keyboard sequence.

Use

After launching the command, the Document Options dialog will appear, with the Sheet Options tab made active. Use this tab to set the size, orientation and color scheme for the active schematic document, as well as defining the default system font. You can also control the display of the title block, border and reference zone information. When defining the size for the sheet, you can either choose from a range of predefined metric and imperial styles, or create your own custom style. The visible, snap and electrical grid ranges are also definable from this tab, along with controls for enabling/disabling any or all of the three.

Across its other tabs, the dialog allows you to specify the units of measurement to be used, and any relevant document parameters. It also reflects any default schematic document template that is currently being used for the sheet, with the ability to quickly switch templates. Controls can also be accessed when desiring to link the document to a Schematic Sheet Item, for release to an Altium Vault.

Tips

  1. Document-level settings defined through the dialog are saved with the document.


Applied Parameters: Tab = Parameters

Summary

This command is used to quickly access the Parameters tab of the Document Options dialog, for the active schematic document.

Access

This command can be accessed from the Schematic Editor by:

  • Pressing O to access the Options pop-up menu, then choosing the Document Parameters entry.
  • Using the O, T keyboard sequence.

Use

After launching the command, the Document Options dialog will appear, with the Parameters tab made active. Use this tab to create and edit parameters for the current document. Properties for a parameter are defined in the Parameter Properties dialog (accessed when adding a new parameter or editing an existing one).

By default, parameters have been defined for company and sheet-specific information (such as sheet number, document title and revision number), to be included in the title block of the sheet or elsewhere as text strings.

The parameters defined in this tab are treated as special strings. Special strings are text strings which are recognized and interpreted when the sheet is printed or plotted. Certain special strings provide current information, such as date and time, which are inserted at the time of printing.

Tips

  1. Most special stings can be displayed on the document prior to printing by enabling the Convert Special Strings option, on the Schematic - Graphical Editing page of the Preferences dialog.
  2. A parameter added as a rule at the document level translates to a rule scope of All when transferred to the PCB document. To achieve a more specific rule scope, a parameter (added as a rule) should be added to a specific object on the schematic.
  3. Document-level settings defined through the dialog are saved with the document.


Applied Parameters: Action=SetSnapGrid

Summary

This command is used to set the snap grid to a user-specified value. The snap grid value defines the alignment grid for manual movement and placement, in the current document.

Access

This command can be accessed from the Schematic Editor, and Schematic Library Editor, by:

  • Choosing the View » Grids » Set Snap Grid command, from the main menus.
  • Choosing the Set Snap Grid command, on the Grids drop-down () of the Utilities toolbar.
In the Schematic Editor, the command can also be accessed by right-clicking in the design workspace, and choosing the Grids » Set Snap Grid command from the context menu.

Use

After launching the command, the Choose a snap grid size dialog will appear. Use the dialog to enter the required value for the snap grid.

Tips

  1. The entered grid size is reflected at the left-hand side of the status bar, and also in the Grids region, on the Sheet Options tab of the Document Options dialog.
  2. In the workspace, cycle forward (G) or back (Shift+G) through predefined grid settings. The settings available are determined by the chosen presets, as defined on the Schematic - Grids page of the Preferences dialog, and the current measurement system in force (Imperial or Metric). If you change the grid size in this manner, your entered setting (through the Choose a snap grid size dialog) will be lost, as cycling only involves the currently chosen preset interval settings.

 

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: