Table of Contents

Class PdfPage

Namespace
PdfSharp.Pdf
Assembly
PdfSharp.dll

Represents a page in a PDF document.

public sealed class PdfPage : PdfPageTreeBase
Inheritance
object
PdfPage
Inherited Members
Extension Methods

Constructors

PdfPage()

Initializes a new page. The page must be added to a document before it can be used. Depending on the IsMetric property of the current region, the page size is set to A4 or Letter, respectively. If this size is not appropriate it should be changed before any drawing operations are performed on the page.

PdfPage(PdfDocument)

Initializes a new instance of the PdfPage class.

Properties

Annotations

Gets the annotations array of this page.

ArtBox

Gets or sets the art box.

ArtBoxReadOnly

Gets a copy of the art box if it exists, or an empty PdfRectangle if no art box is set.

BleedBox

Gets or sets the bleed box.

BleedBoxReadOnly

Gets a copy of the bleed box if it exists, or an empty PdfRectangle if no bleed box is set.

Contents

Gets the array of content streams of the page.

CropBox

Gets or sets the crop box.

CropBoxReadOnly

Gets a copy of the crop box if it exists, or an empty PdfRectangle if no crop box is set.

CustomValues

Gets or sets the custom values.

Document

Gets or sets the PdfDocument this page belongs to.

EffectiveArtBoxReadOnly

Gets a copy of the effective art box if it exists, or an empty PdfRectangle if neither art box nor crop box nor media box are set.

EffectiveBleedBoxReadOnly

Gets a copy of the effective bleed box if it exists, or an empty PdfRectangle if neither bleed box nor crop box nor media box are set.

EffectiveCropBoxReadOnly

Gets a copy of the effective crop box if it exists, or an empty PdfRectangle if neither crop box nor media box are set.

EffectiveTrimBoxReadOnly

Gets a copy of the effective trim box if it exists, or an empty PdfRectangle if neither trim box nor crop box nor media box are set.

HasAnnotations

Gets the annotations array of this page.

HasArtBox

Gets a value indicating whether an art box is set.

HasBleedBox

Gets a value indicating whether a bleed box is set.

HasCropBox

Gets a value indicating whether a crop box is set.

HasMediaBox

Gets a value indicating whether a media box is set.

HasTrimBox

Gets a value indicating whether a trim box is set.

Height

Gets or sets the height of the page. If the page width is less than or equal to page height, the orientation is Portrait; otherwise Landscape.

MediaBox

Gets or sets the media box directly. XGraphics is not prepared to work with a media box with an origin other than (0,0).

MediaBoxReadOnly

Gets a copy of the media box if it exists, or an empty PdfRectangle if no media box is set.

Orientation

Gets or sets the orientation of the page. The default value is PageOrientation.Portrait. If the page width is less than or equal to page height, the orientation is Portrait; otherwise Landscape.

PointHeight

Gets or sets the height of the page in point. If the page width is less than or equal to page height, the orientation is Portrait; otherwise Landscape.

PointWidth

Gets or sets the width of the page in point. If the page width is less than or equal to page height, the orientation is Portrait; otherwise Landscape.

Resources

Gets the PdfResources object of this page.

Rotate

Gets or sets the /Rotate entry of the PDF page. The value is the number of degrees by which the page should be rotated clockwise when displayed or printed. The value must be a multiple of 90. This property does the same as the Rotation property, but uses an integer value.

Rotation

Gets or sets a value how a PDF viewer application should rotate this page. This property does the same as the Rotate property, but uses an enum value.

Size

Sets one of the predefined standard sizes.

Tag

Gets or sets a user-defined object that contains arbitrary information associated with this PDF page. The tag is not used by PDFsharp.

TrimBox

Gets or sets the trim box.

TrimBoxReadOnly

Gets a copy of the trim box if it exists, or an empty PdfRectangle if no trim box is set.

TrimMargins

Gets or sets the trim margins.

Width

Gets or sets the width of the page. If the page width is less than or equal to page height, the orientation is Portrait; otherwise Landscape.

Methods

AddDocumentLink(PdfRectangle, int, XPoint?)

Adds an internal document link.

AddDocumentLink(PdfRectangle, string)

Adds an internal document link.

AddDocumentLink(PdfRectangle, string, string, bool?)

Adds an external document link.

AddEmbeddedDocumentLink(PdfRectangle, string, bool?)

Adds an embedded document link.

AddEmbeddedDocumentLink(PdfRectangle, string, string, bool?)

Adds an external embedded document link.

AddFileLink(PdfRectangle, string)

Adds a link to a file.

AddWebLink(PdfRectangle, string)

Adds a link to the Web.

Close()

Closes the page. A closed page cannot be modified anymore, and it is not possible to get an XGraphics object for a closed page. Closing a page is not required, but may save resources if the document has many pages.