Altium Designer Documentation

CrossReference

Created: July 27, 2015 | Updated: April 11, 2017
Now reading version 17.1. For the latest, read: CrossReference 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: Action=AddToDocument

Summary

This command is used to add port cross-referencing information to the current schematic document.

Access

This command is accessed from the Schematic Editor by choosing the Reports » Port Cross Reference » Add To Sheet command, from the main menus.

The project must be compiled before this command becomes available to use.

Use

After launching the command a string will be included, where applicable, next to each port, 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. As a standard parameter, you can modify its display properties as required - for more information, refer to the editing section of the Parameter object page.


Applied Parameters: ContextSensitive=True|Action=AddToDocument

Summary

This command is used to add port cross-referencing information to the current schematic document.

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 Sheet command, from the main menus.

The project must be compiled before this command becomes available to use.

Use

After launching the command a string will be included, where applicable, next to each port, 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. As a standard parameter, you can modify its display properties as required - for more information, refer to the editing section of the Parameter object page.


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 command, from the main menus.

The project must be compiled before this command becomes available to use.

Use

After launching the command a string will be included, 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. As a standard parameter, you can modify its display properties as required - for more information, refer to the editing section of the Parameter object page.


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 command, from the main menus.

The project must be compiled before this command becomes available to use.

Use

After launching the command a string will be included, 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. As a standard parameter, you can modify its display properties as required - for more information, refer to the editing section of the Parameter object page.


Applied Parameters: Action=RemoveFromDocument

Summary

This command is used to remove port cross-referencing information from the current schematic document.

Access

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

Use

After launching the command, the cross reference parameter (CrossRef) will be removed from each applicable port on the current sheet.


Applied Parameters: ContextSensitive=True|Action=RemoveFromDocument

Summary

This command is used to remove port cross-referencing information from the current schematic document.

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 Sheet command, from the main menus.

Use

After launching the command, the cross reference parameter (CrossRef) will be removed from each applicable port on the current sheet.


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.

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.

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.

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: