Search In: Doc:Documentation: Altium CircuitStudio
Altium DesignerAltium 365Altium MCAD CoDesignerAltium On-Prem Enterprise ServerAltium CircuitMakerCompany DashboardAltium Infrastructure Server
Close
Search Search on Documentation
Documentation Altium CircuitStudio ... Sch Dialogs

Document Options

Created: December 16, 2024 | Updated: August 16, 2018
Other Related Resources
Project Options (Dialog)

Parent page: Sch Dialogs

The Document Options dialog

Summary

This dialog provides controls 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.

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

Access

The Document Options dialog can be accessed from the Schematic Editor in the following ways:

  • Click Project | Content | from the main menus.
  • Right-click within the workspace then use the Options » Document Options command from the context menu.

Sheet Options Tab

Document Options dialog - Sheet Options tab

Use the dialog's Sheet Options tab to modify the look and feel of the sheet, as well as its various grids.

Options/Controls

Options

  • Orientation - use this field to specify the orientation of the sheet, either Landscape or Portrait.
  • Title Block - enable this option to display one of two predefined title blocks on the schematic sheet. Use the associated drop-down field to choose from either a Standard or ANSI title block style.
    • Sheet Number Spaces - this option becomes available when choosing to use the Standard predefined title block. Its value determines the space between the text "Sheet" and "of" in the title block. Enter a value between 1 and 16.
This option is usually used when there is no linked schematic template document. If using a template, use of the standard title block should be disabled.
  • Show Reference Zones - enable this option to display reference zones around the border of the sheet. Use the associated drop-down field that becomes available to choose from one of the following reference zone order styles:
    • Default: Alpha Top to Bottom, Numeric Left to Right - this style labels vertical zones from the top, starting with A, and horizontal zones from the left, starting with 1.
    • ASME Y14.1: Alpha Bottom to Top, Numeric Right to Left - this style labels vertical zones from the bottom, starting with A, and horizontal zones from the right, starting with 1.
The reference zones are for display purposes only and do not affect the Snap, Visible or Electrical grids that are used when placing and wiring objects.
  • Show Border - enable this option to have a border drawn around the perimeter of the sheet. If the option to Show Reference Zones is also enabled, both an inner and outer border will be drawn. The color of the border is determined by the Border Color field.
  • Show Template Graphics - enable this option to display any graphics (including title block and company logo) defined on the currently assigned template document.
  • Unique Id - the current unique identifier for the document. The Unique ID (UID) is a system-generated value that uniquely identifies this current document. A new UID value can be entered directly into this field.
    • Reset - click this button to have the system generate a new UID for the document.
  • Border Color - click the color sample to change the color of the border around the perimeter of the schematic sheet using the standard Choose Color dialog.
  • Sheet Color - click the color sample to change the color of the schematic sheet using the standard Choose Color dialog.

Grids

  • Snap - use these controls to turn the Snap grid on or off, and to set the grid interval size. The snap grid pulls the cursor to the nearest point on its defined grid when placing or manipulating objects on the sheet. This grid should be left on at all times except when specifically placing or moving objects that need to be off grid, such as text.
A non-preset value for the Snap grid can also be entered using the Grids » Set Snap Grid command available from the workspace's right-click context menu. Use the subsequent Choose a snap grid size dialog to define the required value.
  • Visible - use these controls to turn the Visible grid on or off, and to set the grid interval size. The visible grid is the grid you see on the sheet, which acts as a visual reference. Typically it is set to be the same as, or a multiple of, the Snap grid.
The style of the Visible grid (Line or Dot), and its color can be defined on the Schematic - Grids page of the Preferences dialog.
The setting of the Visible grid does not affect the cursor snap movement. This is determined by the Snap grid settings. The Visible grid can be quickly toggled in the workspace by pressing Shift+Ctrl+G.
In the workspace, cycle forward (G) or back (Shift+G) through predefined grid settings for Snap, Visible and Electrical grids. 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). Cycled settings are reflected in the dialog when accessed.
Note that if you use commands to cycle through preset grid settings, any manually entered value will be lost since cycling only involves the currently chosen preset interval settings.

Electrical Grid

  • Enable - enable this option to activate the Electrical grid. The electrical grid supports the Schematic Editor's Guided Wiring feature. When moving an electrical object in the workspace, and that object falls within the electrical grid range of another electrical object to which you could connect, the object you are moving will snap to the fixed object and a red highlight cross, or Hotspot, will appear. This guides you as to where a valid connection can be made.
    • Grid Range - use this field to determine the proximity two electrical objects can be before one snaps to a valid electrical hotspot on the other. The electrical grid should be set slightly lower than the current Snap grid or it becomes difficult to position electrical objects one Snap grid apart.
The Electrical grid, when enabled, acts with a higher priority than the Snap grid, therefore, when performing a command that relates to electrical connectivity, the cursor will pull to the Electrical grid in preference to the Snap grid. The Electrical grid can be quickly toggled in the workspace by pressing Shift+E.

Standard Style

  • Standard styles - use this field to choose from a range of standard sheet styles. The following styles (featuring both metric and imperial sizes) are available: A4, A3, A2, A1, A0, A, B, C, D, E, Letter, Legal, Tabloid.

Change System Font

Click this button to open the Font dialog in which the font style can be changed for system text, such as pin and port designators or names, and sheet border characters.

Custom Style

  • Use Custom style - enable this option to define a custom sheet style with the following properties:
    • Custom Width - use this field to specify the width required for the custom sheet.
    • Custom Height - use this field to specify the height required for the custom sheet.
    • X Region Count - use this field to determine the number of regions, or reference zones, that are displayed along the horizontal border of the custom sheet.
    • Y Region Count - use this field to determine the number of regions, or reference zones, that are displayed along the vertical border of the custom sheet.
    • Margin Width - use this field to specify the width of the border for the custom sheet.
  • Update From Standard - with the Use Custom style option disabled, click this button to quickly load settings for the custom sheet from the currently chosen standard style. This is perfect for when you just need to make slight adjustments from a standard style. Remember to enable the Use Custom style option again, so that you can use the custom sheet and make changes to settings as required.
Enabling then disabling the Use Custom style option will also load the settings from the current standard sheet style.
The maximum size for a custom sheet is 65 inches by 65 inches.

Parameters Tab

Document Options dialog - Parameters tab

Use the dialog's Parameters tab to manage parameters for the current document. You can also add rule-based parameters. Parameters defined here are treated as special strings, where the parameter Value is automatically linked to the special string when placed on the sheet.

Special strings are text strings that are recognized and interpreted when the sheet is printed or plotted, and are linked to a parameter using the "=" symbol prefix. For example, the document parameter Address1 is linked to the special string "=Address1".
Adding a parameter (as a rule) to a schematic document results in a PCB design rule being generated when the design is transferred to the PCB document with a scope that targets All objects.

Options/Controls

  • Parameters Grid - the main region of the tab lists all of the parameters currently defined for the document in terms of:
    • Name - the name of the parameter. For a rule-type parameter, this entry will be locked as Rule.
    • Value - the value of the parameter. For a rule-type parameter, the entry will reflect the rule type along with a listing of its defined constraints.
    • Type - the type of parameter, which determines the valid entries that can be used for its value. Available types are: STRING, BOOLEAN, INTEGER, and FLOAT. For a rule-type parameter, this entry is always STRING.
Predefined parameters cannot have their Name modified.
A standard parameter (non-rule) can be modified with respect to any of these attributes directly in the grid. However, attempting to change a locked Name and/or Value attribute will raise an error and you will need to press Esc to abandon such changes.
A parameter added as a rule cannot be edited directly in the grid. Its Name and Type are set to Rule and STRING respectively, and are always un-editable. Its Value can only be edited by changing the constraints of the rule. To do this, select and edit the parameter then click the Edit Rules Button in the Parameter Properties dialog. This will open the Edit PCB Rule (From Schematic) dialog in which the changes to the constraints can be made.
The dialog is pre-populated with common company parameters and typical sheet-specific information (such as sheet number, document title and revision number) to be included in the sheet's title block or elsewhere as text strings. New parameters can be added, including special strings that provide current information, such as date and time, which are inserted at the time of printing. Parameters defined at the document level will be listed in the Text field's drop-down listing  in the Annotation dialog when placing a text string object on the schematic sheet.
  • Add - click this button to add a new parameter to the list. The Parameter Properties dialog will open. Use this to define the parameter, especially its Name, Value, and Type.
  • Remove - click this button to delete the selected parameter(s) from the list of parameters.
Predefined parameters cannot be removed.
  • Edit - click this button to open the Parameter Properties dialog to modify the currently selected parameter.
  • Add as Rule - click this button to add a new design rule directive parameter to the list. The Parameter Properties dialog will open, but this time will contain the Edit Rule Values button, which, in turn, opens the Choose Design Rule Type dialog in which you can choose and subsequently define the constraints of the required rule type.

Right-click Menu

The Parameters Grid right-click menu offers the following commands:

  • Selected On - use this command to quickly enable the Visible option for all currently selected parameters in the list.
  • Selected Off - use this command to quickly disable the Visible option for all currently selected parameters in the list.
  • Add - use this command to add a new standard (non-rule) parameter to the list.
  • Remove - use this command to remove the currently selected parameter(s) in the list.
  • Edit - use this command to edit the currently selected parameter in the list.
  • Select All - use this command to quickly select all parameters in the list.
  • Select None - use this command to quickly deselect all parameters in the list.

Units Tab

Document Options dialog - Units tab

Use the dialog's Units tab to specify the units of measurement to be used for the schematic. A range of unit types are available, across both Imperial and Metric systems.

The units should only be changed in special circumstances. If altered, it will be extremely difficult to connect schematic components that have been created and placed using different grids.
Note that a newly-added schematic document will initially follow the units of measurement defined at the global level in the Schematic - General page of the Preferences dialog. Subsequently defining the units at the document level overrides the global setting (for that specific document).

Options/Controls

Imperial Unit System

  • Use Imperial Unit System - enable this option to use Imperial units in the schematic.
    • Imperial unit used - use the drop-down list associated to this field to choose the type of Imperial unit to use. Available options are: Mils, Inches, DXP Defaults, and Auto-Imperial. The Auto-Imperial option automatically switches from mils to inches when the display value is greater than 500mils.
1 DXP Default = 10mils.

Metric Unit System

  • Use Metric Unit System - enable this option to use Metric units in the schematic.
    • Metric unit used - use the drop-down list associated to this field to choose the type of Metric unit to use. Available options are: Millimeters, Centimeters, Meters, and Auto-Metric. The Auto-Metric option automatically switches from millimeters to centimeters when the display value is greater than 100mm, and from centimeters to meters when the display value is greater than 100cm.

Unit System

This area of the tab states the current measurement unit being used for the active document's base unit. If another unit has been chosen, but the dialog's OK button has not yet been clicked, the message will extend to reflect the unit that will be used if the modification is committed.

Template Tab

Document Options dialog - Template tab

Use the dialog's Template tab to utilize, and switch between, default schematic document templates or remove the active template altogether.

Options/Controls

  • Template file - this field reflects the template currently in use for the active schematic sheet. It will be blank if no template is currently being used. The field's drop-down lists all default templates shipped as part of the CircuitStudio installation. Select a template to switch to it.
Default schematic templates (*.SchDot) are located in the \Users\Public\Documents\Altium\CS\Templates folder of the installation.
  • Choose - click this button to access a standard Open dialog, with which you can browse to and open the required template file stored outside of the default installation Templates folder.
  • Update From Template - click this button to update the active schematic sheet with the latest changes made (where applicable) to the currently assigned template.
  • Clear Template - use this button to remove the current template, but retain its sheet size. The Template File field will be cleared.
Template-related commands for quickly switching templates, updating from the current template, or removing the current template are also available from the main menus by clicking Project | Content | . While the template can be set and switched, updated from, and removed through the Document Options dialog, this affects the active sheet only. Setting the template from the menus (or updating from/removing) gives the added benefit of being able to determine the scope of template application/update/removal - either the active document, all schematic documents in the active project, or all open schematic documents (regardless of the project they belong to).
A default template can be specified for use by new schematic sheets on the Schematic - General page of the Preferences dialog.

 

If you find an issue, select the text/image and pressCtrl + Enterto send us your feedback.
Content