List element properties

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


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 Default value: 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.


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 Default value: 0

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 Default value: 0

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 Default value: 1

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
List indent 0 to any number The number of pixels between the page margin and the list element.


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 Default value: 000000

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 Default value: false

true applies bold styling.

Example:

Bold example

Italic true, false Default value: false

true 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 Default value: false

true creates a horizontal line beneath the text.

Example:

Underline example

Overline true, false Default value: false

true creates a horizontal line over the text.

Example:

Overline example

Strikethrough true, false, double Default value: false

true creates a horizontal line through the center of the text.

Example:

Strikethrough example

Shadow true, false Default value: false

true creates a shadow on the text.

Example:

Shadow example

Outline true, false Default value: false

true creates an outline around the text.

Example:

Outline example

Emboss true, false Default value: false

true creates an emboss around the text.

Example:

Emboss example

Engrave true, false Default value: false

true creates an engrave around the text.

Example:

Engrave example

Small caps true, false Default value: false

true changes lowercase letters into capital letters.

Example:

Small caps example

All caps true, false Default value: false

true changes all letters into capital letters.

Example:

All caps example

Hidden true, false Default value: false

true removes the text from the output.

Underline color 000000 to FFFFFF Default value: 000000

The hexadecimal color of the line underneath the text in the element.

Numbering properties

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

Type Value Description
Font String The font type of the list. See Common font families.
Size 1 to 1638 The point size of the list
Color 000000 to FFFFFF The hexadecimal color of the text in the element. Some output formats accept transparent as a value.
Bold true, false Applies bold styling to a list
Italic true, false Applies italic styling to a list
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
Overline true, false Creates a horizontal line over the text
Strikethrough true, false, double Creates a horizontal line through the center of the text
Character position -1500 to 1500 The vertical position of the text in a list relative to the normal text position
Character spacing -1500 to 1500 Spaces between characters in a list
Character scale 33 to 200 Percent multiplied by the text size
Kerning for fonts 8 to 72 Allows each letter of text to overlap into the space of another
Superscript true, false Decreases the size of the text and moves it upward on the line
Subscript true, false Decreases the size of the text and moves it downward on the line
Shadow true, false Creates a shadow on the text
Outline true, false Creates an outline around the text
Emboss true, false Creates an emboss around the text
Engrave true, false Creates an engrave around the text
Small caps true, false Changes lowercase letters into capital letters
All caps true, false Changes all letters into capital letters
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.
Numbering style arabic, uppercase roman, lowercase roman, uppercase alpha, lowercase alpha, none The lettering or numbering used for a list.

bullet:  •
arabic: 1., 2., 3.
uppercase roman: I., II., III.
lowercase roman: i., ii., iii.
uppercase alpha: A., B., C.
lowercase alpha: a., b., c.

Numbering alignment left, right, center Where the lines within a list begin and end in relation to the list margins.

Left, right, and center alignment, create uneven line edges, fitting as many words in a line as possible.

Numbering indent double, 0 to any number The number of pixels of white space the list is from the page margin.
Restart numbering true, false Instead of continuing from the numbering of a previous list, you can begin the numbering again.
Level number 1 to 9 The number of nested headings that are used in the document. For example, to use Heading 1, Heading 2, and Heading 3 styles, enter 3.
Level indent 1 to 200 The number of pixels of white space from the page margin or the previous heading the current heading is.

Feedback