Click or drag to resize
Pdftools logo

Page Class

Inheritance Hierarchy
SystemObject
  PdfTools.Toolbox.InternalNativeBase
    PdfTools.Toolbox.InternalNativeObject
      PdfTools.Toolbox.PdfPage

Namespace: PdfTools.Toolbox.Pdf
Assembly: PdfTools.Toolbox (in PdfTools.Toolbox.dll) Version: 1.2.0+708f7116d933787a0712d56133e4c2c9bf21e5e3
Syntax
C#
public class Page : NativeObject

The Page type exposes the following members.

Properties
 NameDescription
Public propertyAnnotations

The list of this page's annotations.

Adding to this list results in an error:
  • IllegalState if the list has already been closed
  • UnsupportedOperation if the document is read-only
  • IllegalArgument
    • if the given annotation is
    • if the given annotation object has already been closed
    • if the given annotation does not belong to the same document as the list
    • if the given annotation is already associated with a page
This list does not support removing or setting elements or clearing.
Public propertyArtBox

The art box of the page.

The art box (PDF 1.3) defines the extent of the page's meaningful content (including potential white-space) as intended by the page’s creator. The default value is the page's crop box.

This property is if the page contains no explicit art box.

Public propertyBleedBox

The bleed box of the page.

The bleed box (PDF 1.3) defines the region to which the contents of the page shall be clipped when output in a production environment. This may include any extra bleed area needed to accommodate the physical limitations of cutting, folding, and trimming equipment. The actual printed page may include printing marks that fall outside the bleed box. The default value is the page's crop box.

This property is if the page contains no explicit bleed box.

Public propertyContent

The page content.

If the page is writable, the content object can be used to apply new content on the page, for example overlays or underlays.
Public propertyLinks

The list of this page's links.

Adding to this list results in an error:
  • IllegalState if the list has already been closed
  • UnsupportedOperation if the document is read-only
  • IllegalArgument
    • if the given link is
    • if the given link object has already been closed
    • if the given link does not belong to the same document as the list
    • if the given link is already associated with a page
This list does not support removing or setting elements or clearing.
Public propertyMediaBox

The media box of the page.

The media box defines the boundaries of the physical medium on which the page is to be printed. It may include any extended area surrounding the finished page for bleed, printing marks, or other such purposes. It may also include areas close to the edges of the medium that cannot be marked because of physical limitations of the output device. Content falling outside this boundary may safely be discarded without affecting the meaning of the PDF file.

This property cannot be .

Public propertyMetadata

The metadata of the page.

If the document is writable, the metadata object will be writable too and all changes to the metadata object are reflected in the document.

This property is if the page has not metadata.

Public propertyPageLabel

Page label

The label for this page. A page does not have to have a label and if it doesn't this property will be an empty string.

If it exists, a page label is designed to replace the page number in visual presentations and consists of an optional prefix and a number. Number can be in one of several styles (arabic, Roman, alphabetic) and starts at an arbitrary number for a range of pages.

Page labels are used to set distinct names or numbers, most often for preface, appendices and similar sections of the document.

Public propertyRotation

The current page rotation

Public propertySize

The visible size of the page (crop box).

The page size corresponds to the size of the crop box. Since all coordinates are normalized to the origin of the crop box, the normalized origin of the crop box is always (0,0) and thus only the size is required.

The crop box defines the region to which the contents of the page shall be clipped (cropped) when displayed or printed. Unlike the other boxes, the crop box has no defined meaning in terms of physical page geometry or intended use; it merely imposes clipping on the page contents. However, in the absence of additional information (such as imposition instructions specified in a JDF job ticket), the crop box determines how the page's contents shall be positioned on the output medium. The default value is the page's media box.

This property cannot be .

Public propertyTrimBox

The trim box of the page.

The trim box (PDF 1.3) defines the intended dimensions of the finished page after trimming. It may be smaller than the media box to allow for production-related content, such as printing instructions, cut marks, or colour bars. The default value is the page's crop box.

This property is if the page contains no explicit trim box.

Public propertyWidgets

The list of this page's form field widgets.

Adding to this list results in an error:
  • IllegalState if the list has already been closed
  • UnsupportedOperation if the document is read-only
  • IllegalArgument
    • if the given widget is
    • if the given widget object has already been closed
    • if the given widget does not belong to the same document as the list
    • if the given widget is already associated with a page
This list does not support removing or setting elements or clearing.
Top
Methods
 NameDescription
Public methodStatic memberCopy

Copy a page

Copy a page object from an input document to the given targetDocument. The returned object is associated with the given target document but not yet part of it. It can be appended to the document's page list.
Public methodStatic memberCreate

Create an empty page

The page is associated with the given target document but not yet part of it. It can be appended to the document's page list.
Public methodEquals
(Inherited from NativeObject)
Public methodGetHashCode
(Inherited from NativeObject)
Public methodRotate

Rotate the page by a multiple of 90 degrees.

Public methodUpdateSize

Update the page size to a specified rectangle.

Note that all page-related coordinates are normalized to the crop box of the page. Updating the page size thus changes the coordinate system, rendering all previously extracted coordinates invalid.
Top
See Also