XtraReport.PaperKind Property

Gets or sets the report’s paper kind.

Namespace: DevExpress.XtraReports.UI

Assembly: DevExpress.XtraReports.v24.1.dll

NuGet Package: DevExpress.Reporting.Core

Declaration

C#

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

VB.NET

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

Property Value

Type	Default	Description
DXPaperKind	Letter	An enumeration value that indicates the paper size.

Available values:

Show 117 items

Name	Description
Custom	The paper size is defined by the user.
Letter	Letter paper (8.5 in. by 11 in.).
Legal	Legal paper (8.5 in. by 14 in.).
A4	A4 paper (210 mm by 297 mm).
CSheet	C paper (17 in. by 22 in.).
DSheet	D paper (22 in. by 34 in.).
ESheet	E paper (34 in. by 44 in.).
LetterSmall	Letter small paper (8.5 in. by 11 in.).
Tabloid	Tabloid paper (11 in. by 17 in.).
Ledger	Ledger paper (17 in. by 11 in.).
Statement	Statement paper (5.5 in. by 8.5 in.).
Executive	Executive paper (7.25 in. by 10.5 in.).
A3	A3 paper (297 mm by 420 mm).
A4Small	A4 small paper (210 mm by 297 mm).
A5	A5 paper (148 mm by 210 mm).
B4	B4 paper (250 mm by 353 mm).
B5	B5 paper (176 mm by 250 mm).
Folio	Folio paper (8.5 in. by 13 in.).
Quarto	Quarto paper (215 mm by 275 mm).
Standard10x14	Standard paper (10 in. by 14 in.).
Standard11x17	Standard paper (11 in. by 17 in.).
Note	Note paper (8.5 in. by 11 in.).
Number9Envelope	#9 envelope (3.875 in. by 8.875 in.).
Number10Envelope	#10 envelope (4.125 in. by 9.5 in.).
Number11Envelope	#11 envelope (4.5 in. by 10.375 in.).
Number12Envelope	#12 envelope (4.75 in. by 11 in.).
Number14Envelope	#14 envelope (5 in. by 11.5 in.).
DLEnvelope	DL envelope (110 mm by 220 mm).
C5Envelope	C5 envelope (162 mm by 229 mm).s
C3Envelope	C3 envelope (324 mm by 458 mm).
C4Envelope	C4 envelope (229 mm by 324 mm).
C6Envelope	C65 envelope (114 mm by 229 mm).
C65Envelope	C6 envelope (114 mm by 162 mm).
B4Envelope	B4 envelope (250 mm by 353 mm).
B5Envelope	B5 envelope (176 mm by 250 mm).
B6Envelope	B6 envelope (176 mm by 125 mm).
ItalyEnvelope	Italy envelope (110 mm by 230 mm).
MonarchEnvelope	Monarch envelope (3.875 in. by 7.5 in.).
PersonalEnvelope	6 3/4 envelope (3.625 in. by 6.5 in.).
USStandardFanfold	US standard fanfold (14.875 in. by 11 in.).
GermanStandardFanfold	German standard fanfold (8.5 in. by 12 in.).
GermanLegalFanfold	German legal fanfold (8.5 in. by 13 in.).
IsoB4	ISO B4 (250 mm by 353 mm).
JapanesePostcard	Japanese postcard (100 mm by 148 mm).
Standard9x11	Standard paper (9 in. by 11 in.).
Standard10x11	Standard paper (10 in. by 11 in.).
Standard15x11	Standard paper (15 in. by 11 in.).
InviteEnvelope	Invitation envelope (220 mm by 220 mm).
LetterExtra	Letter extra paper (9.275 in. by 12 in.). This value is specific to the PostScript driver and is used only by Linotronic printers in order to conserve paper.
LegalExtra	Legal extra paper (9.275 in. by 15 in.). This value is specific to the PostScript driver and is used only by Linotronic printers in order to conserve paper.
TabloidExtra	Tabloid extra paper (11.69 in. by 18 in.). This value is specific to the PostScript driver and is used only by Linotronic printers in order to conserve paper.
A4Extra	A4 extra paper (236 mm by 322 mm). This value is specific to the PostScript driver and is used only by Linotronic printers to help save paper.
LetterTransverse	Letter transverse paper (8.275 in. by 11 in.).
A4Transverse	A4 transverse paper (210 mm by 297 mm).
LetterExtraTransverse	Letter extra transverse paper (9.275 in. by 12 in.).
APlus	SuperA/SuperA/A4 paper (227 mm by 356 mm).
BPlus	SuperB/SuperB/A3 paper (305 mm by 487 mm).
LetterPlus	Letter plus paper (8.5 in. by 12.69 in.).
A4Plus	A4 plus paper (210 mm by 330 mm).
A5Transverse	A5 transverse paper (148 mm by 210 mm).
B5Transverse	JIS B5 transverse paper (182 mm by 257 mm).
A3Extra	A3 extra paper (322 mm by 445 mm).
A5Extra	A5 extra paper (174 mm by 235 mm).
B5Extra	ISO B5 extra paper (201 mm by 276 mm).
A2	A2 paper (420 mm by 594 mm).
A3Transverse	A3 transverse paper (297 mm by 420 mm).
A3ExtraTransverse	A3 extra transverse paper (322 mm by 445 mm).
JapaneseDoublePostcard	Japanese double postcard (200 mm by 148 mm). Requires Windows NT 4.0 or later.
A6	A6 paper (105 mm by 148 mm). Requires Windows NT 4.0 or later.
JapaneseEnvelopeKakuNumber2	Japanese Kaku #2 envelope. Requires Windows NT 4.0 or later.
JapaneseEnvelopeKakuNumber3	Japanese Kaku #3 envelope. Requires Windows NT 4.0 or later.
JapaneseEnvelopeChouNumber3	Japanese Chou #3 envelope. Requires Windows NT 4.0 or later.
JapaneseEnvelopeChouNumber4	Japanese Chou #4 envelope. Requires Windows NT 4.0 or later.
LetterRotated	Letter rotated paper (11 in. by 8.5 in.).
A3Rotated	A3 rotated paper (420 mm by 297 mm).
A4Rotated	A4 rotated paper (297 mm by 210 mm). Requires Windows NT 4.0 or later.
A5Rotated	A5 rotated paper (210 mm by 148 mm).
B4JisRotated	JIS B4 rotated paper (364 mm by 257 mm). Requires Windows NT 4.0 or later.
B5JisRotated	JIS B5 rotated paper (257 mm by 182 mm). Requires Windows NT 4.0 or later.
JapanesePostcardRotated	Japanese rotated postcard (148 mm by 100 mm). Requires Windows NT 4.0 or later.
JapaneseDoublePostcardRotated	Japanese rotated double postcard (148 mm by 200 mm). Requires Windows NT 4.0 or later.
A6Rotated	A6 rotated paper (148 mm by 105 mm). Requires Windows NT 4.0 or later.
JapaneseEnvelopeKakuNumber2Rotated	Japanese rotated Kaku #2 envelope. Requires Windows NT 4.0 or later.
JapaneseEnvelopeKakuNumber3Rotated	Japanese rotated Kaku #3 envelope. Requires Windows NT 4.0 or later.
JapaneseEnvelopeChouNumber3Rotated	Japanese rotated Chou #3 envelope. Requires Windows NT 4.0 or later.
JapaneseEnvelopeChouNumber4Rotated	Japanese rotated Chou #4 envelope. Requires Windows NT 4.0 or later.
B6Jis	JIS B6 paper (128 mm by 182 mm). Requires Windows NT 4.0 or later.
B6JisRotated	JIS B6 rotated paper (182 mm by 128 mm). Requires Windows NT 4.0 or later.
Standard12x11	Standard paper (12 in. by 11 in.). Requires Windows NT 4.0 or later.
JapaneseEnvelopeYouNumber4	Japanese You #4 envelope. Requires Windows NT 4.0 or later.
JapaneseEnvelopeYouNumber4Rotated	Japanese You #4 rotated envelope. Requires Windows NT 4.0 or later.
Prc16K	16K paper (146 mm by 215 mm). Requires Windows NT 4.0 or later.
Prc32K	32K paper (97 mm by 151 mm). Requires Windows NT 4.0 or later.
Prc32KBig	32K big paper (97 mm by 151 mm). Requires Windows NT 4.0 or later.
PrcEnvelopeNumber1	#1 rotated envelope (165 mm by 102 mm). Requires Windows NT 4.0 or later.
PrcEnvelopeNumber2	#2 envelope (102 mm by 176 mm). Requires Windows NT 4.0 or later.
PrcEnvelopeNumber3	#3 envelope (125 mm by 176 mm). Requires Windows NT 4.0 or later.
PrcEnvelopeNumber4	#4 envelope (110 mm by 208 mm). Requires Windows NT 4.0 or later.
PrcEnvelopeNumber5	#5 envelope (110 mm by 220 mm). Requires Windows NT 4.0 or later.
PrcEnvelopeNumber6	#6 envelope (120 mm by 230 mm). Requires Windows NT 4.0 or later.
PrcEnvelopeNumber7	#7 envelope (160 mm by 230 mm). Requires Windows NT 4.0 or later.
PrcEnvelopeNumber8	#8 envelope (120 mm by 309 mm). Requires Windows NT 4.0 or later.
PrcEnvelopeNumber9	#9 envelope (229 mm by 324 mm). Requires Windows NT 4.0 or later.
PrcEnvelopeNumber10	#10 envelope (324 mm by 458 mm). Requires Windows NT 4.0 or later.
Prc16KRotated	16K rotated paper (146 mm by 215 mm). Requires Windows NT 4.0 or later.
Prc32KRotated	32K rotated paper (97 mm by 151 mm). Requires Windows NT 4.0 or later.
Prc32KBigRotated	32K big rotated paper (97 mm by 151 mm). Requires Windows NT 4.0 or later.
PrcEnvelopeNumber1Rotated	#1 rotated envelope (165 mm by 102 mm). Requires Windows NT 4.0 or later.
PrcEnvelopeNumber2Rotated	#2 rotated envelope (176 mm by 102 mm). Requires Windows NT 4.0 or later.
PrcEnvelopeNumber3Rotated	#3 rotated envelope (176 mm by 125 mm). Requires Windows NT 4.0 or later.
PrcEnvelopeNumber4Rotated	#4 rotated envelope (208 mm by 110 mm). Requires Windows NT 4.0 or later.
PrcEnvelopeNumber5Rotated	Envelope #5 rotated envelope (220 mm by 110 mm). Requires Windows NT 4.0 or later.
PrcEnvelopeNumber6Rotated	#6 rotated envelope (230 mm by 120 mm). Requires Windows NT 4.0 or later.
PrcEnvelopeNumber7Rotated	#7 rotated envelope (230 mm by 160 mm). Requires Windows NT 4.0 or later.
PrcEnvelopeNumber8Rotated	#8 rotated envelope (309 mm by 120 mm). Requires Windows NT 4.0 or later.
PrcEnvelopeNumber9Rotated	#9 rotated envelope (324 mm by 229 mm). Requires Windows NT 4.0 or later.
PrcEnvelopeNumber10Rotated	#10 rotated envelope (458 mm by 324 mm). Requires Windows NT 4.0 or later.

Remarks

If you want to print on a custom paper, you need to set the report’s PaperKind property to Custom, and specify XtraReport.PageWidth and XtraReport.PageHeight properties to set the report’s custom size. You should use report units when you configure a report’s page size. Any other paper kind besides Custom has its own predefined width and height.

When you set the XtraReport.Landscape property to true, XtraReport.PageWidth and XtraReport.PageHeight values are swapped.

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 XtraReport.PageWidth and XtraReport.PageHeight properties to paper’s width and height.

In non-Windows environments, DevExpress Reporting does not modify the original PPD file. It only obtains paper information from this file. If you want to add a specific page size format, you should modify your printer’s PPD file. Set a paper size according to CUPS internal standards - in hmm units (hundredth of a millimeter). For example, for the iso_a4_210x297mm paper type, the paper height is 29704 and the width is 20990.

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

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#

asp-net-mvc-grid-create-report-based-on-grid-layout/CS/E4755/Models/ReportHelperMVC.cs#L31

report.Landscape = true;
report.PaperKind = DevExpress.Drawing.Printing.DXPaperKind.Letter;

asp-net-web-forms-grid-create-report-based-on-grid-layout/CS/WebApplication1/ReportHelper.cs#L37

report.Landscape = true;
report.PaperKind = DevExpress.Drawing.Printing.DXPaperKind.Letter;

reporting-winforms-create-hierarchical-report-from-flat-table/CS/TreeViewReport/ChildReport.cs#L26

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

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

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

reporting-winforms-label-report-in-code/CS/Reporting_how-to-create-a-label-report-at-runtime-t473792/LabelReportRuntime/CustomLabelReportBuilder.cs#L38

report.ReportUnit = model.MeasurementUnit == DXGraphicsUnit.Millimeter ? ReportUnit.TenthsOfAMillimeter : ReportUnit.HundredthsOfAnInch;
report.PaperKind = paperKindList.PaperKind;
report.Landscape = paperKindList.Landscape;

VB.NET

asp-net-mvc-grid-create-report-based-on-grid-layout/VB/E4755/Models/ReportHelperMVC.vb#L32

report.Landscape = True
report.PaperKind = DevExpress.Drawing.Printing.DXPaperKind.Letter

asp-net-web-forms-grid-create-report-based-on-grid-layout/VB/WebApplication1/ReportHelper.vb#L37

report.Landscape = True
report.PaperKind = DevExpress.Drawing.Printing.DXPaperKind.Letter

reporting-winforms-create-hierarchical-report-from-flat-table/VB/TreeViewReport/ChildReport.vb#L27

Dim report As XtraReport = subreport.ReportSource
report.PaperKind = DXPaperKind.Custom
report.PageWidth = CInt(PrintingSystem.PageSettings.UsablePageSize.Width - subreport.LocationF.X * (level - 1) + report.Margins.Right)

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

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

reporting-winforms-label-report-in-code/VB/Reporting_how-to-create-a-label-report-at-runtime-t473792/LabelReportRuntime/CustomLabelReportBuilder.vb#L38

report.ReportUnit = If(model.MeasurementUnit = System.Drawing.GraphicsUnit.Millimeter, ReportUnit.TenthsOfAMillimeter, ReportUnit.HundredthsOfAnInch)
report.PaperKind = paperKindList.PaperKind
report.Landscape = paperKindList.Landscape