TGML Link Element

<Link> represents a hyperlink to another presentation stored in the database, or file system, of the connected server. Examples of presentation objects are: TGML graphics files, trend log views and on-line plots.

Link indicates that the immediate parent shape or container element is a hyperlink object, which the user can click to navigate to another presentation.

A Link is bound to a presentation object on the server with the same technique used for Dynamics. The Name attribute of the Link element is exposed as a connection point to which the presentation object is connected in the Graphics Editor. For more information, see the TGML Dynamics section.

The Link element has a Description attribute that you can use to add a description of the link. You can expose Description along with Name and present it to the user by binding it in the Graphics Editor.

Link makes the parent element an interactive element, and a TGML viewer is supposed to open the linked presentation object when the user clicks the element.

Attribute	Type	Description
Description	String	A user-defined description of the link. Inheritable: No Animatable: No
PreventDefault	Bool	Cancels the default action normally taken by the implementation, for example, the viewer. See Remarks. Default: "False" Inheritable: Yes Animatable: No

Remarks

The default action when the user clicks an element containing a Link element is to navigate to, or open, another presentation. When PreventDefault is set to "True" this action is canceled.

Example of text made into a link object:

Copy

<TGML>
    <Text...>
        Open Overview
        <Link Name="Overview" />
    </Text>
</TGML>

Only painted regions are clickable. Clicking a hollow shape, that is a shape with the Fill attribute set to "None", has no effect.