Hyperlink element properties

Open the Properties view in Document Studio and select a Hyperlink element. The Properties view displays these available properties for hyperlinks.


General properties

In the All properties tab, these properties are located at the top-level, in the Metadata, and in the Formatting > Common sections.

Type Value Description
Tag String Tag name for the element. This property cannot be edited.
Name String The name of the element.
Description String A summary or note about this element.
Assignment String The variables that are assigned to the element.
Condition String A script that can apply variables or attributes as conditions on the element.
Master page String Name of the master page applied to the element.
Force page change true, false When true, a page break is inserted if current master page is similar to previous one.
Target region String Writes current element in the specified region.
Style name String Name of the style that is applied to the element.


Content properties

In the All properties tab, this property is located at the top-level as Content.

Type Value Description
Content String The text contained in the element which is visible in the output. Entering text here is the same as double-clicking on the element and entering text.


Data properties

The Data tab is only visible in the Properties view when there is a query added to the element. In the All properties tab, these properties are located at the top-level and in the Data sections.

Type Value Description
Data Source String The data source schema name. You cannot edit this property. Example: Generic XML 1
Context String If the query is on an element nested within another element, the context of the parent element is listed for this property. You cannot edit this property. Example: $7 is the context for the parent element.
Query String The name of the query as specified in the data source schema.
Sort String The Rational® Publishing Engine or native sort applied to the element.
Limit String Enter a number to generate only a certain number of data values in your output.
Filter String The Rational Publishing Engine or native filter applied to the element.
Recursive Level Number Instead of adding a query and each of its child queries in your template to extract a set of data, you can use the Recursive Level and Recursive Segments. Use these properties together to specify only the parent query in your template and extract data from that query and all of its child queries.

The Recursive Level is the number of times the recursive segments in the query are repeated. Example: In the query Module/Object/Link/Linked Object, if you entered 2 for the recursive segment value and 3 for the recursive level value, Link/Linked Object would repeated 3 times. The resulting query is Module/Object/Link/Linked Object/Link/Linked Object/Link/Linked Object.

Recursive Segments Number Instead of adding a query and each of its child queries in your template to extract a set of data, you can use the Recursive Level and Recursive Segments. Use these properties together to specify only the parent query in your template and extract data from that query and all of its child queries.

The number of segments in the query that are to be repeated. Example: In the query Module/Object/Link/Linked Object, if you entered 2 for the recursive segment value, Link/Linked Object are the segments that are repeated.


Specific properties

In the All properties tab, these properties are located in the Formatting > specific section.

Type Value Description
Display String Enter the text that displays in the output in place of the hyperlink itself.
Internal true, false If the link is internal to this document, such as a link to another section, enter true. If the link is external, such as a web page, enter false.
Local true, false If the Internal property is set to true and the Local property is set to true, a bookmark in the current template is being referenced. If the Internal property is set to true and the Local property is set to false, a bookmark in another template is being referenced.


Font properties

In the All properties tab, these properties are located in the Formatting > FontFormatting > Line, Formatting > Character, and Formatting > Effects sections.

Type Value Description
Font String, Cambria, Courier New, Georgia, Helvetica, Lucida, Tahoma, Times New Roman, Verdana Select one of the common fonts available in the dropdown menu or type the name of another font on your computer to use.
Size 1 to 1638 The point size of the text in the element. You can select a value from the dropdown menu or type a value between the supported sizes.

Example:

Font size example

Color 000000 to FFFFFF The hexadecimal color of the text in the element.

Example:

Font color example

Note: The value transparent is only supported for XSL-FO output.
Bold true, false Applies bold styling

Example:

Bold example

Italic true, false Applies italic styling

Example:

Italic example

Underline true, false, single, words, double, dotted, thick, dash, dash long, dot dash, dot dot dash, wavy, dotted heavy, dash heavy, dash long heavy, dot dash heavy, dot dot dash heavy, wavy heavy, wavy double Creates a horizontal line beneath the text

Example:

Underline example

Overline true, false Creates a horizontal line over the text

Example:

Overline example

Strikethrough true, false, double Creates a horizontal line through the center of the text

Example:

Strikethrough example

Shadow true, false Creates a shadow on the text

Example:

Shadow example

Outline true, false Creates an outline around the text

Example:

Outline example

Emboss true, false Creates an emboss around the text

Example:

Emboss example

Engrave true, false Creates an engrave around the text

Example:

Engrave example

Small caps true, false Changes lowercase letters into capital letters

Example:

Small caps example

All caps true, false Changes all letters into capital letters

Example:

All caps example

Hidden true, false Removes the text from the output.
Underline color 000000 to FFFFFF The hexadecimal color of the line underneath the text in the element.

Feedback