[Description("A string used to dynamically create the header or footer element's text. Use DATETIME to print current date, PAGE to print page number and TOTALPAGES to print the total number of pages.")]
[Category("Appearance")]
[Localizable(true)]
[DefaultValue("")]
[EndUserDisplayName("Text")]
public string TextFormat {get; set;}

'Declaration
 
<DescriptionAttribute("A string used to dynamically create the header or footer element's text. Use DATETIME to print current date, PAGE to print page number and TOTALPAGES to print the total number of pages.")>
<CategoryAttribute("Appearance")>
<LocalizableAttribute(True)>
<DefaultValueAttribute("")>
<EndUserDisplayNameAttribute("Text")>
Public Property TextFormat As String

'Usage
 
Dim instance As HeaderFooterElement
Dim value As String
 
instance.TextFormat = value
 
value = instance.TextFormat

Property Value

A string used to dynamically create the HeaderFooterElement's text. By default, "".

The following table provides a list of the supported variables and their definitions.

All items placed in square brackets [] are optional. If the format_specifier contains spaces, then quotes must be used.

In addition to the default variables, custom variables can be provided through the ReportSettings.CustomVariables property. The string representation of the default variables as well as the custom ones can be modified during the QueryVariableText event.

Dim report As New Report( GridControl1 )
report.ReportStyleSheet.PageHeader.LeftElement.TextFormat = "The current date is: %DATETIME format=""dd MMM yy""%"
report.PrintPreview()

Report report = new Report( gridControl1 );
report.ReportStyleSheet.PageHeader.LeftElement.TextFormat = "The current date is: %DATETIME format=\"dd MMM yy\"%";
report.PrintPreview();

The HeaderFooterElement's text will be displayed over its image.

The DATETIME variable will only be evaluated once at the beginning. All other variables will be evaluated for each page.

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

HeaderFooterElement Class
HeaderFooterElement Members