XtraReport.PaperKind Property

Gets or sets the report’s paper kind.

Namespace: DevExpress.XtraReports.UI

Assembly: DevExpress.XtraReports.v18.2.dll

Declaration

C#

[SRCategory(ReportStringId.CatPageSettings)]
[DefaultValue(PaperKind.Letter)]
public PaperKind PaperKind { get; set; }

VB.NET

<SRCategory(ReportStringId.CatPageSettings)>
<DefaultValue(PaperKind.Letter)>
Public Property PaperKind As PaperKind

Property Value

Type	Default	Description
PaperKind	**Letter**	The report’s paper kind.

Remarks

Set the paper type to the Custom value to specify the report’s XtraReport.PageWidth, XtraReport.PageHeight, and XtraReport.PageSize. Any other paper kind value sets the predefined report page width, height and size.

Note

The default PaperKind value depends on the global Report Units value:

• Report Units = TenthsOfAMillimeter: the PaperKind property is set to A4.
• Report Units = HundredthsOfAnInch: the PaperKind property is set to Letter.

If the PaperKind property is set to Custom, the printer paper is selected according to the XtraReport.PaperName property value. In this case, set the XtraReport.PageWidth and XtraReport.PageHeight properties to paper’s width and height.

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 DevExpress.XtraReports.UI;

// ...

public static XtraReport CreateReport() {

    // Create an XtraReport instance
    XtraReport report = new XtraReport() {
        Name = "SimpleStaticReport",
        DisplayName = "Simple Static Report",
        PaperKind = PaperKind.Letter,
        Margins = new Margins(100, 100, 100, 100)
    };

    // Create a Detail band for the report
    DetailBand detailBand = new DetailBand() {
        HeightF = 25
    };

    // Add the created Detail band to the report
    report.Bands.Add(detailBand);

    // Create an XRLabel control for the report
    XRLabel helloWordLabel = new XRLabel() {
        Text = "Hello, World!",
        Font = new Font("Tahoma", 20f, FontStyle.Bold),
        BoundsF = new RectangleF(0, 0, 250, 50),
    };

    // Add the created XRLabel to the Detail band
    detailBand.Controls.Add(helloWordLabel);

    // Return the report with a band and a label on it
    return report;
}

VB.NET

Imports DevExpress.XtraReports.UI

' ...

Public Shared Function CreateReport() As XtraReport

    ' Create an XtraReport instance
    Dim report As New XtraReport() With {
        .Name = "SimpleStaticReport",
        .DisplayName = "Simple Static Report",
        .PaperKind = PaperKind.Letter,
        .Margins = New Margins(100, 100, 100, 100)
        }

    ' Create a Detail band for the report
    Dim detailBand As New DetailBand() With {
        .HeightF = 25
        }

    ' Add the created Detail band to the report
    report.Bands.Add(detailBand)

    ' Create an XRLabel control for the report
    Dim helloWordLabel As New XRLabel() With {
        .Text = "Hello, World!",
        .Font = New Font("Tahoma", 20F, FontStyle.Bold),
        .BoundsF = New RectangleF(0, 0, 250, 50)
        }

    ' Add the created XRLabel to the Detail band
    detailBand.Controls.Add(helloWordLabel)

    ' Return the report with a band and a label on it
    Return report
End Function

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the PaperKind property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

how-to-convert-and-then-print-an-gridview-extension-by-using-the-xtrareport-e4755/CS/E4755/Models/ReportHelperMVC.cs#L31

report.Landscape = true;
report.PaperKind = System.Drawing.Printing.PaperKind.Letter;

reporting-winforms-best-fit-table-column-width/CS/ReportHelper/ReportHelper.cs#L25

private void InitializeReport(XtraReport targetReport) {
    targetReport.PaperKind = PaperKind.Custom;
    targetReport.ReportUnit = ReportUnit.Pixels;

how-to-convert-and-then-print-gridcontrol-by-using-xtrareport-e4658/CS/DXGridSample/ReportHelper.cs#L30

report.Landscape = true;
report.PaperKind = System.Drawing.Printing.PaperKind.Letter;

Reporting_how-to-create-a-hierarchical-report-t456484/CS/TreeViewReport/ChildReport.cs#L25

XtraReport report = subreport.ReportSource;
report.PaperKind = System.Drawing.Printing.PaperKind.Custom;
report.PageWidth = (int)(PrintingSystem.PageSettings.UsablePageSize.Width - subreport.LocationF.X * (level - 1) + report.Margins.Right);

Reporting_wpf-report-designer-how-to-register-a-custom-page-in-the-report-wizard-t600080/CS/CustomReportWizard/WizardCustomizationService.cs#L48

report = new XtraReport();
report.PaperKind = customModel.PaperKind;
report.Margins = customModel.PageMargins;

VB.NET

how-to-convert-and-then-print-an-gridview-extension-by-using-the-xtrareport-e4755/VB/E4755/Models/ReportHelperMVC.vb#L32

report.Landscape = True
report.PaperKind = System.Drawing.Printing.PaperKind.Letter

reporting-winforms-best-fit-table-column-width/VB/ReportHelper/ReportHelper.vb#L24

Private Sub InitializeReport(ByVal targetReport As XtraReport)
    targetReport.PaperKind = PaperKind.Custom
    targetReport.ReportUnit = ReportUnit.Pixels

how-to-convert-and-then-print-gridcontrol-by-using-xtrareport-e4658/VB/DXGridSample/ReportHelper.vb#L30

report.Landscape = True
report.PaperKind = System.Drawing.Printing.PaperKind.Letter

Reporting_how-to-create-a-hierarchical-report-t456484/VB/TreeViewReport/ChildReport.vb#L27

Dim report_Renamed As XtraReport = subreport.ReportSource
report_Renamed.PaperKind = System.Drawing.Printing.PaperKind.Custom
report_Renamed.PageWidth = CInt(Math.Truncate(PrintingSystem.PageSettings.UsablePageSize.Width - subreport.LocationF.X * (level - 1) + report_Renamed.Margins.Right))

Reporting_wpf-report-designer-how-to-register-a-custom-page-in-the-report-wizard-t600080/VB/CustomReportWizard/WizardCustomizationService.vb#L52

report = New XtraReport()
report.PaperKind = customModel.PaperKind
report.Margins = customModel.PageMargins