XtraReport.DisplayName Property

Gets or sets the report’s display name. If the name is not empty, it serves as the default name of the exported document and appears in the End-User Designer‘s report tab. Otherwise, the value of the report’s Name property is used as a display name.

Namespace: DevExpress.XtraReports.UI

Assembly: DevExpress.XtraReports.v24.2.dll

NuGet Package: DevExpress.Reporting.Core

Declaration

C#

[DefaultValue("")]
[SRCategory(ReportStringId.CatDesign)]
[XRLocalizable(true)]
public string DisplayName { get; set; }

VB.NET

<DefaultValue("")>
<SRCategory(ReportStringId.CatDesign)>
<XRLocalizable(True)>
Public Property DisplayName As String

Property Value

Type	Default	Description
String	String.Empty	The report’s display name.

Remarks

The image below shows how the DisplayName property appears in the End-User Designer.

Example

The code sample below creates a new report, sets its name, display name, paper kind and margins, and adds the Detail Band band with the XRLabel control on it.

C#

using System.Drawing;
using DevExpress.Drawing;
using DevExpress.Drawing.Printing;
using DevExpress.XtraReports.UI;
// ...
public static XtraReport CreateReport() {
    XtraReport report = new XtraReport() {
        Name = "SimpleStaticReport",
        DisplayName = "Simple Static Report",
        PaperKind = DXPaperKind.Letter,
        Margins = new DXMargins(100, 100, 100, 100)
    };

    DetailBand detailBand = new DetailBand() {
        HeightF = 25
    };
    report.Bands.Add(detailBand);

    XRLabel helloWordLabel = new XRLabel() {
        Text = "Hello, World!",
        Font = new DXFont("Tahoma", 20f, DXFontStyle.Bold),
        BoundsF = new RectangleF(0, 0, 250, 50),
    };
    detailBand.Controls.Add(helloWordLabel);

    return report;
}

VB.NET

Imports System.Drawing
Imports System.Drawing.Printing
Imports DevExpress.Drawing
Imports DevExpress.Drawing.Printing
Imports DevExpress.XtraReports.UI
' ...
Public Shared Function CreateReport() As XtraReport
    Dim report As New XtraReport() With {
        .Name = "SimpleStaticReport",
        .DisplayName = "Simple Static Report",
        .PaperKind = DXPaperKind.Letter,
        .Margins = New DXMargins(100, 100, 100, 100)}

    Dim detailBand As New DetailBand() With {
        .HeightF = 25}
    report.Bands.Add(detailBand)

    Dim helloWordLabel As New XRLabel() With {
        .Text = "Hello, World!",
        .Font = New DXFont("Tahoma", 20.0F, DXFontStyle.Bold),
        .BoundsF = New RectangleF(0, 0, 250, 50)}
    detailBand.Controls.Add(helloWordLabel)

    Return report
End Function