Working with a Sheet Symbol Object on a Schematic Sheet in Altium Designer

Parent page: Schematic Objects

A placed Sheet Symbol

Summary

A sheet symbol is an electrical design primitive. It is used to represent a sub-sheet in a multi-sheet hierarchical design. Sheet symbols include sheet entry symbols, which provide a connection point for signals between the parent and child sheets in a hierarchical design, similar to the way that Ports provide connections between sheets in a flat-sheet design.

Availability

Sheet symbols are available for placement in the Schematic Editor only. Use one of the following methods to access the placement command:

• Click Place » Sheet Symbol from the main menus.
• Right-click in the schematic editor then click Place » Sheet Symbol.
• Click the Place Sheet Symbol button ( ) on the Wiring toolbar.

Sheet symbols are also available by right-clicking in the schematic editor, then click Place » Sheet Symbol.

Placement

After launching the command, the cursor will change to a cross-hair and enter sheet symbol placement mode. Placement is made by performing the following actions:

1. Click or press Enter to anchor the first corner of the sheet symbol.
2. Move the cursor to adjust the size of the sheet symbol and click or press Enter to complete placement.
3. Continue placing further sheet symbols, or right-click or press Esc to exit placement mode.

Additional actions that can be performed during placement – while the sheet symbol is still floating on the cursor and before its first corner is anchored are:

• Press the Tab key to access an associated properties dialog from where properties for the sheet symbol can be changed on-the-fly.

• Press and hold the Alt key to constrain the direction of movement to the horizontal or vertical axis, depending on the initial direction of movement.
• Press the Spacebar to rotate the sheet symbol counter-clockwise or Shift+Spacebar for clockwise rotation. Rotation is in increments of 90°.
• Press the X or Y keys to mirror the sheet symbol along the X-axis or Y-axis respectively.

Graphical Editing

This method of editing allows you to select a placed sheet symbol object directly in the workspace and graphically change its size, shape or location.

When a sheet symbol object is selected, you can click and drag the editing handles to resize the sheet symbol.

A selected Sheet Symbol

Click anywhere on the sheet symbol away from editing handles and drag to reposition it. While dragging, the sheet symbol can be rotated (Spacebar/Shift+Spacebar) or mirrored (X or Y keys to mirror along the X-axis or Y-axis).

The sheet symbol's Designator and Filename text fields can only be resized by changing the size of the font used (accessed through the Sheet Symbol Designator and Sheet Symbol File Name dialogs). As such, editing handles are not available when either of those objects are selected.

Selected Designator and Filename for a sheet symbol

• Click anywhere inside the dashed box and drag to reposition the text object as required. While dragging, the text can be rotated (Spacebar/Shift+Spacebar) or mirrored (X or Y keys to mirror along the X-axis or Y-axis).
• The text for an object can be edited in-place by:
  1. Single-clicking the designator or filename text to select it.
  2. Single-clicking again (or pressing the Enter key) to enter the in-place editing mode. Sufficient time between each click should be given to ensure the software does not interpret the two single-clicks as one double-click (which would open the associated properties dialog).
  3. To finish editing in-place text, press the Enter key or use the mouse to click away from the text object.

Non-Graphical Editing

The following methods of non-graphical editing are available:

Via an Associated Properties Dialog

Dialog page: Sheet Symbol

This method of editing uses the Sheet Symbol dialog to modify the properties of a sheet symbol object.

The Sheet Symbol dialog

The dialog can be accessed during placement by pressing the Tab key.

After placement, the dialog can be accessed in one of the following ways:

• Double-click on the placed sheet symbol object.
• Place the cursor over the sheet symbol object then right-click and choose Properties.
• Use the Edit » Change command and clicking once over the placed sheet symbol object.

The sheet symbol Designator and Filename text fields can be formatted independently of the sheet symbol. The corresponding properties dialogs for each (Sheet Symbol Designator dialog and Sheet Symbol File Name dialog) can be accessed using the after-placement methods described above (replacing sheet symbol with the relevant object whose properties you wish to view/modify).

The Sheet Symbol Designator and Sheet Symbol File Name dialogs

Via an Inspector Panel

Panel pages: SCH Inspector, SCH Filter

An Inspector panel enables the designer to interrogate and edit the properties of one or more design objects in the active document. Used in conjunction with appropriate filtering - by using the applicable Filter panel, or the Find Similar Objects dialog - the panel can be used to make changes to multiple objects of the same kind, from one convenient location.

Via a List Panel

Panel pages: SCH List, SCH Filter

A List panel allows the designer to display design objects from one or more documents in tabular format, enabling quick inspection and modification of object attributes. Used in conjunction with appropriate filtering - by using the applicable Filter panel, or the Find Similar Objects dialog - it enables the display of just those objects falling under the scope of the active filter – allowing the designer to target and edit multiple design objects with greater accuracy and efficiency.

Sheet Symbol Actions

Right-click over a placed sheet symbol to pop-up a context-sensitive menu, from which the following commands are available (on the Sheet Symbol Actions sub-menu) that act on that sheet symbol (or all currently selected sheet symbols, where applicable).

The Sheet Symbol Actions sub-menu

• Open SubSheet "<SheetName.SchDoc>" - use to access the child sheet referenced by the symbol, which will be opened (if not already) and made the active document in the main design window.
• Create Sheet From Sheet Symbol - use to create a new schematic document from the sheet symbol and add ports to that document corresponding to each of the sheet entries on the symbol. In this way, you can automatically create the sub-sheets for a multi-sheet schematic design based on the sheet symbols you have created and placed on the top sheet.

• Create VHDL File From Sheet Symbol - use to create a VHDL file from the sheet symbol. The sheet entries on the symbol will be included as declared ports in the VHDL document's entity definition. The template for the architecture of the file will be defined, but the component and signal declarations are left ready for you to code in.
• Create Verilog File From Sheet Symbol - use to create a Verilog file from the sheet symbol. In this way, you can automatically create Verilog sub-modules for each of the sub-sheets of a multi-sheet schematic design, based on the sheet symbols you have created and placed on the top sheet.
• Rename Child Sheet - use to quickly rename the child schematic sheet referenced by the sheet symbol. The Rename Child Sheet dialog will appear, with which to specify the new name for the document as required, as well as the scope of the renaming action.
• Synchronize Sheet Entries and Ports - use to synchronize the sheet entries and sub-sheet ports for the sheet symbol. The Synchronize Ports To Sheet Entries dialog will appear. Use this dialog to ensure that all sheet entries on the sheet symbol are matched to ports on the referenced child sheet below, both in terms of name and I/O Type.
• Flip Sheet Symbol Along X - use to flip the sheet symbol along the X-axis. The sheet entries associated with the symbol will essentially be swapped to the opposite side of the symbol (in the horizontal plane). Those on the left will be repositioned on the right and vice-versa.

Example of flipping a sheet symbol along the X-axis

• Flip Sheet Symbol Along Y - use to flip the sheet symbol along the Y-axis. The sheet entries associated with the symbol will essentially be swapped to the opposite side of the symbol (in the vertical plane). Those at the top will be repositioned at the bottom and vice-versa.

Example of flipping a sheet symbol along the Y-axis

• Toggle All Sheet Entries IO Type in Sheet Symbol - use to toggle the I/O Type for all sheet entries in the sheet symbol simultaneously and where applicable.

Example result of toggling sheet entry I/O

The actual change depends on the current I/O Type as follows:

• Unspecified remains Unspecified.
• Output changes to Input.
• Input changes to Output.
• Bidirectional remains Bidirectional.

Notes

• If a group of sheet entries is pasted into a selected sheet symbol and those entries fall outside the current bounds of the symbol, it will automatically be resized to accommodate them.
• By using sheet symbol instantiation, multiple channels on the same sub-sheet can be referenced from a single sheet symbol. The syntax used involves the use of the Repeat keyword in the sheet symbol's Designator field and takes the form:
  
  Repeat(SheetSymbolDesignator, FirstInstance, LastInstance),
  
  where SheetSymbolDesignator is the base name for the sheet symbol and FirstInstance and LastInstance together define the number of channels to be instantiated. The FirstInstance parameter must start at a value of one (1) onwards.
• Multiple sub-sheets may be referenced by a single sheet symbol. Separate each filename by a semi-colon in the Filename field. With the effective use of off-sheet connectors placed on the sub-sheets, you can effectively spread a section of your design over multiple sheets, treated as though they were one giant (flat) sheet. Note, however, that use of off-sheet connectors is only possible for sheets referenced by the same sheet symbol.