Altium Designer Documentation

RenameSheetSymbolFileName

Created: July 27, 2015 | Updated: April 11, 2017
Now reading version 17.1. For the latest, read: RenameSheetSymbolFileName for version 21
Applies to Altium Designer versions: 15.1, 16.0, 16.1, 17.0 and 17.1

Parent page: Schematic Commands

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


Applied Parameters: DocumentKind=Schematic|ObjectKind=SheetSymbol

Summary

This command is used to rename the child schematic sheet referenced by the chosen sheet symbol.

Access

This command is accessed in the Schematic Editor, by choosing the Design » Rename Child Sheet command from the main menus.

Use

After launching the command, the cursor will change to a cross-hair, and you will be prompted to choose a sheet symbol. Position the cursor over the sheet symbol whose referenced schematic child sheet you wish to rename, and click, or press Enter.

The Rename Child Sheet dialog will appear. Use this dialog to specify the new name for the schematic sheet, making sure to keep the .SchDoc extension. Also determine how the renaming should proceed - the scope of the operation - from the following options:

  • Rename the child sheet, and update all sheet symbols on source schematics in the active project that point to this sheet. The Filename field for each sheet symbol will be updated to reflect the newly named child sheet.
  • Rename the child sheet, and update all sheet symbols on source schematics across all open projects, that point to this sheet. The Filename field for each sheet symbol will be updated to reflect the newly named child sheet.
  • Take a copy of the child sheet to use, leaving the original sheet intact. Only the chosen sheet symbol is updated using this option. The Filename field for the sheet symbol will be updated to reference the copied child sheet.

Tips

  1. Taking a copy of the child sheet is useful when the current child sheet is referenced by multiple sheet symbols, and one sheet symbol needs to reference a modified version of the circuitry contained on that sheet. You still want to keep the original sheet, you are simply creating a renamed copy of this sheet with which to point to from a single sheet symbol. You can then modify the content of the copied sheet as required.
  2. To ensure that the newly-named child sheet is correctly inserted into the design hierarchy of each affected project - reflected in the Projects panel - either opt to automatically compile after the renaming process finishes, or recompile manually thereafter.


Applied Parameters: ContextSensitive=True|DocumentKind=Schematic|ObjectKind=SheetSymbol

Summary

This command is used to rename the child schematic sheet referenced by the sheet symbol under the cursor.

Access

This command is accessed in the Schematic Editor, by right-clicking over a placed sheet symbol and choosing the Sheet Symbol Actions » Rename Child Sheet command from the context menu.

Use

After launching the command, the Rename Child Sheet dialog will appear. Use this dialog to specify the new name for the schematic sheet, making sure to keep the .SchDoc extension. Also determine how the renaming should proceed - the scope of the operation - from the following options:

  • Rename the child sheet, and update all sheet symbols on source schematics in the active project that point to this sheet. The Filename field for each sheet symbol will be updated to reflect the newly named child sheet.
  • Rename the child sheet, and update all sheet symbols on source schematics across all open projects, that point to this sheet. The Filename field for each sheet symbol will be updated to reflect the newly named child sheet.
  • Take a copy of the child sheet to use, leaving the original sheet intact. Only the sheet symbol under the cursor is updated using this option. The Filename field for the sheet symbol will be updated to reference the copied child sheet.

Tips

  1. Taking a copy of the child sheet is useful when the current child sheet is referenced by multiple sheet symbols, and one sheet symbol needs to reference a modified version of the circuitry contained on that sheet. You still want to keep the original sheet, you are simply creating a renamed copy of this sheet with which to point to from a single sheet symbol. You can then modify the content of the copied sheet as required.
  2. To ensure that the newly-named child sheet is correctly inserted into the design hierarchy of each affected project - reflected in the Projects panel - either opt to automatically compile after the renaming process finishes, or recompile manually thereafter.

 

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: