IHeaderPart.Text

Syntax

Text: String;

Description

The Text property determines header/title part text.

Comments

To display header/title text, set its color in the Color property. To set text, one can use static text and special substitutions/tags:

Substitution/tag	Description
&[Page]	It inserts the current page number to the current position.
&[Pages]	It inserts the number of pages of the report to the current position.
&[Date]	It inserts the current date to the current position.
&[Time]	It inserts the current time to the current position.
&[Name]	It inserts the report name to the current position.
&[Sheet.Page]	It inserts the number of the page on the current sheet.
&[Sheet.Pages]	It inserts the number of pages of the current report sheet to the current position.
&[Picture]	It insert an image to the current position.
&[Globals.<Variable identifier>]	It inserts global variable value to the current position.
&[<Slice identifier>.Selection]	It inserts the selection by fixed dimensions of the slice to the current position.
&[<Slice identifier>.<Dictionary identifier>.Selection]	It inserts the selection by the selected dimension to the current position.
&[<Sheet identifier>.<Control identifier>.Value]	It inserts value of control to the current position. Sheet identifier in the tag can be skipped if the control is available for all sheets.

Advanced attributes can be used for the tags related to dimensions selection:

Format – it determines selection output format. To create the format, use words Name and Value that will be replaced with dimension name and its selection respectively. Format examples:
- Name: Value
- Value (Name)
- Name (Value)
- Value

This attribute can also be used for the tag linked with value of the control. In this case Name and Value will be replaced with name and value of the control.

Part – it determines which dimensions will be selected depending on their position in the slice. Available options:
- Rows - dimensions arranged by rows.
- Columns - dimensions arranged by columns.
- Fixed - fixed dimensions.

Tag examples:

&[Slice1.Selection Part = "Columns" Format = "Name: Value"]

Information about dimensions arranged by rows is displayed in the current position: first, dimension name, then dimension selection.

&[ITEM1.Value Format = "Name: Value"]

Name of the control and then its value are displayed in the current position.

&[Slice1.D_TO.Selection Format = "Name: Value"]

Name of the specified dimension and then its selection are displayed in the current position.

One can get actual text that will be formed using the tags using the IGxDocument.GetTagText method.

Example

The property use is given in the example for IHeaderPart.Font.