PXC_BoxType Enumeration

From Tracker Software PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
Line 3: Line 3:
 
{{#customTitle:PXC_BoxType Enumeration}}
 
{{#customTitle:PXC_BoxType Enumeration}}
 
{{#parentPage:PXV:PXC|PXC_BoxType Enumeration|enum}}
 
{{#parentPage:PXV:PXC|PXC_BoxType Enumeration|enum}}
{{ToReview}}
+
 
  
 
Specifies the types of page boundary boxes in the document.
 
Specifies the types of page boundary boxes in the document.

Revision as of 12:36, 21 May 2015


Specifies the types of page boundary boxes in the document.

Syntax

enum PXC_BoxType
{
    PBox_PrintBox = -2,
    PBox_ViewBox  = -1,
    PBox_MediaBox = 0,
    PBox_CropBox  = 1,
    PBox_BleedBox = 2,
    PBox_TrimBox  = 3,
    PBox_ArtBox   = 4,
    PBox_BBox     = 5,
    PBox_PageBox  = 6,
};

Constants

PBox_PrintBox
The print box is specified by PrintArea in document preferences.
PBox_ViewBox
The view box is specified by ViewArea in document preferences.
PBox_MediaBox
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.
PBox_CropBox
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, 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.
PBox_BleedBox
The bleed box 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.
PBox_TrimBox
The trim box 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 color bars. The default value is the page's crop box.
PBox_ArtBox
The art box 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.
PBox_BBox
The bounding box is a rectangular frame that determines the dimensions of an object (such as a graphic, font or pattern) that is placed inside a PDF document. Note that this box can't be changed and it's for read only.
PBox_PageBox
The page box defines the intersection of the media box with the active box (mostly crop box). Note that this box can't be changed and it's for read only.

See Also