IntegratedLibrary_Cmd-ShowComponentLinkShowComponentLink_AD

Applied Parameters: Index=n (where n is in the range 1 to 10)

Summary

This command is used to open the indicated reference document - specified through a defined underlying ComponentLinknURL / ComponentLinknDescription parameter-pairing - for the selected component in the Libraries panel.

Access

With a ComponentLinknURL / ComponentLinknDescription parameter-pairing for the component already defined, the command is accessed by right-clicking in the Components or Models regions of the Libraries panel, and choosing the References » <ComponentLinknDescription> command from the context menu.

Use

To use this feature, first ensure that the two parameters for each ComponentLink pair have been added to the required component in the library, and configured as follows:

First parameter - used to define the target document:

• Parameter Name = ComponentLinknURL (where n is any integer value)
• Parameter Value = target document path\name. The following examples are valid entries for the value of the parameter:
  • C:\Design_Projects\Schematics\Modifications.txt
  • C:\Design_Projects\Schematics\MyDataSheet.pdf
  • https://www.altium.com
  • www.altium.com/documentation

Second parameter - used to define the entry that appears in the menu:

• Parameter Name = ComponentLinknDescription (where n is the same integer value used in the first parameter)
• Parameter Value = entry to appear in the menu.

Any number of ComponentLink parameter pairs can be defined, each pair is associated by sharing the same value for n.

After launching the command, the indicated target document will be opened. A web-based URL target page will open directly (if available). For a PDF or text document, a search for the document is conducted as follows:

• If a path to it is specified, this location is searched first,
• If the document cannot be found at this location, or if no path is specified, the \Help folder of the Altium Designer installation is searched.

Tips

1. A web-based URL will be open either in an external browser, or as a tabbed document within Altium Designer, as determined by the Open internet links in external Web browser option, on the System - View page of the Preferences dialog. Bear in mind that to open in an external browser, the value for the ComponentLinknURL parameter must include the http:// prefix.