PdfPageObject Class

Namespace:
GemBox.Pdf
Assembly:
GemBox.Pdf.dll

Represents a base class for page tree nodes: intermediate nodes, called page tree nodes represented with PdfPages type, and leaf nodes, called page objects represented with PdfPage type.

public abstract class PdfPageObject : PdfObject
Public MustInherit Class PdfPageObject
    Inherits PdfObject
Inheritance:
PdfPageObject
Derived
PdfPage
PdfPages

Properties

CropBox

(Optional; inheritable) A rectangle, expressed in default user space units, that shall define the visible region of default user space.

When the page is displayed or printed, its contents shall be clipped (cropped) to this rectangle and then shall be imposed on the output medium in some implementation-defined manner (see 14.11.2, "Page Boundaries").

Default value: the value of MediaBox.

Value of this property might be null if this is an instance of a PdfPages, but it should never be null if this is an instance of a PdfPage.

public PdfRectangle CropBox { get; set; }
Public Property CropBox As PdfRectangle
Property Value
PdfRectangle

A rectangle, expressed in default user space units, that shall define the visible region of default user space.

See Also

MediaBox

(Required; inheritable) A rectangle (see 7.9.5, "Rectangles"), expressed in default user space units, that shall define the boundaries of the physical medium on which the page shall be displayed or printed (see 14.11.2, "Page Boundaries").

Value of this property might be null if this is an instance of a PdfPages, but it should never be null if this is an instance of a PdfPage.

public PdfRectangle MediaBox { get; set; }
Public Property MediaBox As PdfRectangle
Property Value
PdfRectangle

A rectangle, expressed in default user space units, that shall define the boundaries of the physical medium on which the page shall be displayed or printed.

See Also

Parent

(Required except in root node; prohibited in the root node; shall be an indirect reference) The page tree node that is the immediate parent of this one.

public PdfPages Parent { get; }
Public ReadOnly Property Parent As PdfPages
Property Value
PdfPages

The page tree node that is the immediate parent of this one.

See Also

Rotate

(Optional; inheritable) The number of degrees by which the page shall be rotated clockwise when displayed or printed.

The value shall be a multiple of 90.

Default value: 0.

public int Rotate { get; set; }
Public Property Rotate As Integer
Property Value
Int32

The number of degrees by which the page shall be rotated clockwise when displayed or printed.

See Also

Methods

SetCropBox(Double, Double)

Sets the CropBox.

public void SetCropBox(double width, double height)
Public Sub SetCropBox(width As Double, height As Double)
Parameters
width
Double

The right X coordinate of the CropBox. The left X coordinate of the CropBox is set to 0.

height
Double

The top Y coordinate of the CropBox. The bottom Y coordinate of the CropBox is set to 0.

SetCropBox(Double, Double, Double, Double)

Sets the CropBox.

public void SetCropBox(double left, double bottom, double right, double top)
Public Sub SetCropBox(left As Double, bottom As Double, right As Double, top As Double)
Parameters
left
Double

The left X coordinate of the CropBox.

bottom
Double

The bottom Y coordinate of the CropBox.

right
Double

The right X coordinate of the CropBox.

top
Double

The top Y coordinate of the CropBox.

SetMediaBox(Double, Double)

Sets the MediaBox.

public void SetMediaBox(double width, double height)
Public Sub SetMediaBox(width As Double, height As Double)
Parameters
width
Double

The right X coordinate of the MediaBox. The left X coordinate of the MediaBox is set to 0.

height
Double

The top Y coordinate of the MediaBox. The bottom Y coordinate of the MediaBox is set to 0.

SetMediaBox(Double, Double, Double, Double)

Sets the MediaBox.

public void SetMediaBox(double left, double bottom, double right, double top)
Public Sub SetMediaBox(left As Double, bottom As Double, right As Double, top As Double)
Parameters
left
Double

The left X coordinate of the MediaBox.

bottom
Double

The bottom Y coordinate of the MediaBox.

right
Double

The right X coordinate of the MediaBox.

top
Double

The top Y coordinate of the MediaBox.

Inherited Properties

Metadata

(Optional; PDF 1.4) A metadata stream containing metadata for the component.

(Inherited from PdfObject)

Extension Methods

Examples

See Also