PdfPageTreeObject.CropBox Property

Specifies the crop box imposing the page boundaries displayed in a PDF Viewer.

Namespace: DevExpress.Pdf

Assembly: DevExpress.Pdf.v23.2.Core.dll

NuGet Package: DevExpress.Pdf.Core

Declaration

C#

public PdfRectangle CropBox { get; set; }

VB.NET

Public Property CropBox As PdfRectangle

Property Value

Type	Description
PdfRectangle	A PdfRectangle object, specifying the crop box.

Remarks

The crop box defines the region to which the contents of the page shall be clipped (cropped) when displayed or printed.

The default setting is the page’s PdfPageTreeObject.MediaBox value.

Note

The PDF page unit of measurement is points, which measures 1/72 of an inch (0.3528 mm). You can convert this unit of measurement, e.g., to pixels using the Units.PointsToPixelsF method.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the CropBox 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#

pdf-document-api-add-graphics-to-landscape-and-portrait-pages/CS/CreateGraphics/Program.cs#L45

{
    PdfRectangle cropBox = page.CropBox;
    float cropBoxWidth = ConvertFromPdfUnits((float)cropBox.Width, dpiX);

pdf-document-api-replace-form-field-with-image/CS/ReplaceFormFieldWithImage/Program.cs#L17

PdfRectangle cropBox = field.Widget.Page.CropBox;
PdfRectangle rect = field.Widget.Rect;

VB.NET

pdf-document-api-add-graphics-to-landscape-and-portrait-pages/VB/CreateGraphics/Program.vb#L41

Private Shared Function PrepareGraphics(ByVal page As PdfPage, ByVal graphics As PdfGraphics, ByVal dpiX As Single, ByVal dpiY As Single) As SizeF
    Dim cropBox As PdfRectangle = page.CropBox
    Dim cropBoxWidth As Single = ConvertFromPdfUnits(CSng(cropBox.Width), dpiX)

pdf-document-api-replace-form-field-with-image/VB/ReplaceFormFieldWithImage/Program.vb#L14

If Equals(field.Name, "Address") Then
    Dim cropBox As PdfRectangle = field.Widget.Page.CropBox
    Dim rect As PdfRectangle = field.Widget.Rect