PdfBox

enum PdfBox

Types of supported PDF page boxes.

Entries

Link copied to clipboard

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.

Link copied to clipboard

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 or PJTF job ticket), the crop box determines how the page’s contents shall be positioned on the output medium (including PSPDFKit itself). The default value is the page’s media box.

Link copied to clipboard

A rectangle, expressed in default user space units, that shall define the region to which the contents of the page shall be clipped when output in a production environment.

Link copied to clipboard

A rectangle, expressed in default user space units, that shall define the intended dimensions of the finished page after trimming.

Functions

Link copied to clipboard
open fun valueOf(name: String): PdfBox

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Link copied to clipboard
open fun values(): Array<PdfBox>

Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants.