IEaxHeaderPart.Text

Fore Syntax

Text: String;

Fore.NET Syntax

Text: string;

Description

The Text property determines text for a part of express report header.

Comments

Static text and tags can be used to form headers and footers.

Substitution/tag	Description
&[Page]	Inserts the current page number in the current position.
&[Pages]	Inserts the number of pages of the report in the current position.
&[Date]	Inserts the current date in the current position.
&[Time]	Inserts the current time in the current position.
&[Name]	Inserts the report name in the current position.
&[Globals.<Variable identifier>]	Displays value of the global variable in the current position.
&[Picture]	Uses an image in the current position.
&[Selection]	Shows names of displayed fixed dimensions in the current position.
&[<Dimension ID>.Selection]	Shows selection for the specified dimension in the current position.

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

Format. Determines selection display format. To create the format, use reserved words Name and Value, that are replaced with dimension name and its selection respectively. Format examples:
- Name: Value
- Value (Name)
- Name (Value)
- Value
Part. Determines dimension selection depending on their location on the Selection panel. Available options:
- Rows. Dimensions arranged by rows
- Columns. Dimensions arranged by columns
- Fixed. Fixed dimensions.

Examples of tags related to selection:

&[Selection Part = "Columns" Format = "Value"]

Selection in the dimension shown in rows is displayed in the current position.

&[D_TO.Selection Format = "Value (Name)"]

Selection of the dimension with the identifier D_TO is displayed in the current position, dimension name is specified in brackets.

It is possible to get actual text, that will be formed using the tags, with the method IGxDocument.GetTagText.

Fore Example

Executing the example requires that the repository contains an express report with the EXPRESS_REPORT identifier.

Add links to the Drawing, Express, Metabase system assemblies.

Sub UserProc;
Var
    MB: IMetabase;
    Expr: IEaxAnalyzer;
    Header: IEaxHeader;
    HeaderPart: IEaxHeaderPart;
Begin
    MB := MetabaseClass.Active;
    Expr := MB.ItemById("EXPRESS_REPORT").Edit As IEaxAnalyzer;
    Header := Expr.Header;
    HeaderPart := Header.Center;
    HeaderPart.Font := New GxFont.Create("Times New Roman", 14);
    HeaderPart.Color := GxColor.FromName("Blue");
    HeaderPart.Text := "&[Name]";
    (Expr As IMetabaseObject).Save;
End Sub UserProc;

After executing the example, central part of the express report header will show title of the express report. The font name is Times New Roman, font size is 14, font color is blue.

Fore.NET Example

The requirements and result of the Fore.NET Example execution match with those in the Fore Example.

Imports Prognoz.Platform.Interop.Drawing;
Imports Prognoz.Platform.Interop.Express;
…

Public Shared Sub Main(Params: StartParams);
Var
    MB: IMetabase;
    Expr: IEaxAnalyzer;
    Header: IEaxHeader;
    HeaderPart: IEaxHeaderPart;
    GxColorCls: GxColorClass = New GxColorClassClass();
    HeaderFont: GxFont = New GxFontClass();
Begin
    MB := Params.Metabase;
    Expr := MB.ItemById["EXPRESS_REPORT"].Edit() As IEaxAnalyzer;
    Header := Expr.Header;
    HeaderPart := Header.Center;
    HeaderFont.Create("Times New Roman", 14, GxFontStyle.gfsRegular, GxUnit.guPoint);
    HeaderPart.Font := HeaderFont;
    HeaderPart.Color := GxColorCls.FromName("Blue");
    HeaderPart.Text := "&[Name]";
    (Expr As IMetabaseObject).Save();
End Sub;