Text element properties

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


General properties

In the Advanced 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
Heading level offset 0 to 20 Increases the heading level by the specified number of pixels
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 Advanced 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.


Data properties

The Data tab is only visible in the Properties view when there is a query added to the element. In the Advanced 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 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 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 Advanced properties tab, these properties are located in the Formatting > Date, Formatting > Data, and Formatting > Image sections.

Type Value Description
Date pattern yyyy-MM-dd, yyyy-dd-MM The format that the date displays in.
Data formatting mixed, source, or template Controls how Rational Publishing Engine formats rich data from the data source:
  • Mixed: Mixes source and template formatting.
  • Source: Discards template formatting and preserves data source formatting only.
  • Template: Discards source formatting and preserves template formatting only.
List indent 0 to any number The number of pixels between the page margin and the list element.
Image width Number The number of pixels or points horizontally the image is.
Image height Number The number of pixels or points vertically the image is.
Image max width Number The maximum number of pixels or points horizontally the image is. If the image is more than the value entered, the image is scaled proportionally to that number.
Image max height Number The maximum number of pixels or points vertically the image is. If the image is more than the value entered, the image is scaled proportionally to that number.


Font properties

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

Type Value Description
Font 000000 to FFFFFF The hexadecimal color of the text in the element. Some output formats accept transparent as a value.

Example:

Font color example

Size 1 to 1638 The point size of the text in the element

Example:

Font size example

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
Strikethrough true, false, double Creates a horizontal line through the center of the text

Example:

Strikethrough example

Character spacing -1500 to 1500 Spaces between text characters

Example:

Character spacing example

Character position -1500 to 1500 The vertical position of the text relative to the normal text position

Examples:

Positive character spacing example
Negative character spacing example

Character kerning 8 to 72 Allows each letter of text to overlap into the space of another
Character scale 33 to 200 Percent multiplied by the text size

Example:

Character scale example

Superscript true, false Decreases the size of the text and moves it upward on the line

Example:

Superscript example

Subscript true, false Decreases the size of the text and moves it downward on the line

Example:

Subscript 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.


Border properties

In the Advanced properties tab, these properties are located in the Formatting > Border sections.

Type Value Description
Margin 0 to 1000 The white space between the sides of the text the border style property is applied to and any other text or element

Example:

All borders margin example

Style none, single, thick, double, hairline, dotted, dash large gap, dot dash, dot dot dash, triple, thin thick small gap, thick thin small gap, thin thick thin small gap, thin thick medium gap, thick thin medium gap, thin thick thin medium gap, thin thick large gap, thick thin large gap, thin thick thin large gap, wave, double wave, dash small gap, dash dot stroker, emboss 3D, engrave 3D, outset, inset, groove, ridge, dashed, hidden The type of border used around the side of the element
Color 000000 to FFFFFF The hexadecimal color of the border on the side of the text in the element
Width 0 to 30 The number of pixels the width of the border of the side of the element is.


Color properties

In the Advanced properties tab, these properties are located in the Formatting > color section.

Type Value Description
Background color 000000 to FFFFFF The hexadecimal color of the element background.
Foreground color 000000 to FFFFFF The hexadecimal color of the element foreground.
Foreground density 0 to 30, cross, dark cross, dark diagonal down, dark diagonal up, dark horizontal, dark vertical, diagonal cross, diagonal down, diagonal up, horizontal, none, solid, vertical The style of the foreground color density.

Feedback