Altium Designer Documentation

CrossReference

Created: September 18, 2021 | Updated: September 18, 2021

Parent page: Schematic Commands

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


Applied Parameters: Action=AddToProject

Summary

This command is used to add port cross-referencing information to all source schematic documents in the active project.

Access

This command is accessed from the Schematic Editor by choosing the Reports » Port Cross Reference » Add To Project or Update On Project command from the main menus.

This command is only available if the Schematic.UseAutomaticCrossReferences option is disabled in the Advanced Settings dialog.
The Add To Project command displays when there are currently no port cross references in the project. The Update On Project command displays if the project currently has port cross references.
Use

After launching the command a string will be included or updated, where applicable, next to each port, across all sheets in the active project, detailing the sheet name and grid reference of the entity to which the port connects - other ports of the same name (when the Net Identifier Scope is Flat or Global), or a sheet entry in a parent sheet symbol (when the Net Identifier Scope is Hierarchical, or Strict Hierarchical).

Tips

  1. Cross reference information is added as a parameter to a port. The name of the parameter is simply CrossRef. With the parameter selected in the workspace, you can modify its display properties as required through the Parameters section of the Properties panel, which presents the full complement of properties for the parent port object.
  2. On the Schematic - General page of the Preferences dialog in the Port Cross References region, you can configure the cross references Sheet Style and Location Style.


Applied Parameters: ContextSensitive=True|Action=AddToProject

Summary

This command is used to add port cross-referencing information to all source schematic documents in the active project.

Access

This command is accessed from the Schematic Editor by right-clicking in the workspace - away from any design objects - and choosing the Sheet Actions » Port Cross Reference » Add To Project or Update On Project command from the main menus.

This command is only available if the Schematic.UseAutomaticCrossReferences option is disabled in the Advanced Settings dialog.
Use

After launching the command a string will be included or updated, where applicable, next to each port, across all sheets in the active project, detailing the sheet name and grid reference of the entity to which the port connects - other ports of the same name (when the Net Identifier Scope is Flat or Global), or a sheet entry in a parent sheet symbol (when the Net Identifier Scope is Hierarchical, or Strict Hierarchical).

Tips

  1. Cross reference information is added as a parameter to a port. The name of the parameter is simply CrossRef. With the parameter selected in the workspace, you can modify its display properties as required through the Parameters section of the Properties panel, which presents the full complement of properties for the parent port object.
  2. On the Schematic - General page of the Preferences dialog in the Port Cross References region, you can configure the cross references Sheet Style and Location Style.


Applied Parameters: Action=RemoveFromProject

Summary

This command is used to remove port cross-referencing information from all source schematic documents in the active project.

Access

This command is accessed from the Schematic Editor by choosing the Reports » Port Cross Reference » Remove From Project command, from the main menus.

This command is only available if the Schematic.UseAutomaticCrossReferences option is disabled in the Advanced Settings dialog.

Use

After launching the command, the cross reference parameter (CrossRef) will be removed from each applicable port, across all sheets in the active project.


Applied Parameters: ContextSensitive=True|Action=RemoveFromProject

Summary

This command is used to remove port cross-referencing information from all source schematic documents in the active project.

Access

This command is accessed from the Schematic Editor by right-clicking in the workspace - away from any design objects - and choosing the Sheet Actions » Port Cross Reference » Remove From Project command, from the main menus.

This command is only available if the Schematic.UseAutomaticCrossReferences option is disabled in the Advanced Settings dialog.

Use

After launching the command, the cross reference parameter (CrossRef) will be removed from each applicable port, across all sheets in the active project.

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

お問合せ

お近くの営業所にお問合せください。

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: