HyperLink Element

Publish

Platform_KC
On Premises

Description

Sets a relationship to a Hypertext Link object that defines the hyperlink that will be applied to the image of Windows Help, HTML or HTML based Help for this file. Unlike coded HTML or WinHelp RTF, the graphic or image does not simply act as the anchor for a hyperlink which is just part of the text. It is a separate relationship to the File object itself. If the File object is reused, the link also applies to each instance. Likewise, if the hyperlink in the File object is changed, it will apply automatically to all instances of the File object.

Note: This property applies to both Windows Help and HTML. Changes to one will also affect the other.

The Hyperlink element corresponds to the "Hyperlink" field on the Windows Help and HTML tabs of the File object.

Attributes

Attribute Name

Optional

Data Type

inherited

Yes

Boolean

Parent Element

File

Values

Data Type

Range

Integer

>= 0. A hyperlink object ID.

Sample XML

<HyperLink inherited="true">0</HyperLink>