Text Substitution Parameters for Titles, Headers, Footers and Columns

Several text substitution parameters are available for customizing your report’s title, page header and page footer.

Text Substitution Parameter	Description
${ReportTitle}	A report title specified in the page’s code-behind file. For details, see Customizing PDF Report Code.
${PageLabel}	A page label specified in the “Txt:Page” resource in your application’s resource file (RESX). Your application’s resource file is located in: ...\App_GlobalResources\<App Name>.resx
${PageNum}	An automatically incrementing page number. The first page is numbered “1”, the second page is “2” and so forth.
${Date:?)	A date or time where “?” is a letter indicating the .NET date and time format. For more information, visit: http://msdn2.microsoft.com/en-us/library/az4se3k1(VS.71).aspx http://msdn2.microsoft.com/en-us/library/hc4ky857(VS.71).aspx

These substitution parameters are typically used in the following context:

<Value>${PageNum}</Value>

</Footer>

There are several caveats.

Column headers do not accept any substitution parameters.

For the column detail, the available substitution parameters are specified in the AddData() function calls in the page’s code-behind file. For example:

report.AddData ("${Customers.CustomerID}",

record.Format(CustomersTable.CustomerID),

ReportEnum.Align.Left,

100)

The available substitution parameter is "${Customers.CustomerID}" representing the value of the CustomerID in each row.

You can combine several substitution parameters together. For example, in page headers and footers, you can use

<Value>${PageLabel} ${PageNum}</Value>

In the column detail, you can use

<Value>${Customers.LastName}, {Customers.FirstName}</Value>

Finally, if there is no column specified in the button-specific configuration file, your application will still read the .report files. However, the table is created according to the AddColumn function calls in the page’s code-behind file.

Text Substitution Parameters for Titles, Headers, Footers and Columns

See Also