LayerPD_Layer
ObjectPDPage

A PDPage is a page in a document, corresponding to the PDF Page object (see Page Objects in Section 3.6.2, Page Tree, in the PDF Reference).

Among other associated objects, a page contains:


Define Summary
 Define
 kPDPageBlendingProfileValueStr
Takes ASext as input. If set we use this profile as blending profile. kPDPageDisplayOverPrintPreviewStr must be set for this to get honored.
 kPDPageBlendingProfileValueStr
Takes ASext as input. If set we use this profile as blending profile. kPDPageDisplayOverPrintPreviewStr must be set for this to get honored.
 kPDPageDirectlyImposedStr
Directly imposed page.
 kPDPageDisplayOverPrintPreviewStr
Display overprint preview.
 kPDPageDisplayOverPrintPreviewStr
Display overprint preview.
 kPDPageDoLazyEraseStr
Const strings used as ASCab keys when passing drawing flags. These are valid only for calls to PDDrawPageOrCosObjectToBuffer.
 kPDPageDoLazyEraseStr
Const strings used as ASCab keys when passing PDPageDrawFlags. These are valid only for calls to PDPageDrawContentsToMemoryEx.
 kPDPageDoNotSubstituteWorkingSpacesStr
Do not substitute working spaces.
 kPDPageDoNotSubstituteWorkingSpacesStr
Do not substitute working spaces.
 kPDPageDrawSmoothBicubicImageStr
Draw smooth image using bicubic resampling. This option can have performance overhead.
 kPDPageDrawSmoothBicubicImageStr
Draw smooth image using bicubic resampling. This option can have performance overhead.
 kPDPageDrawSmoothImageStr
Draw smooth image.
 kPDPageDrawSmoothImageStr
Draw smooth image.
 kPDPageDrawSmoothLineArtStr
Draw smooth line art.
 kPDPageDrawSmoothLineArtStr
Draw smooth line art.
 kPDPageDrawSmoothTextStr
Draw smooth text.
 kPDPageDrawSmoothTextStr
Draw smooth text.
 kPDPageEmitPageGroupStr
Emit a page group.
 kPDPageEmitPageGroupStr
Emit a page group.
 kPDPageIgnoreIsolatedAndKnockoutTransparencyGroupStr
Ignore Isolated and Knockout transparency at page boundary.
 kPDPageIgnoreIsolatedAndKnockoutTransparencyGroupStr
Ignore Isolated and Knockout transparency at page boundary.
 kPDPageIsPrintingStr
The page is being printed.
 kPDPageIsPrintingStr
The page is being printed.
 kPDPageIsPSPrintingStr
PostScript printing.
 kPDPageIsPSPrintingStr
PostScript printing.
 kPDPagePassMetadatatoAGMPortStr
Pass metadata to AGM port.
 kPDPagePassOCtoAGMPortStr
Pass optional content to AGM port.
 kPDPagePassOPItoAGMPortStr
Pass open prepress interface (OPI) to AGM port.
 kPDPageStmSkipComments
 kPDPageStmStringMax
 kPDPageStmTokenHexString
 kPDPageSuppressRasterAlphaStr
Supress raster alpha.
 kPDPageSuppressRasterAlphaStr
Supress raster alpha.
 kPDPageSwapComponentsStr
Render colors in BGR order rather than RGB. It is only valid for calls to PDDrawPageOrCosObjectToBuffer() and only when outputing to an RGB colorspace.
 kPDPageSwapComponentsStr
Render colors in BGR order rather than RGB. It is only valid for calls to PDPageDrawContentsToMemoryEx() and only when outputing to an RGB colorspace.
 kPDPageUseAnnotFacesStr
Draw annotation appearances.
 kPDPageUseAnnotFacesStr
Draw annotation appearances.
 kPDPageUsePrinterMarkAnnotsStr
User printer's mark annotations.
 kPDPageUseStampAnnotsOnlyStr
If set, only consider Stamp annotations. This overrides kPDPageUseAnnotFaces.
 kPDPageUseStampAnnotsOnlyStr
If set, only consider Stamp annotations. This overrides kPDPageUseAnnotFaces.
 kPDPageUseTrapAnnotsStr
Use trap network annotations.
 kPDPageWorkingSpacesOnlyForChangeStr
If this is set, only use a working space instead of a device space if the process color model of the target device is different than that of the source.
 kPDPageWorkingSpacesOnlyForChangeStr
If this is set, only use a working space instead of a device space if the process color model of the target device is different than that of the source.
 _PagePDEContentHFT_IS_BETA
 _PagePDEContentHFT_LAST_BETA_COMPATIBLE_VERSION
 _PagePDEContentHFT_LATEST_VERSION
 PagePDEContentHFT_LATEST_VERSION
 PagePDEContentHFTName
 PagePDEContentHFT_VERSION_4
 PagePDEContentHFT_VERSION_5
 PagePDEContentHFT_VERSION_6
Typedef Summary
 Typedef
 PDPage
A single page in the PDF representation of a document. Just as PDF files are partially composed of their pages, PDDoc objects are composed of PDPage objects. A page contains a series of objects representing the objects drawn on the page (PDGraphic), a list of resources used in drawing the page, annotations (PDAnnot), an optional thumbnail image of the page, and the beads used in any articles that occur on the page. The first page in a PDDoc is page 0.
 PDPageInk
 PDPageInkRec
 PDPageNumber
A 0-based page number for use in AVPageView and AVDoc methods. Negative for special values.
 PDPageRange
 PDPageStmToken
 PDPageStmTokenRec
Enumeration Summary
 Enumeration
  PDPageArea
Different logical areas on a page.
  PDPageDrawFlags
Bit flags indicating how a page is rendered.
  PDPageDrawFlagsPI
  PDPageDrawSmoothFlags
Bit flags indicating how a page is rendered.
  PDPageMarkFlags
Bit flags indicating which page marks are emitted for color separations.
  PDPageMode
An enumerated data type that specifies whether thumbnail images or bookmarks are shown.
  PDPageTilingMode
Structure Summary
 Structure
 _t_PDPageInkRec
Represents an ink used on a page.
 _t_PDPageRange
Specifies a range of pages in a document. Page numbers begin with 0.
 _t_PDPageStmToken
A data structure used by PDPageStmGetToken(). It contains information about the current page contents token.
Callback Summary
 Callback
 PagePDEContentDidChangeNPROTO
 PagePDEContentNotCachedNPROTO
 PDPageEnumInksCallback
Used for enumerating the inks on a page via PDPageEnumInks().
 PDPageStmImageDataProc
A callback for PDPageStmGetInlineImage(). It should be called when inline image data is encountered in PDPageStmGetToken(). This method may be called multiple times for one inline image. If so, each call provides sequential data for the image.
 PDPageStmStringOverflowProc
A callback used by PDPageStmGetToken(). It is called when the length of a string token exceeds kPDPageStmStringMax bytes (see PDExpT.h) in PDPageStmGetToken().
Method Summary
 Method
 
void PDPageAcquirePage(PDPage pdPage)
Increments the page's reference count. After you are done using the page, release it using PDPageRelease(). If PDPageRelease() is not called, it could block the document containing the page from being closed. To avoid such problems use the CSmartPDPage class as it ensures that the page is released as it goes out of scope.
 
void PDPageAddAnnot(PDPage aPage, ASInt32 addAfter, PDAnnot annot)
Adds an annotation at the specified location in a page's annotation array.
 
void PDPageAddCosContents(PDPage page, CosObj newContents)
Completely replaces the contents of the specified page with newContents.
 
void PDPageAddCosResource(PDPage page, const char* resType, const char* resName, CosObj resObj)
Adds a Cos resource to a page object. See Section 3.7.2 in the PDF Reference for a description of page resources.
 
PDAnnot PDPageAddNewAnnot(PDPage aPage, ASInt32 addAfter, ASAtom subType, const ASFixedRect* initialRect)
Adds an annotation to the page. To make the annotation visible after adding it, convert the coordinates of initialRect to device coordinates using AVPageViewRectToDevice(), then call AVPageViewInvalidateRect() using the converted rectangle. This method is equivalent to calling PDPageCreateAnnot() followed by PDPageAddAnnot().
 
void PDPageContentsDidChange(PDPage page, void* clientData)
The contents of a page have changed and the page will be redrawn.
 
void PDPageContentsDidChangeEx(PDPage page, ASBool invalidateViews, void* clientData)
The contents of a page changed. Unlike PDPageContentsDidChange() , this notification specifies whether the page is redrawn immediately.
 
PDAnnot PDPageCreateAnnot(PDPage aPage, ASAtom subType, const ASFixedRect* initialLocation)
Creates a new annotation, associated with the specified page's CosDoc, but not added to the page. Use PDPageAddAnnot() to add the annotation to the page.
 
void PDPageCreatePrintRecord(void* devmode, ASBool* bl, void* clientData)
 
void PDPageDidAddAnnot(PDPage page, PDAnnot annot, ASInt32 error, void* clientData)
An annotation was added to a page.
 
void PDPageDidPrintAnnot(PDAnnot annot, ASInt32 page, ASInt32 status, void* clientData)
Clients who register for PDPageDidPrintAnnot() will be called after the annotation has printed. status indicates whether Acrobat tried to print any representation of this annotation.
 
void PDPageDidPrintAnnots(PDDoc doc, ASInt32 page, ASStm stm, void* clientData)
Annotations were printed.
 
void PDPageDidRedraw(PDPage page, void* clientData)
Sent when the page is redrawn via PDPageRedraw().
 
void PDPageDidRemoveAnnot(PDPage page, ASInt32 annotIndex, ASInt32 error, void* clientData)
Superseded by PDPageDidRemoveAnnotEx() in Acrobat 6.0.
 
void PDPageDidRemoveAnnotEx(PDPage page, PDAnnot removedAnnot, ASInt32 error, void* clientData)
Supersedes PDPageDidRemoveAnnot() in Acrobat 6.0 and later.
 
void PDPageDirectDrawToPlatform(void* clientData)
 
void PDPageDrawContentsToWindow(PDPage page, void* window, void* displayContext, ASBool isDPS, ASFixedMatrix* matrix, ASFixedRect* updateRect, CancelProc cancelProc, void* cancelProcClientData)
Draws the contents of a page into the specified window.
 
void PDPageDrawContentsToWindowEx(PDPage page, void* window, void* displayContext, ASBool isDPS, ASFixedMatrix* matrix, ASUns32 flags, ASFixedRect* updateRect, CancelProc cancelProc, void* cancelProcClientData)
Provides control over the rendering of annotations on the page to be drawn into window. It provides the ability to specify the flags passed in to the PDPageDrawContentsToWindows() function.
 
void PDPageDrawContentsWithParams(PDPage page, PDDrawParams params)
Provides control over the rendering of contents on the page, including both those parameters you would pass to PDPageDrawContentsToWindowEx(), and an optional-content context that determines which contents are visible. This API is not available on Mac 64.
 
void PDPageEnumContents(PDPage page, PDGraphicEnumMonitor mon, void* clientData)
Enumerates the contents of a page, calling a procedure for each drawing object in the page description.
 
void PDPageEnumInks(PDPage pdPage, PDPageEnumInksCallback proc, void* clientData, ASBool includeOPI)
Enumerates the inks for a page, calling the supplied procedure for each PDPageInk structure.
 
void PDPageEnumInksEx(PDPage pdPage, PDPageEnumInksCallback proc, void* clientData, ASBool includeOPI, ASAtom colorModel)
Enumerates the inks for a page, calling the supplied procedure for each PDPageInk structure. This differs from PDPageEnumInks() in that it allows the process color model to be passed in.
 
void PDPageEnumOCGs(PDPage pdPage, PDOCGEnumProc enumProc, void* clientData)
Enumerates the optional-content groups for the page, calling the supplied procedure for each one. Enumeration continues until all groups have been enumerated, or until enumProc returns false. Each group is reported once, even if it is referenced multiple times in the page.
 
void PDPageEnumResources(PDPage page, PDResourceEnumMonitor mon, void* clientData)
(Obsolete, provided only for backwards compatibility) Enumerates the page's resources, calling an enumeration procedure for each resource.
 
ASBool PDPageFlattenOC(PDPage pdPage, PDOCContext context)
Replaces the page's contents with a version that has no optional content, containing only what was visible on the page when the call was made.
 
PDAnnot PDPageGetAnnot(PDPage aPage, ASInt32 annotIndex)
Gets the annotIndex annotation on the page.
 
ASInt32 PDPageGetAnnotIndex(PDPage aPage, PDAnnot anAnnot)
Gets the index of a given annotation object on a given page.
 
ASInt32 PDPageGetAnnotSequence(PDPage page, PDAnnot annot)
Returns the sequence number of the specified annotation for the given page. It is applicable only to annotations that are listed in Acrobat's Comments pane and therefore cannot be summarized using Summarize command (as would be the case for link and widget annotations, for example).
 
void PDPageGetBBox(PDPage page, ASFixedRect* bboxP)
Gets the bounding box for a page. The bounding box is the rectangle that encloses all text, graphics, and images on the page.
 
ASBool PDPageGetBox(PDPage page, ASAtom boxName, ASFixedRect* box)
Returns the box specified for the page object intersected with the media box. If the value for boxName is CropBox, this call is equivalent to PDPageGetCropBox(); if the value is MediaBox, this call is equivalent to PDPageGetMediaBox().
 
CosObj PDPageGetCosObj(PDPage page)
Gets the dictionary Cos object associated with a page. This method does not copy the object, but is instead the logical equivalent of a type cast.
 
CosObj PDPageGetCosResources(PDPage page)
Gets the Cos object corresponding to a page's resource dictionary. A page's resource Cos object may either be directly in the Page Cos object and apply only to the page. Or, it may be in the Pages tree, be shared by multiple pages, and applies to all Page nodes below the point in the Pages tree where it is located.
 
void PDPageGetCropBox(PDPage page, ASFixedRect* cropBoxP)
Gets the crop box for a page. The crop box is the region of the page to display and print.
 
void PDPageGetDefaultMatrix(PDPage pdPage, ASFixedMatrix* defaultMatrix)
Gets the matrix that transforms user space coordinates to rotated and cropped coordinates. The origin of this space is the bottom-left of the rotated, cropped page. Y is increasing.
 
PDDoc PDPageGetDoc(PDPage page)
Gets the document that contains the specified page.
 
ASFixed PDPageGetDuration(PDPage pdp)
Gets the page's automatic-advance timing value, which is the maximum amount of time the page is displayed before the viewer automatically advances to the next page.
 
void PDPageGetFlippedMatrix(PDPage pdPage, ASFixedMatrix* flipped)
Gets the matrix that transforms user space coordinates to rotated and cropped coordinates. The origin of this space is the top-left of the rotated, cropped page. Y is decreasing.
 
void PDPageGetMediaBox(PDPage page, ASFixedRect* mediaBoxP)
Gets the media box for a page. The media box is the natural size of the page (for example, the dimensions of an A4 sheet of paper).
 
ASInt32 PDPageGetNumAnnots(PDPage aPage)
Gets the number of annotations on a page. Annotations associated with pop-up windows (such as strikeouts) are counted as two annotations. Widget annotations (form fields) are included in the count.
 
ASInt32 PDPageGetNumber(PDPage page)
Gets the page number for the specified page.
 
PDOCG* PDPageGetOCGs(PDPage pdPage)
Gets the optional-content groups for the document.
 
ASBool PDPageGetPalette(PDPage page, void* displayContext, char* table)
Useful for obtaining the static, platform-specific palette; the bitmap must be already selected into the displayContext to get the palette. This API was exposed for the purpose of the ImageConversion plug-in. When that code uses PDPageDrawContentsToWindow() to get a bitmap from AGM, it needs the palette that AGM used in order to get the correct results. This API is not available on Mac 64.
 
void PDPageGetPrintMatrix(PDPage page, ASFixedMatrix* matrix, void* clientData)
Sent when the PDF Library has calculated the PostScript Print Page matrix. The PostScript Print Page matrix provides the mapping from user space to PS output space. The matrix can be used to calculate the PostScript page bounding box.
 
PDRotate PDPageGetRotate(PDPage page)
Gets the rotation value for a page.
 
PDTrans PDPageGetTransition(PDPage pdp)
Gets the transition for a given page.
 
float PDPageGetUserUnitSize(PDPage page)
Returns the UserUnit value for the page. If the key is not present in the page dictionary the default of 1.0 is returned.
 
void PDPageGetVisibleBBox(PDPage page, PDOCContext ocContext, ASBool includeAnnots, ASFixedRect* fr)
Gets the bounding box for a given page for those contents that are visible in the given optional-content context. The bounding box is the rectangle that encloses the visible text, graphics, and images on the page.
 
ASBool PDPageHasOverprintExt(PDPage pdPage)
Checks whether a page contains overprint (with qualifications).
 
ASBool PDPageHasTransition(PDPage pdp)
Tests whether a page has a transition.
 
ASBool PDPageHasTransparency(PDPage pdPage, ASBool includeAnnotAppearances)
Checks whether a page uses any transparency features.
 
void PDPageMakeSeparations(PDPage pdPage, PDHostSepsSpec spec)
Generates print color separations for a page.
 
void PDPageNotifyContentsDidChange(PDPage page)
Broadcasts a PDPageContentsDidChange() notification. If the Acrobat viewer is version 2.1 or later, also broadcasts a PDPageContentsDidChangeEx() notification with invalidateViews set to true.
 
void PDPageNotifyContentsDidChangeEx(PDPage page, ASBool invalidateViews)
Broadcasts a PDPageContentsDidChange() notification and a PDPageContentsDidChangeEx() notification. These notify the Acrobat viewer that a page's contents have been modified, and tells the Acrobat viewer whether to redraw the page immediately.
 
ASInt32 PDPageNumFromCosObj(CosObj pageObj)
Gets the page number of the page specified by a Cos object.
 
void PDPageRelease(PDPage page)
Decrements the specified page's reference count.
 
void PDPageRemoveAnnot(PDPage aPage, ASInt32 annotIndex)
Removes an annotation from the specified page. Annotations are stored in Cos arrays, which are automatically compressed when an annotation is removed (see CosArrayRemove()). For this reason, if you use a loop in which you remove annotations, structure the code so the loop processes from the highest to the lowest index. If you loop the other direction, you will skip over annotations immediately following ones you remove.
 
void PDPageRemoveCosContents(PDPage page)
Removes the contents of the specified page.
 
void PDPageRemoveCosResource(PDPage page, const char* resType, const char* resName)
Removes a Cos resource from a page object. See Section 3.7.2 in the PDF Reference for a description of page resources.
 
void PDPageSetBox(PDPage page, ASAtom boxName, ASFixedRect box)
Sets the box specified by boxName for the page.
 
void PDPageSetCropBox(PDPage page, ASFixedRect cropBox)
Sets the crop box for a page. The crop box is the region of the page to display and print. This method ignores the request if either the width or height of cropBox is less than 72 points (one inch).
 
void PDPageSetDuration(PDPage pdp, ASFixed fxDuration)
Sets the page's automatic-advance timing value, which is the maximum amount of time the page is displayed before the viewer automatically advances to the next page.
 
void PDPageSetMediaBox(PDPage page, ASFixedRect mediaBox)
Sets the media box for a page. The media box is the natural size of the page, for example, the dimensions of an A4 sheet of paper.
 
void PDPageSetRotate(PDPage page, PDRotate angle)
Sets the rotation value for a page.
 
void PDPageSetTransition(PDPage pdp, PDTrans pdt)
Sets the transition for a given page.
 
void PDPageSetUserUnitSize(PDPage page, float unitSize)
Set the UserUnit value for a page.
 
ASUns32 PDPageStmGetInlineImage(ASStm stm, ASUns32 flags, CosDoc cosDoc, CosObj resDict, PDPageStmImageDataProc proc, void* procClientData, ASUns32* imageRawDataStmOffsetP, ASUns32* imageRawDataLenP, CosObj* imageDict)
Reads a PDF page content inline image from a stream. The stream is typically obtained by getting the Cos stream for a page contents or a Form contents, and calling CosStreamOpenStm() to open the stream using the filtered mode. This method is called after a BI token has been read from the stream. BI indicates that the following tokens comprise an inline image dictionary and data.
 
ASUns32 PDPageStmGetToken(ASStm stm, ASUns32 flags, PDPageStmStringOverflowProc proc, void* procClientData, PDPageStmToken pageStmToken)
Reads a PDF page content token from a stream. The stream is typically obtained by getting the Cos stream for a page contents or a Form contents, and calling CosStreamOpenStm() to open the stream using the filtered mode.
 
void PDPageWillAddAnnot(PDPage page, ASInt32 addAfter, PDAnnot annot, void* clientData)
An annotation will be added to a page.
 
void PDPageWillPrintAnnot(PDAnnot annot, ASInt32 page, void* clientData)
Clients who register for this notification will be notified just before an annotation is expected to print. This notification allows clients that manage annotations to prepare the appearance of the annotation for printing purposes. There is no requirement that the annot referred to in this parameter list actually has a print appearance.
 
void PDPageWillPrintAnnots(PDDoc doc, ASInt32 page, ASStm stm, void* clientData)
Clients who register for PDPageWillPrintAnnots() will be called before the printed representations of any annotations have been emitted. If a page has no annotations, this will not be called. If a page has annotations, this will be called. There may not be any code emitted for the annotations on that page, however, since they may not have any appearance for printing. The status parameter passed in the PDPageDidPrintAnnot() will indicate this.
 
void PDPageWillRemoveAnnot(PDPage page, ASInt32 annotIndex, void* clientData)
An annotation will be removed from a page.
Defines Detail
_PagePDEContentHFT_IS_BETA 
Product availability: All
Platform availability: All

Syntax

#define _PagePDEContentHFT_IS_BETA 0
File: PagePDECntCalls.h
Line: 98
_PagePDEContentHFT_LAST_BETA_COMPATIBLE_VERSION 
Product availability: All
Platform availability: All

Syntax

#define _PagePDEContentHFT_LAST_BETA_COMPATIBLE_VERSION 0x00060000
File: PagePDECntCalls.h
Line: 97
_PagePDEContentHFT_LATEST_VERSION 
Product availability: All
Platform availability: All

Syntax

#define _PagePDEContentHFT_LATEST_VERSION 0x00060000
File: PagePDECntCalls.h
Line: 96
kPDPageBlendingProfileValueStr 
Product availability: All
Platform availability: All

Syntax

#define kPDPageBlendingProfileValueStr "BlendingProfileDesc"
Description

Takes ASext as input. If set we use this profile as blending profile. kPDPageDisplayOverPrintPreviewStr must be set for this to get honored.

See Also

PDDrawPageOrCosObjectToBuffer

File: PDExpT.h
Line: 6684
kPDPageBlendingProfileValueStr 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kPDPageBlendingProfileValueStr "BlendingProfileDesc"
Description

Takes ASext as input. If set we use this profile as blending profile. kPDPageDisplayOverPrintPreviewStr must be set for this to get honored.

See Also

PDPageDrawContentsToMemoryEx
PDPageDrawFlags

File: PDFLExpT.h
Line: 1211
kPDPageDirectlyImposedStr 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kPDPageDirectlyImposedStr "DirectlyImposed"
Description

Directly imposed page.

See Also

PDPageDrawContentsToMemoryEx
PDPageDrawFlags

File: PDFLExpT.h
Line: 1112
kPDPageDisplayOverPrintPreviewStr 
Product availability: All
Platform availability: All

Syntax

#define kPDPageDisplayOverPrintPreviewStr "DisplayOverPrintPreview"
Description

Display overprint preview.

See Also

PDDrawPageOrCosObjectToBuffer

File: PDExpT.h
Line: 6626
kPDPageDisplayOverPrintPreviewStr 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kPDPageDisplayOverPrintPreviewStr "DisplayOverPrintPreview"
Description

Display overprint preview.

See Also

PDPageDrawContentsToMemoryEx
PDPageDrawFlags

File: PDFLExpT.h
Line: 1096
kPDPageDoLazyEraseStr 
Product availability: All
Platform availability: All

Syntax

#define kPDPageDoLazyEraseStr "DoLazyErase"
Description

Const strings used as ASCab keys when passing drawing flags. These are valid only for calls to PDDrawPageOrCosObjectToBuffer.

See Also

PDDrawPageOrCosObjectToBuffer Erase the page while rendering only as needed.
PDDrawPageOrCosObjectToBuffer

File: PDExpT.h
Line: 6598
kPDPageDoLazyEraseStr 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kPDPageDoLazyEraseStr "DoLazyErase"
Description

Const strings used as ASCab keys when passing PDPageDrawFlags. These are valid only for calls to PDPageDrawContentsToMemoryEx.

See Also

PDPageDrawSmoothFlags
PDPageDrawContentsToMemoryEx Erase the page while rendering only as needed.
PDPageDrawContentsToMemoryEx
PDPageDrawFlags

File: PDFLExpT.h
Line: 1064
kPDPageDoNotSubstituteWorkingSpacesStr 
Product availability: All
Platform availability: All

Syntax

#define kPDPageDoNotSubstituteWorkingSpacesStr "DoNotSubstituteWorkingSpaces"
Description

Do not substitute working spaces.

See Also

PDDrawPageOrCosObjectToBuffer

File: PDExpT.h
Line: 6647
kPDPageDoNotSubstituteWorkingSpacesStr 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kPDPageDoNotSubstituteWorkingSpacesStr "DoNotSubstituteWorkingSpaces"
Description

Do not substitute working spaces.

See Also

PDPageDrawContentsToMemoryEx
PDPageDrawFlags

File: PDFLExpT.h
Line: 1168
kPDPageDrawSmoothBicubicImageStr 
Product availability: All
Platform availability: All

Syntax

#define kPDPageDrawSmoothBicubicImageStr "SmoothImageUsingBicubicResampling"
Description

Draw smooth image using bicubic resampling. This option can have performance overhead.

See Also

PDDrawPageOrCosObjectToBuffer
PDPageDrawSmoothFlags

File: PDExpT.h
Line: 6716
kPDPageDrawSmoothBicubicImageStr 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kPDPageDrawSmoothBicubicImageStr "SmoothImageUsingBicubicResampling"
Description

Draw smooth image using bicubic resampling. This option can have performance overhead.

See Also

PDPageDrawContentsToMemoryEx
PDPageDrawSmoothFlags

File: PDFLExpT.h
Line: 1298
kPDPageDrawSmoothImageStr 
Product availability: All
Platform availability: All

Syntax

#define kPDPageDrawSmoothImageStr "SmoothImage"
Description

Draw smooth image.

See Also

PDDrawPageOrCosObjectToBuffer
PDPageDrawSmoothFlags

File: PDExpT.h
Line: 6708
kPDPageDrawSmoothImageStr 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kPDPageDrawSmoothImageStr "SmoothImage"
Description

Draw smooth image.

See Also

PDPageDrawContentsToMemoryEx
PDPageDrawSmoothFlags

File: PDFLExpT.h
Line: 1290
kPDPageDrawSmoothLineArtStr 
Product availability: All
Platform availability: All

Syntax

#define kPDPageDrawSmoothLineArtStr "SmoothLineArt"
Description

Draw smooth line art.

See Also

PDDrawPageOrCosObjectToBuffer
PDPageDrawSmoothFlags

File: PDExpT.h
Line: 6700
kPDPageDrawSmoothLineArtStr 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kPDPageDrawSmoothLineArtStr "SmoothLineArt"
Description

Draw smooth line art.

See Also

PDPageDrawContentsToMemoryEx
PDPageDrawSmoothFlags

File: PDFLExpT.h
Line: 1282
kPDPageDrawSmoothTextStr 
Product availability: All
Platform availability: All

Syntax

#define kPDPageDrawSmoothTextStr "SmoothText"
Description

Draw smooth text.

See Also

PDDrawPageOrCosObjectToBuffer
PDPageDrawSmoothFlags

File: PDExpT.h
Line: 6692
kPDPageDrawSmoothTextStr 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kPDPageDrawSmoothTextStr "SmoothText"
Description

Draw smooth text.

See Also

PDPageDrawContentsToMemoryEx
PDPageDrawSmoothFlags

File: PDFLExpT.h
Line: 1274
kPDPageEmitPageGroupStr 
Product availability: All
Platform availability: All

Syntax

#define kPDPageEmitPageGroupStr "EmitPageGroup"
Description

Emit a page group.

See Also

PDDrawPageOrCosObjectToBuffer

File: PDExpT.h
Line: 6640
kPDPageEmitPageGroupStr 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kPDPageEmitPageGroupStr "EmitPageGroup"
Description

Emit a page group.

See Also

PDPageDrawContentsToMemoryEx
PDPageDrawFlags

File: PDFLExpT.h
Line: 1128
kPDPageIgnoreIsolatedAndKnockoutTransparencyGroupStr 
Product availability: All
Platform availability: All

Syntax

#define kPDPageIgnoreIsolatedAndKnockoutTransparencyGroupStr "IgnoreIsolatedAndKnockoutTransparencyGroup"
Description

Ignore Isolated and Knockout transparency at page boundary.

See Also

PDDrawPageOrCosObjectToBuffer

File: PDExpT.h
Line: 6605
kPDPageIgnoreIsolatedAndKnockoutTransparencyGroupStr 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kPDPageIgnoreIsolatedAndKnockoutTransparencyGroupStr "IgnoreIsolatedAndKnockoutTransparencyGroup"
Description

Ignore Isolated and Knockout transparency at page boundary.

See Also

PDPageDrawContentsToMemoryEx
PDPageDrawFlags

File: PDFLExpT.h
Line: 1072
kPDPageIsPrintingStr 
Product availability: All
Platform availability: All

Syntax

#define kPDPageIsPrintingStr "IsPrinting"
Description

The page is being printed.

See Also

PDDrawPageOrCosObjectToBuffer

File: PDExpT.h
Line: 6619
kPDPageIsPrintingStr 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kPDPageIsPrintingStr "IsPrinting"
Description

The page is being printed.

See Also

PDPageDrawContentsToMemoryEx
PDPageDrawFlags

File: PDFLExpT.h
Line: 1088
kPDPageIsPSPrintingStr 
Product availability: All
Platform availability: All

Syntax

#define kPDPageIsPSPrintingStr "IsPSPrinting"
Description

PostScript printing.

See Also

PDDrawPageOrCosObjectToBuffer

File: PDExpT.h
Line: 6633
kPDPageIsPSPrintingStr 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kPDPageIsPSPrintingStr "IsPSPrinting"
Description

PostScript printing.

See Also

PDPageDrawContentsToMemoryEx
PDPageDrawFlags

File: PDFLExpT.h
Line: 1120
kPDPagePassMetadatatoAGMPortStr 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kPDPagePassMetadatatoAGMPortStr "PassMetadatatoAGMPort"
Description

Pass metadata to AGM port.

See Also

PDPageDrawContentsToMemoryEx
PDPageDrawFlags

File: PDFLExpT.h
Line: 1152
kPDPagePassOCtoAGMPortStr 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kPDPagePassOCtoAGMPortStr "PassOCtoAGMPort"
Description

Pass optional content to AGM port.

See Also

PDPageDrawContentsToMemoryEx
PDPageDrawFlags

File: PDFLExpT.h
Line: 1160
kPDPagePassOPItoAGMPortStr 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kPDPagePassOPItoAGMPortStr "PassOPItoAGMPort"
Description

Pass open prepress interface (OPI) to AGM port.

See Also

PDPageDrawContentsToMemoryEx
PDPageDrawFlags

File: PDFLExpT.h
Line: 1144
kPDPageStmSkipComments 
Product availability: All
Platform availability: All

Syntax

#define kPDPageStmSkipComments 0x0001
File: PDExpT.h
Line: 3855
kPDPageStmStringMax 
Product availability: All
Platform availability: All

Syntax

#define kPDPageStmStringMax 256
File: PDExpT.h
Line: 3852
kPDPageStmTokenHexString 
Product availability: All
Platform availability: All

Syntax

#define kPDPageStmTokenHexString 0x0001
File: PDExpT.h
Line: 3861
kPDPageSuppressRasterAlphaStr 
Product availability: All
Platform availability: All

Syntax

#define kPDPageSuppressRasterAlphaStr "SuppressRasterAlpha"
Description

Supress raster alpha.

See Also

PDDrawPageOrCosObjectToBuffer

File: PDExpT.h
Line: 6662
kPDPageSuppressRasterAlphaStr 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kPDPageSuppressRasterAlphaStr "SuppressRasterAlpha"
Description

Supress raster alpha.

See Also

PDPageDrawContentsToMemoryEx
PDPageDrawFlags

File: PDFLExpT.h
Line: 1185
kPDPageSwapComponentsStr 
Product availability: All
Platform availability: All

Syntax

#define kPDPageSwapComponentsStr "SwapComponents"
Description

Render colors in BGR order rather than RGB. It is only valid for calls to PDDrawPageOrCosObjectToBuffer() and only when outputing to an RGB colorspace.

See Also

PDDrawPageOrCosObjectToBuffer

File: PDExpT.h
Line: 6655
kPDPageSwapComponentsStr 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kPDPageSwapComponentsStr "SwapComponents"
Description

Render colors in BGR order rather than RGB. It is only valid for calls to PDPageDrawContentsToMemoryEx() and only when outputing to an RGB colorspace.

See Also

PDPageDrawContentsToMemoryEx
PDPageDrawFlags

File: PDFLExpT.h
Line: 1177
kPDPageUseAnnotFacesStr 
Product availability: All
Platform availability: All

Syntax

#define kPDPageUseAnnotFacesStr "UseAnnotFaces"
Description

Draw annotation appearances.

See Also

PDDrawPageOrCosObjectToBuffer

File: PDExpT.h
Line: 6612
kPDPageUseAnnotFacesStr 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kPDPageUseAnnotFacesStr "UseAnnotFaces"
Description

Draw annotation appearances.

See Also

PDPageDrawContentsToMemoryEx
PDPageDrawFlags

File: PDFLExpT.h
Line: 1080
kPDPageUsePrinterMarkAnnotsStr 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kPDPageUsePrinterMarkAnnotsStr "UsePrinterMarkAnnots"
Description

User printer's mark annotations.

See Also

PDPageDrawContentsToMemoryEx
PDPageDrawFlags

File: PDFLExpT.h
Line: 1136
kPDPageUseStampAnnotsOnlyStr 
Product availability: All
Platform availability: All

Syntax

#define kPDPageUseStampAnnotsOnlyStr "UseStampAnnotsOnly"
Description

If set, only consider Stamp annotations. This overrides kPDPageUseAnnotFaces.

See Also

PDDrawPageOrCosObjectToBuffer

File: PDExpT.h
Line: 6676
kPDPageUseStampAnnotsOnlyStr 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kPDPageUseStampAnnotsOnlyStr "UseStampAnnotsOnly"
Description

If set, only consider Stamp annotations. This overrides kPDPageUseAnnotFaces.

See Also

PDPageDrawContentsToMemoryEx
PDPageDrawFlags

File: PDFLExpT.h
Line: 1202
kPDPageUseTrapAnnotsStr 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kPDPageUseTrapAnnotsStr "UseTrapAnnots"
Description

Use trap network annotations.

See Also

PDPageDrawContentsToMemoryEx
PDPageDrawFlags

File: PDFLExpT.h
Line: 1104
kPDPageWorkingSpacesOnlyForChangeStr 
Product availability: All
Platform availability: All

Syntax

#define kPDPageWorkingSpacesOnlyForChangeStr "WorkingSpacesOnlyForChange"
Description

If this is set, only use a working space instead of a device space if the process color model of the target device is different than that of the source.


File: PDExpT.h
Line: 6669
kPDPageWorkingSpacesOnlyForChangeStr 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kPDPageWorkingSpacesOnlyForChangeStr "WorkingSpacesOnlyForChange"
Description

If this is set, only use a working space instead of a device space if the process color model of the target device is different than that of the source.

See Also

PDPageDrawContentsToMemoryEx
PDPageDrawFlags

File: PDFLExpT.h
Line: 1194
PagePDEContentHFT_LATEST_VERSION 
Product availability: All
Platform availability: All

Syntax

#define PagePDEContentHFT_LATEST_VERSION _PagePDEContentHFT_LATEST_VERSION)
File: PagePDECntCalls.h
Line: 101
PagePDEContentHFT_VERSION_4 
Product availability: All
Platform availability: All

Syntax

#define PagePDEContentHFT_VERSION_4 0x00040000
File: PagePDECntCalls.h
Line: 103
PagePDEContentHFT_VERSION_5 
Product availability: All
Platform availability: All

Syntax

#define PagePDEContentHFT_VERSION_5 0x00050000
File: PagePDECntCalls.h
Line: 104
PagePDEContentHFT_VERSION_6 
Product availability: All
Platform availability: All

Syntax

#define PagePDEContentHFT_VERSION_6 0x00060000
File: PagePDECntCalls.h
Line: 105
PagePDEContentHFTName 
Product availability: All
Platform availability: All

Syntax

#define PagePDEContentHFTName "PagePDEContent"
File: PEVers.h
Line: 32

Typedefs Detail
PDPage 
Product availability: All
Platform availability: All

Syntax

typedef struct _t_PDPage* PDPage;

A single page in the PDF representation of a document. Just as PDF files are partially composed of their pages, PDDoc objects are composed of PDPage objects. A page contains a series of objects representing the objects drawn on the page (PDGraphic), a list of resources used in drawing the page, annotations (PDAnnot), an optional thumbnail image of the page, and the beads used in any articles that occur on the page. The first page in a PDDoc is page 0.

See Also

PDDocCreatePage
PDBeadAcquirePage
PDDocAcquirePage
AVPageViewGetPage
PDDocDeletePages
PDPageRelease

File: PDBasicExpT.h
Line: 77
PDPageInk 
Product availability: All
Platform availability: All

Syntax

typedef _t_PDPageInkRec PDPageInk;

File: PDExpT.h
Line: 5891
PDPageInkRec 
Product availability: All
Platform availability: All

Syntax

typedef _t_PDPageInkRec PDPageInkRec;

File: PDExpT.h
Line: 5891
PDPageNumber 
Product availability: All
Platform availability: All

Syntax

typedef ASInt32 PDPageNumber;

A 0-based page number for use in AVPageView and AVDoc methods. Negative for special values.

See Also

AVDocGetPageText
AVDocGetViewDef
AVPageViewGetFirstVisiblePageNum
AVPageViewGetLastVisiblePageNum
AVPageViewGetNextView
AVPageViewGetPageNum
AVPageViewGetSelectedAnnotPageNum
AVPageViewGetVisibleAnnotPage
AVPageViewGoTo
AVPageViewPageNumIsVisible
AVPageViewSetPageNum
AVDocSelectionGetAVRectProc
AVSelectionPageRangeEnumProc

File: PDExpT.h
Line: 51
PDPageRange 
Product availability: All
Platform availability: All

Syntax

typedef _t_PDPageRange PDPageRange;

File: PDExpT.h
Line: 5486
PDPageStmToken 
Product availability: All
Platform availability: All

Syntax

typedef _t_PDPageStmToken PDPageStmToken;

File: PDExpT.h
Line: 3895
PDPageStmTokenRec 
Product availability: All
Platform availability: All

Syntax

typedef _t_PDPageStmToken PDPageStmTokenRec;

File: PDExpT.h
Line: 3895

Enumeration Detail
PDPageArea
Product availability: All
Platform availability: All

Syntax

enum PDPageArea {
 kPDPageArea,
 
 kPDClipArea,
 
 kPDNumAreas
}

File: PDExpT.h
Line: 6233

PDPageDrawFlags 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

enum PDPageDrawFlags {
 kPDPageDoLazyErase = 0x00000001,
 
 kPDPageIgnoreIsolatedAndKnockoutTransparencyGroup = 0x00000010,
 
 kPDPageUseAnnotFaces = 0x00000040,
 
 kPDPageIsPrinting = 0x00000080,
 
 kPDPageDisplayOverPrintPreview = 0x00000100,
 
 kPDPageUseTrapAnnots = 0x00002000,
 
 kPDPageDirectlyImposed = 0x00004000,
 
 kPDPageIsPSPrinting = 0x00008000,
 
 kPDPageEmitPageGroup = 0x00010000,
 
 kPDPageUsePrinterMarkAnnots = 0x00020000,
 
 kPDPagePassOPItoAGMPort = 0x00040000,
 
 kPDPagePassMetadatatoAGMPort = 0x00080000,
 
 kPDPagePassOCtoAGMPort = 0x00100000,
 
 kPDPageDoNotSubstituteWorkingSpaces = 0x00800000,
 
 kPDPageSwapComponents = 0x01000000,
 
 kPDPageSuppressRasterAlpha = 0x02000000,
 
 kPDPageWorkingSpacesOnlyForChange = 0x04000000,
 
 kPDPageUseStampAnnotsOnly = 0x08000000
}

File: PDFLExpT.h
Line: 988

Elements
kPDPageDoLazyErase  

Erase the page while rendering only as needed.

 
kPDPageIgnoreIsolatedAndKnockoutTransparencyGroup  

Ignore Isolated and Knockout transparency at page boundary.

 
kPDPageUseAnnotFaces  

Draw annotation appearances.

 
kPDPageIsPrinting  

The page is being printed.

 
kPDPageDisplayOverPrintPreview  

Display overprint preview.

 
kPDPageUseTrapAnnots  

Use trap network annotations.

 
kPDPageDirectlyImposed  

Directly imposed page.

 
kPDPageIsPSPrinting  

PostScript printing.

 
kPDPageEmitPageGroup  

Emit a page group.

 
kPDPageUsePrinterMarkAnnots  

User printer's mark annotations.

 
kPDPagePassOPItoAGMPort  

Pass open prepress interface (OPI) to AGM port.

 
kPDPagePassMetadatatoAGMPort  

Pass metadata to AGM port.

 
kPDPagePassOCtoAGMPort  

Pass optional content to AGM port.

 
kPDPageDoNotSubstituteWorkingSpaces  

Do not substitute working spaces.

 
kPDPageSwapComponents  

Render colors in BGR order rather than RGB. It is only valid for calls to PDPageDrawContentsToMemory() and only when outputing to an RGB colorspace.

 
kPDPageSuppressRasterAlpha  

Supress raster alpha.

 
kPDPageWorkingSpacesOnlyForChange  

If this is set, only use a working space instead of a device space if the process color model of the target device is different than that of the source

 
kPDPageUseStampAnnotsOnly  

If set, only consider Stamp annotations. This overrides kPDPageUseAnnotFaces.

PDPageDrawFlagsPI 
Product availability: All
Platform availability: All

Syntax

enum PDPageDrawFlagsPI {
 kPDPageDisplayOverPrintPreviewPI = 0x00000100,
 
 kPDPageUseAnnotFacesPI = 0x00000040,
 
 kPDPageUseStampAnnotsOnlyPI = 0x08000000
}

File: PDExpT.h
Line: 6589

Elements
kPDPageDisplayOverPrintPreviewPI  

Display the page with Overprint Preview.

 
kPDPageUseAnnotFacesPI  

Draw annotation appearances.

 
kPDPageUseStampAnnotsOnlyPI  

If this is set, only consider Stamp annotations. This overrides kPDPageUseAnnotFaces.

PDPageDrawSmoothFlags 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

enum PDPageDrawSmoothFlags {
 kPDPageDrawSmoothText = 0x00000001,
 
 kPDPageDrawSmoothLineArt = 0x00000002,
 
 kPDPageDrawSmoothImage = 0x00000004,
 
 kPDPageDrawSmoothBicubicImage = 0x00000008
}

See Also

PDPageDrawFlags
PDPageDrawContentsToMemory

File: PDFLExpT.h
Line: 1252

Elements
kPDPageDrawSmoothText  

Draw smooth text.

 
kPDPageDrawSmoothLineArt  

Draw smooth line art.

 
kPDPageDrawSmoothImage  

Draw smooth image.

 
kPDPageDrawSmoothBicubicImage  

Draw smooth image using bicubic resampling. This option can have performance overhead

PDPageMarkFlags 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

enum PDPageMarkFlags {
 kPDPageEmitColorBars = 0x0001,
 
 kPDPageEmitRegMarks = 0x0002,
 
 kPDPageEmitCropMarks = 0x0004,
 
 kPDPageEmitBleedMarks = 0x0008,
 
 kPDPageEmitPageInfo = 0x0010,
 
 kPDPageEmitTrimMarks = 0x0020,
 
 kPDPageEmitSlurMarks = 0x0040
}

See Also

PDPrintParams
PDFLPrintDoc
PDPageEmitPSOrient
AVDocPrintSeparations
PDPageMakeSeparations

File: PDFLExpT.h
Line: 432

PDPageMode 
Product availability: All
Platform availability: All

Syntax

enum PDPageMode {
 PDDontCare,
 
 PDUseNone,
 
 PDUseThumbs,
 
 PDUseBookmarks,
 
 PDFullScreen,
 
 PDContents,
 
 PDUseOC,
 
 PDUseAttachments
}

See Also

AVDocGetViewMode
AVDocSetViewMode
PDDocGetPageMode
PDDocSetPageMode

File: PDExpT.h
Line: 1941

Elements
PDDontCare  

Leaves the view mode as is.

 
PDUseNone  

Displays the document, but displays neither thumbnails nor bookmarks.

 
PDUseThumbs  

Displays the document plus thumbnails.

 
PDUseBookmarks  

Displays the document plus bookmarks.

 
PDFullScreen  

Displays the document in full-screen viewing mode. This is equivalent to AVAppBeginFullScreen().

 
PDUseAttachments  

Displays the document plus attachments.

PDPageTilingMode 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

enum PDPageTilingMode {
 kPDNoPageTiling = 0,
 
 kPDTileAllPages,
 
 kPDTileLargePages
}

File: PDFLExpT.h
Line: 305

Elements
kPDNoPageTiling  

Print all pages normally

 
kPDTileAllPages  

Use tiling settings for all pages

 
kPDTileLargePages  

Use tiling only for pages larger than size indicated in PDTileRec of tileInfo


Structure Detail
_t_PDPageInkRec
Product availability: All
Platform availability: All

Syntax

struct _t_PDPageInkRec {
 ASSize_t size; 
 
 ASAtom colorantName; 
 
 ASBool isProcessColor; 
 
 ASUns8 whatToDo; 
 
 ASUns8 r; 
 
 ASUns8 g; 
 
 ASUns8 b; 
 
 float frequency; 
 
 float angle; 
 
 ASUns8 inkType; 
 
 ASInt32 trapSequence; 
 
 float cyan; 
 
 float magenta; 
 
 float yellow; 
 
 float black; 
 
 float density; 
 
 ASAtom alias; 
}

Represents an ink used on a page.

See Also

AVPageViewGetNumVisibleInks
AVPageViewGetVisibleInks
AVPageViewSetInkPreview
AVPageViewSetVisibleInks
PDPageEnumInks

File: PDExpT.h
Line: 5843

Elements
size  

The size of the structure. It must be set to sizeof(PDPageInkRec).

 
colorantName  

The name of the colorant from the Separation or DeviceN colorspace, or the process color name.

 
isProcessColor  

true if this is a process color, false if this is a spot color.

 
whatToDo  

How to handle the colorant for a separation preview. Its value can be:

  • kEmitColorant

  • kDontEmitColorant

  • kConvertToProcess

 
r  

RGB values for on-screen display of a colorswatch.

 
frequency  

The frequency for this ink.

 
angle  

The angle for this ink.

 
inkType  

The ink type for this ink.

 
trapSequence  

The trap sequence for this ink.

 
cyan  

The neutral density for this ink.

 
alias  

Alias this spot to another.

_t_PDPageRange 
Product availability: All
Platform availability: All

Syntax

struct _t_PDPageRange {
 ASInt32 startPage; 
 
 ASInt32 endPage; 
 
 ASInt32 pageSpec; 
}

Specifies a range of pages in a document. Page numbers begin with 0.


File: PDExpT.h
Line: 5479

Elements
startPage  

The starting page number.

 
endPage  

The ending page number.

 
pageSpec  

The pages in the range to print. It must be one of: PDAllPages, PDEvenPagesOnly, or PDOddPagesOnly.

_t_PDPageStmToken 
Product availability: All
Platform availability: All

Syntax

struct _t_PDPageStmToken {
 ASSize_t size; 
 
 CosType type; 
 
 ASUns32 flags; 
 
 ASInt32 iVal; 
 
 char sVal[kPDPageStmStringMax]; 
 
 ASSize_t sValLen; 
}

A data structure used by PDPageStmGetToken(). It contains information about the current page contents token.

See Also

PDPageStmGetToken

File: PDExpT.h
Line: 3882

Elements
size  

The size of this record. It is to be filled in by the caller.

 
type  

The type of token.

 
flags  

Additional information about the token (for example, indicating a hex string).

 
iVal  

The value of the token if it is a CosInteger, ASFixed, or Name.

 
sVal  

The value of the token if it is a CosString.

 
sValLen  

The number of bytes in sVal.

Callbacks Detail
PagePDEContentDidChangeNPROTO 
Product availability: All
Platform availability: All

Syntax

void (*PagePDEContentDidChangeNPROTO)(PDPage pdPage, PDEContent pagesPDEContent)

File: PagePDECntCalls.h
Line: 115
PagePDEContentNotCachedNPROTO 
Product availability: All
Platform availability: All

Syntax

void (*PagePDEContentNotCachedNPROTO)(PDPage pdPage, PDEContent pagesPDEContent)

File: PagePDECntCalls.h
Line: 117
PDPageEnumInksCallback 
Product availability: All
Platform availability: All

Syntax

ASBool (*PDPageEnumInksCallback)(PDPageInk ink, void *clientData)

Used for enumerating the inks on a page via PDPageEnumInks().


File: PDExpT.h
Line: 5894
PDPageStmImageDataProc 
Product availability: All
Platform availability: All

Syntax

ASBool (*PDPageStmImageDataProc)(ASUns8 *data, ASSize_t dataLen, void *clientData)

A callback for PDPageStmGetInlineImage(). It should be called when inline image data is encountered in PDPageStmGetToken(). This method may be called multiple times for one inline image. If so, each call provides sequential data for the image.

See Also

PDPageStmGetInlineImage
PDPageStmGetToken

File: PDExpT.h
Line: 3934
PDPageStmStringOverflowProc 
Product availability: All
Platform availability: All

Syntax

void (*PDPageStmStringOverflowProc)(char *sVal, ASSize_t sValLen, void *clientData)

A callback used by PDPageStmGetToken(). It is called when the length of a string token exceeds kPDPageStmStringMax bytes (see PDExpT.h) in PDPageStmGetToken().

See Also

PDPageStmGetToken

File: PDExpT.h
Line: 3911

Method Detail
PDPageAcquirePage()
Product availability: All
Platform availability: All

Syntax

void PDPageAcquirePage(PDPage pdPage)

Increments the page's reference count. After you are done using the page, release it using PDPageRelease(). If PDPageRelease() is not called, it could block the document containing the page from being closed. To avoid such problems use the CSmartPDPage class as it ensures that the page is released as it goes out of scope.

Parameters

pdPage — 

IN The page whose reference count is to be incremented.

See Also

CSmartPDPage
PDPageRelease

Since

PI_PDMODEL_VERSION >= 0x00070000.

File: PDProcs.h
Line: 11001
PDPageAddAnnot() 
Product availability: Acrobat, PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

void PDPageAddAnnot(PDPage aPage, ASInt32 addAfter, PDAnnot annot)

Adds an annotation at the specified location in a page's annotation array.

Parameters

aPage — 

The page to which the annotation is added.
 
addAfter — 

The index into the page's annotation array where the annotation is added. See Section 8.4 in the PDF Reference for a description of the annotation array. The first annotation in the array has an index of zero. Passing a value of -2 adds the annotation to the end of the array. Passing other negative values produces undefined results.
 
annot — 

The annotation to add.

See Also

PDPageCreateAnnot
PDPageAddNewAnnot
PDPageRemoveAnnot

Exceptions

pdErrOpNotPermitted is raised if:

Notifications

PDPageWillAddAnnot
PDPageDidAddAnnot

Since

PI_PDMODEL_VERSION >= 0x00020000

File: PDProcs.h
Line: 3345
PDPageAddCosContents() 
Product availability: Acrobat, PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

void PDPageAddCosContents(PDPage page, CosObj newContents)

Completely replaces the contents of the specified page with newContents.

Parameters

page — 

IN/OUT The page whose Cos contents are replaced.

 
newContents — 

IN/OUT A stream Cos object or an array Cos object containing the new contents (stream Cos objects) for page.

See Also

PDPageRemoveCosContents

Notifications

PDDocDidChangePages

Since

PI_PDMODEL_VERSION >= 0x00020000

File: PDProcs.h
Line: 3472
PDPageAddCosResource() 
Product availability: Acrobat, PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

void PDPageAddCosResource(PDPage page, const char* resType, const char* resName, CosObj resObj)

Adds a Cos resource to a page object. See Section 3.7.2 in the PDF Reference for a description of page resources.

The necessary dictionaries are created automatically if the page does not already have any resources of the type specified by resType, or does not have a Resources dictionary. For example, if you specify a font resource, but the page does not already have a font resource dictionary, this method automatically creates one and puts the font you specify into it.

ProcSet resources cannot be added using this method; they must be added using Cos-level methods to:

Parameters

page — 

The page to which a resource is added.

 
resType — 

The resource type. The named resource types in PDF are: ExtGState, ColorSpace, Pattern, Shading, XObject, Font, and Properties. Although ProcSet is also a valid resource type, it cannot be added by this method.

 
resName — 

The resource name (for example, the name of a font might be F1).

 
resObj — 

The Cos object being added as a resource to page.

See Also

PDPageRemoveCosResource
PDPageGetCosResources

Notifications

PDDocDidChangePages

Since

PI_PDMODEL_VERSION >= 0x00020000

File: PDProcs.h
Line: 3458
PDPageAddNewAnnot() 
Product availability: Acrobat, PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

PDAnnot PDPageAddNewAnnot(PDPage aPage, ASInt32 addAfter, ASAtom subType, const ASFixedRect* initialRect)

Adds an annotation to the page. To make the annotation visible after adding it, convert the coordinates of initialRect to device coordinates using AVPageViewRectToDevice(), then call AVPageViewInvalidateRect() using the converted rectangle. This method is equivalent to calling PDPageCreateAnnot() followed by PDPageAddAnnot().

The PDPageWillAddAnnot() and PDPageDidAddAnnot() notifications are broadcast before the PDPageAddNewAnnot() method returns. If you want to finish formatting the annotation before these notifications are called, for example, by adding additional key-value pairs to the annotation dictionary, you should call PDPageCreateAnnot() followed by PDPageAddAnnot() instead of PDPageAddNewAnnot().

Parameters

aPage — 

The page to which the annotation is added.

 
addAfter — 

Where to add the annotation in the page's annotation array. See Section 8.4 in the PDF Reference for a description of the annotation array. Passing a value of -2 adds the annotation to the end of the array (this is generally what you should do unless you have a need to place the annotation at a special location in the array). Passing a value of -1 adds the annotation to the beginning of the array. Passing other negative values produces undefined results.

 
subType — 

The subtype of the annotation to add.

 
initialRect — 

A pointer to a rectangle specifying the annotation's bounds, specified in user space coordinates.

Returns

The newly created annotation.

See Also

PDPageCreateAnnot
PDPageAddAnnot
PDPageRemoveAnnot

Exceptions

pdErrOpNotPermitted is raised if:

Notifications

PDPageWillAddAnnot
PDPageDidAddAnnot

Since

PI_PDMODEL_VERSION >= 0x00020000

File: PDProcs.h
Line: 3318
PDPageContentsDidChange() 
Product availability: All
Platform availability: All

Syntax

void PDPageContentsDidChange(PDPage page, void* clientData)

The contents of a page have changed and the page will be redrawn.

Parameters

page — 

The page whose contents changed.

 
clientData — 

A pointer to a block of user-supplied data that was passed when the client registered for this notification using AVAppRegisterNotification() .

See Also

PDPageNotifyContentsDidChange
PDPageNotifyContentsDidChangeEx

Notifications

PDPageContentsDidChangeEx

File: PIPokes.h
Line: 853
PDPageContentsDidChangeEx() 
Product availability: All
Platform availability: All

Syntax

void PDPageContentsDidChangeEx(PDPage page, ASBool invalidateViews, void* clientData)

The contents of a page changed. Unlike PDPageContentsDidChange() , this notification specifies whether the page is redrawn immediately.

Parameters

page — 

The page whose contents changed.

 
invalidateViews — 

If true, the page is redrawn immediately. If false, redrawing is suppressed.

 
clientData — 

A pointer to a block of user-supplied data that was passed when the client registered for this notification using AVAppRegisterNotification() .

See Also

PDPageNotifyContentsDidChange
PDPageNotifyContentsDidChangeEx

Notifications

PDPageContentsDidChange

File: PIPokes.h
Line: 1151
PDPageCreateAnnot() 
Product availability: Acrobat, PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

PDAnnot PDPageCreateAnnot(PDPage aPage, ASAtom subType, const ASFixedRect* initialLocation)

Creates a new annotation, associated with the specified page's CosDoc, but not added to the page. Use PDPageAddAnnot() to add the annotation to the page.

If you want to create an annotation that prints even if the annotation handler is not present, you must provide an appearance for it. To do this, add an appearance key (AP) to the annotation dictionary, in which you place the Forms XObject for the Normal (N), Rollover (R), and Down (D) appearances; only the Normal appearance is required. Also, add a flags field (F) to the annotation dictionary and set the appropriate value for the bit field. A value of 4, which displays the annotation if the handler is not present, shows the annotation, and allows printing it, is recommended.

Parameters

aPage — 

The page to whose PDDoc the annotation is added.

 
subType — 

The subtype of annotation to create.

 
initialLocation — 

A pointer to a rectangle specifying the annotation's bounds, specified in user space coordinates.

Returns

The newly created annotation.

See Also

PDPageAddAnnot
PDPageAddNewAnnot

Exceptions

pdErrOpNotPermitted is raised if:

Notifications

PDAnnotWasCreated

Since

PI_PDMODEL_VERSION >= 0x00020000

File: PDProcs.h
Line: 299
PDPageCreatePrintRecord() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

void PDPageCreatePrintRecord(void* devmode, ASBool* bl, void* clientData)

Parameters

devmode
 
bl
 
clientData


File: PIPokes.h
Line: 2732
PDPageDidAddAnnot() 
Product availability: All
Platform availability: All

Syntax

void PDPageDidAddAnnot(PDPage page, PDAnnot annot, ASInt32 error, void* clientData)

An annotation was added to a page.

Parameters

page — 

The page to which the annotation was added.
 
annot — 

The annotation that was added.

 
error — 

The error code. error is set to 0 if no errors occurred while adding the annotation. If an error occurred, error contains the error code.

 
clientData — 

A pointer to a block of user-supplied data that was passed when the client registered for this notification using AVAppRegisterNotification() .

See Also

PDPageAddAnnot
PDPageAddNewAnnot

Notifications

PDPageWillAddAnnot

File: PIPokes.h
Line: 886
PDPageDidPrintAnnot() 
Product availability: All
Platform availability: All

Syntax

void PDPageDidPrintAnnot(PDAnnot annot, ASInt32 page, ASInt32 status, void* clientData)

Clients who register for PDPageDidPrintAnnot() will be called after the annotation has printed. status indicates whether Acrobat tried to print any representation of this annotation.

Parameters

annot — 

The annotation that Acrobat tried to print.
 
page — 

The page on which the annotation occurs.

 
status — 

A status of 0 indicates that no representation of the annotation was found. A status of 1 indicates the annotation was printed.

 
clientData — 

A pointer to a block of user-supplied data that was passed when the client registered for this notification using AVAppRegisterNotification() .

See Also

Numerous

Notifications

PDPageDidPrintAnnot
PDPageWillPrintAnnot
PDPageWillPrintAnnots

File: PIPokes.h
Line: 2124
PDPageDidPrintAnnots() 
Product availability: All
Platform availability: All

Syntax

void PDPageDidPrintAnnots(PDDoc doc, ASInt32 page, ASStm stm, void* clientData)

Annotations were printed.

Parameters

doc — 

The document containing the annotations.

 
page — 

The page containing the annotations.

 
stm — 

The PostScript print stream used when printing to a PostScript printer, and NULL when printing to a non-PostScript printer. When printing to a PostScript printer, clients can write printing commands into stm (using ASStmWrite() ) to add marks to pages before any other marks have been made.
 
clientData — 

A pointer to a block of user-supplied data that was passed when the client registered for this notification using AVAppRegisterNotification() .

See Also

Numerous

Notifications

PDPageDidPrintAnnot
PDPageWillPrintAnnot
PDPageWillPrintAnnots

File: PIPokes.h
Line: 1963
PDPageDidRedraw() 
Product availability: All
Platform availability: All

Syntax

void PDPageDidRedraw(PDPage page, void* clientData)

Sent when the page is redrawn via PDPageRedraw().

Parameters

page — 

The page being redrawn.

 
clientData — 

A pointer to a block of user-supplied data that was passed when the client registered for this notification using AVAppRegisterNotification() .


File: PIPokes.h
Line: 2694
PDPageDidRemoveAnnot() 
Product availability: All
Platform availability: All

Syntax

void PDPageDidRemoveAnnot(PDPage page, ASInt32 annotIndex, ASInt32 error, void* clientData)

Superseded by PDPageDidRemoveAnnotEx() in Acrobat 6.0.

An annotation has been removed from a page.

Parameters

page — 

The page from which an annotation was removed.
 
annotIndex — 

The index (in the page's annotation array) of the annotation that was removed. Because the annotation has already been removed from the array, it is not possible to access the annotation using annotIndex.

 
error — 

The error code. error is set to 0 if no errors occurred while removing the annotation. If an error occurred, error contains the error code.

 
clientData — 

A pointer to a block of user-supplied data that was passed when the client registered for this notification using AVAppRegisterNotification() .

See Also

PDPageRemoveAnnot

Notifications

PDPageWillRemoveAnnot

File: PIPokes.h
Line: 924
PDPageDidRemoveAnnotEx() 
Product availability: All
Platform availability: All

Syntax

void PDPageDidRemoveAnnotEx(PDPage page, PDAnnot removedAnnot, ASInt32 error, void* clientData)

Supersedes PDPageDidRemoveAnnot() in Acrobat 6.0 and later.

An annotation has been removed from a page.

Parameters

page — 

The page from which an annotation was removed.

 
removedAnnot — 

The annotation object that was removed.

 
error — 

The error code. error is set to 0 if no errors occurred while removing the annotation. If an error occurred, error contains the error code.

 
clientData — 

A pointer to a block of user-supplied data that was passed when the client registered for this notification using AVAppRegisterNotification() .

See Also

PDPageRemoveAnnot

Notifications

PDPageWillRemoveAnnot

File: PIPokes.h
Line: 2423
PDPageDirectDrawToPlatform() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

void PDPageDirectDrawToPlatform(void* clientData)

Parameters

clientData


File: PIPokes.h
Line: 2743
PDPageDrawContentsToWindow() 
Product availability: All
Platform availability: All

Syntax

void PDPageDrawContentsToWindow(PDPage page, void* window, void* displayContext, ASBool isDPS, ASFixedMatrix* matrix, ASFixedRect* updateRect, CancelProc cancelProc, void* cancelProcClientData)

Draws the contents of a page into the specified window.

This method just draws a bitmap to the window. If you want a live document, you need to open an AVDoc for the PDF file.

The page can also be derived from a PDDoc.

On UNIX, this method cannot be used to draw into a window. UNIX developers should instead use AVDocOpenFromASFileWithParamString() to draw PDF files into their own window from a client.

Parameters

page — 

The page to draw into window.

 
window — 

A pointer to a platform-dependent window object (HWND on Windows, or WindowPtr or CWindowPtr on Mac OS). On Windows, to draw into an offscreen DC, pass NULL for window. On Mac 32, to draw into an offscreen GWorld, pass NULL in window and pass the GWorldPtr in displayContext.

 
displayContext — 

A platform-dependent display context structure (HDC on Windows, GWorldPtr on Mac OS). On Mac OS, displayContext is ignored if window is non-NULL. Note that displayContext cannot be reliably used as the hDC for a printer device. This API is not available on Mac 64.

 
isDPS — 

Currently unused. Always set it to false.

 
matrix — 

A pointer to the matrix to concatenate onto the default page matrix. It is useful for converting from page to window coordinates and for scaling.

 
updateRect — 

A pointer to the rectangle to draw, defined in user space coordinates. Any objects outside of updateRect will not be drawn. All objects are drawn if updateRect is NULL.

 
cancelProc — 

The procedure called periodically to check for the user's cancelling of the drawing operation. The default cancel proc can be obtained using AVAppGetCancelProc(). It may be NULL, in which case no cancel proc is used.

 
cancelProcClientData — 

A pointer to user-supplied data to pass to cancelProc each time it is called. It should be NULL if cancelProc is NULL.

See Also

AVAppGetCancelProc
PDDrawCosObjToWindow
PDPageDrawContentsToWindowEx

Since

PI_PDMODEL_VERSION >= 0x00020000

File: PDProcs.h
Line: 3258
PDPageDrawContentsToWindowEx() 
Product availability: All
Platform availability: All

Syntax

void PDPageDrawContentsToWindowEx(PDPage page, void* window, void* displayContext, ASBool isDPS, ASFixedMatrix* matrix, ASUns32 flags, ASFixedRect* updateRect, CancelProc cancelProc, void* cancelProcClientData)

Provides control over the rendering of annotations on the page to be drawn into window. It provides the ability to specify the flags passed in to the PDPageDrawContentsToWindows() function.

Parameters

page — 

The page to draw into window.

 
window — 

A pointer to a platform-dependent window object (HWND on Windows, or WindowPtr or CWindowPtr on Mac OS). On Windows, to draw into an offscreen DC, pass NULL for window. On Mac 32, to draw into an offscreen GWorld, pass NULL in window and pass the GWorldPtr in displayContext.

 
displayContext — 

A platform-dependent display context structure (HDC on Windows, GWorldPtr on Mac OS). On Mac 32, displayContext is ignored if window is non-NULL Note that displayContext cannot be reliably used as the hDC for a printer device. This API is not available on Mac 64.

 
isDPS — 

Currently unused. Always set it to false.

 
matrix — 

A pointer to the matrix to concatenate onto the default page matrix. It is useful for converting from page to window coordinates and for scaling.

 
flags — 

See PDPageDrawFlagsPI for possible values.

 
updateRect — 

A rectangle represented by the coordinates of its four sides.

 
cancelProc — 

A procedure called periodically to check for the user's cancelling of the drawing operation. The default cancel procedure can be obtained using AVAppGetCancelProc(). It may be NULL in which case no cancel procedure is used.

 
cancelProcClientData — 

A pointer to user-supplied data to pass to cancelProc each time it is called. It should be NULL if cancelProc is NULL.

See Also

AVAppGetCancelProc
PDDrawCosObjToWindow
PDPageDrawContentsToWindow

Exceptions

pdPErrUnableToCreateRasterPort

Since

PI_PDMODEL_VERSION >= 0x00050000

File: PDProcs.h
Line: 7923
PDPageDrawContentsWithParams() 
Product availability: All
Platform availability: All

Syntax

void PDPageDrawContentsWithParams(PDPage page, PDDrawParams params)

Provides control over the rendering of contents on the page, including both those parameters you would pass to PDPageDrawContentsToWindowEx(), and an optional-content context that determines which contents are visible. This API is not available on Mac 64.

Parameters

page — 

The page to draw.

 
params — 

The parameters with which to draw the page, including the optional-content context to use for content visibility.

See Also

PDPageDrawContentsToWindow
PDPageDrawContentsToWindowEx

Exceptions

pdPErrUnableToCreateRasterPort

Since

PI_PDMODEL_VERSION >= 0x00060000

File: PDProcs.h
Line: 10376
PDPageEnumContents() 
Product availability: All
Platform availability: All

Syntax

void PDPageEnumContents(PDPage page, PDGraphicEnumMonitor mon, void* clientData)

Enumerates the contents of a page, calling a procedure for each drawing object in the page description.

Parameters

page — 

IN/OUT The page whose contents are enumerated.

 
mon — 

IN/OUT A pointer to a structure containing user-supplied callbacks that are called for each drawing operator on a page. Enumeration ends if any procedure returns false.

 
clientData — 

IN/OUT A pointer to user-supplied data to pass to mon each time it is called.

Since

PI_PDMODEL_VERSION >= 0x00020000

File: PDProcs.h
Line: 3547
PDPageEnumInks() 
Product availability: All
Platform availability: All

Syntax

void PDPageEnumInks(PDPage pdPage, PDPageEnumInksCallback proc, void* clientData, ASBool includeOPI)

Enumerates the inks for a page, calling the supplied procedure for each PDPageInk structure.

For the DeviceCMYK_K process color model, it always finds the four inks Cyan, Magenta, Yellow, and Black, which are marked as process inks. The RGB values in the PDPageInk structure are the RGB equivalents (in system monitor space) of 100% of the ink, which can be used to show color swatches for a given ink.

If the inks are part of a DeviceN colorspace which has not been defined in a Colorants dictionary or elsewhere in a Separation colorspace, the color of the swatch is undefined.

This call finds all color spaces that are in a color space dictionary within the page, even if they are not used by the page contents.

Parameters

pdPage — 

The page whose contents are enumerated.

 
proc — 

The user-supplied callback procedure to be applied to each ink. Enumeration ends if any procedure returns false.

 
clientData — 

A pointer to user-supplied data to pass to proc each time it is called.

 
includeOPI — 

If true, enumerate inks contained in OPI dictionaries.

See Also

PDPageMakeSeparations
AVPageViewGetNumVisibleInks
AVPageViewGetVisibleInks
AVPageViewGetPixelInformationAtPoint
AVPageViewSetInkPreview
AVPageViewSetVisibleInks

Since

PI_PDMODEL_VERSION >= 0x00060000

File: PDProcs.h
Line: 8201
PDPageEnumInksEx() 
Product availability: All
Platform availability: All

Syntax

void PDPageEnumInksEx(PDPage pdPage, PDPageEnumInksCallback proc, void* clientData, ASBool includeOPI, ASAtom colorModel)

Enumerates the inks for a page, calling the supplied procedure for each PDPageInk structure. This differs from PDPageEnumInks() in that it allows the process color model to be passed in.

For the DeviceCMYK_K process color model, it always finds the four inks Cyan, Magenta, Yellow, and Black, which are marked as process inks. The RGB values in the PDPageInk structure are the RGB equivalents (in system monitor space) of 100% of the ink, which can be used to show color swatches for a given ink.

If the inks are part of a DeviceN color space which has not been defined in a Colorants dictionary or elsewhere in a Separation color space, the color of the swatch is undefined.

This call finds all color spaces that are in a color space dictionary within the page, even if they are not used by the page contents.

Parameters

pdPage — 

The page whose contents are enumerated.

 
proc — 

The user-supplied callback procedure to be applied to each ink. Enumeration ends if any procedure returns false.

 
clientData — 

A pointer to user-supplied data to pass to proc each time it is called.

 
includeOPI — 

If true, enumerate inks contained in OPI dictionaries.

 
colorModel — 

CMYK_K, RGB_K, or Gray_K.

See Also

PDPageMakeSeparations
AVPageViewGetNumVisibleInks
AVPageViewGetVisibleInks
AVPageViewGetPixelInformationAtPoint
AVPageViewSetInkPreview
AVPageViewSetVisibleInks

Since

PI_PDMODEL_VERSION >= 0x00060000

File: PDProcs.h
Line: 11171
PDPageEnumOCGs() 
Product availability: All
Platform availability: All

Syntax

void PDPageEnumOCGs(PDPage pdPage, PDOCGEnumProc enumProc, void* clientData)

Enumerates the optional-content groups for the page, calling the supplied procedure for each one. Enumeration continues until all groups have been enumerated, or until enumProc returns false. Each group is reported once, even if it is referenced multiple times in the page.

Parameters

pdPage — 

The page whose groups are enumerated.

 
enumProc — 

A user-supplied callback to call for each group. Enumeration terminates if proc returns false.

 
clientData — 

A pointer to user-supplied data to pass to enumProc each time it is called.

See Also

PDDocEnumOCGs
PDPageGetOCGs

Since

PI_PDMODEL_VERSION >= 0x00060000

File: PDProcs.h
Line: 9045
PDPageEnumResources() 
Product availability: All
Platform availability: All

Syntax

void PDPageEnumResources(PDPage page, PDResourceEnumMonitor mon, void* clientData)

(Obsolete, provided only for backwards compatibility) Enumerates the page's resources, calling an enumeration procedure for each resource.

Instead of this method, use PDDocEnumOCGs().

Parameters

page — 

The page whose Cos resources are enumerated.
 
mon — 

A pointer to a structure containing user-supplied callbacks that are called for each of the page's resources. Enumeration ends if any procedure returns false.

 
clientData — 

A pointer to user-supplied data to pass to each procedure in mon when it is called.

See Also

PDDocEnumOCGs
PDPageGetCosResources

Since

PI_PDMODEL_VERSION >= 0x00020000

File: PDProcs.h
Line: 3527
PDPageFlattenOC() 
Product availability: All
Platform availability: All

Syntax

ASBool PDPageFlattenOC(PDPage pdPage, PDOCContext context)

Replaces the page's contents with a version that has no optional content, containing only what was visible on the page when the call was made.

Parameters

pdPage — 

The page to be modified.

 
context — 

The optional-content context in which content is checked for visibility.

Returns

true if the operation is successful, false otherwise.

See Also

PDDocFlattenOC
PDEContentFlattenOC

Since

PI_PDMODEL_VERSION >= 0x00060000

File: PDProcs.h
Line: 10341
PDPageGetAnnot() 
Product availability: All
Platform availability: All

Syntax

PDAnnot PDPageGetAnnot(PDPage aPage, ASInt32 annotIndex)

Gets the annotIndex annotation on the page.

Parameters

aPage — 

IN/OUT The page on which the annotation is located.
 
annotIndex — 

IN/OUT The index of the annotation to get on a page. The first annotation on a page has an index of zero.

Returns

The indexed annotation object.

See Also

PDPageGetNumAnnots

Since

PI_PDMODEL_VERSION >= 0x00020000

File: PDProcs.h
Line: 3273
PDPageGetAnnotIndex() 
Product availability: All
Platform availability: All

Syntax

ASInt32 PDPageGetAnnotIndex(PDPage aPage, PDAnnot anAnnot)

Gets the index of a given annotation object on a given page.

Parameters

aPage — 

IN/OUT The page to which the annotation is attached.
 
anAnnot — 

IN/OUT The annotation whose index is obtained.

Returns

The annotation's index. It returns -1 if the annotation is not on the page.

See Also

PDPageGetAnnot
PDPageGetAnnotSequence

Since

PI_PDMODEL_VERSION >= 0x00020000

File: PDProcs.h
Line: 3390
PDPageGetAnnotSequence() 
Product availability: Acrobat, PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

ASInt32 PDPageGetAnnotSequence(PDPage page, PDAnnot annot)

Returns the sequence number of the specified annotation for the given page. It is applicable only to annotations that are listed in Acrobat's Comments pane and therefore cannot be summarized using Summarize command (as would be the case for link and widget annotations, for example).

This method is similar to PDPageGetAnnotIndex() but it checks the information flags from the annotation handler's PDAnnotHandlerGetAnnotInfoFlagsProc() to determine whether the PDAnnotOperationSummarize flag is set, meaning that the annotation has a sequence number.

Parameters

page — 

The page on which the annotation exists.

 
annot — 

The annotation for which the sequence number is desired.

Returns

The sequence number of the specified annotation; or -1 if the annotation is not in the page or if it is an annotation that cannot be summarized.

See Also

PDPageGetAnnot
PDPageGetAnnotIndex

Since

PI_PDMODEL_VERSION >= 0x00040000

File: PDProcs.h
Line: 6719
PDPageGetBBox() 
Product availability: All
Platform availability: All

Syntax

void PDPageGetBBox(PDPage page, ASFixedRect* bboxP)

Gets the bounding box for a page. The bounding box is the rectangle that encloses all text, graphics, and images on the page.

Parameters

page — 

The page whose bounding box is obtained.

 
bboxP — 

(Filled by the method) A pointer to a rectangle specifying the page's bounding box, specified in user space coordinates.

See Also

PDPageGetMediaBox
PDPageGetCropBox
PDPageGetVisibleBBox

Since

PI_PDMODEL_VERSION >= 0x00020000

File: PDProcs.h
Line: 3179
PDPageGetBox() 
Product availability: All
Platform availability: All

Syntax

ASBool PDPageGetBox(PDPage page, ASAtom boxName, ASFixedRect* box)

Returns the box specified for the page object intersected with the media box. If the value for boxName is CropBox, this call is equivalent to PDPageGetCropBox(); if the value is MediaBox, this call is equivalent to PDPageGetMediaBox().

Parameters

page — 

The page whose box is obtained.

 
boxName — 

An ASAtom representing the type of box. It can have values such as ArtBox, BleedBox, CropBox, TrimBox, or MediaBox.
 
box — 

(Filled by the method) An ASFixedRect specifying the page's box.

Returns

true if the requested box was specified for the page, false otherwise.

See Also

PDPageSetBox

Since

PI_PDMODEL_VERSION >= 0x00050000

File: PDProcs.h
Line: 7750
PDPageGetCosObj() 
Product availability: All
Platform availability: All

Syntax

CosObj PDPageGetCosObj(PDPage page)

Gets the dictionary Cos object associated with a page. This method does not copy the object, but is instead the logical equivalent of a type cast.

Parameters

page — 

IN/OUT The page whose Cos object is obtained.

Returns

The dictionary Cos object associated with page.

Since

PI_PDMODEL_VERSION >= 0x00020000

File: PDProcs.h
Line: 3063
PDPageGetCosResources() 
Product availability: All
Platform availability: All

Syntax

CosObj PDPageGetCosResources(PDPage page)

Gets the Cos object corresponding to a page's resource dictionary. A page's resource Cos object may either be directly in the Page Cos object and apply only to the page. Or, it may be in the Pages tree, be shared by multiple pages, and applies to all Page nodes below the point in the Pages tree where it is located.

Parameters

page — 

IN/OUT The page whose Cos resources are obtained.

Returns

The dictionary Cos object associated with the page's resource.

See Also

PDPageAddCosResource

Since

PI_PDMODEL_VERSION >= 0x00020000

File: PDProcs.h
Line: 3421
PDPageGetCropBox() 
Product availability: All
Platform availability: All

Syntax

void PDPageGetCropBox(PDPage page, ASFixedRect* cropBoxP)

Gets the crop box for a page. The crop box is the region of the page to display and print.

Parameters

page — 

The page whose crop box is obtained.

 
cropBoxP — 

(Filled by the method) A pointer to a rectangle specifying the page's crop box, specified in user space coordinates.

See Also

PDPageSetCropBox
PDPageGetMediaBox
PDPageGetBBox

Since

PI_PDMODEL_VERSION >= 0x00020000

File: PDProcs.h
Line: 3148
PDPageGetDefaultMatrix() 
Product availability: All
Platform availability: All

Syntax

void PDPageGetDefaultMatrix(PDPage pdPage, ASFixedMatrix* defaultMatrix)

Gets the matrix that transforms user space coordinates to rotated and cropped coordinates. The origin of this space is the bottom-left of the rotated, cropped page. Y is increasing.

Parameters

pdPage — 

The page whose default transformation matrix is obtained.

 
defaultMatrix — 

(Filled by the method) A pointer to the default transformation matrix.

See Also

PDPageGetFlippedMatrix

Since

PI_PDMODEL_VERSION >= 0x00020000

File: PDProcs.h
Line: 3194
PDPageGetDoc() 
Product availability: All
Platform availability: All

Syntax

PDDoc PDPageGetDoc(PDPage page)

Gets the document that contains the specified page.

Parameters

page — 

IN/OUT The page whose document is obtained.

Returns

The document that contains the page.

See Also

PDDocAcquirePage

Since

PI_PDMODEL_VERSION >= 0x00020000

File: PDProcs.h
Line: 3052
PDPageGetDuration() 
Product availability: All
Platform availability: All

Syntax

ASFixed PDPageGetDuration(PDPage pdp)

Gets the page's automatic-advance timing value, which is the maximum amount of time the page is displayed before the viewer automatically advances to the next page.

Parameters

pdp — 

The page whose timing value is obtained.

Returns

The automatic-advance timing for the page, in seconds. If the page does not have an advance timing value, fxDefaultPageDuration is returned (representing positive infinity, meaning that it never advances).

See Also

PDPageSetDuration

Since

PI_PDMODEL_VERSION >= 0x00020002

File: PDProcs.h
Line: 5801
PDPageGetFlippedMatrix() 
Product availability: All
Platform availability: All

Syntax

void PDPageGetFlippedMatrix(PDPage pdPage, ASFixedMatrix* flipped)

Gets the matrix that transforms user space coordinates to rotated and cropped coordinates. The origin of this space is the top-left of the rotated, cropped page. Y is decreasing.

Parameters

pdPage — 

The page whose flipped transformation matrix is obtained.

 
flipped — 

(Filled by the method) A pointer to the flipped transformation matrix.

See Also

PDPageGetDefaultMatrix

Since

PI_PDMODEL_VERSION >= 0x00020000

File: PDProcs.h
Line: 3209
PDPageGetMediaBox() 
Product availability: All
Platform availability: All

Syntax

void PDPageGetMediaBox(PDPage page, ASFixedRect* mediaBoxP)

Gets the media box for a page. The media box is the natural size of the page (for example, the dimensions of an A4 sheet of paper).

Parameters

page — 

IN/OUT The page whose media box is obtained.

 
mediaBoxP — 

IN/OUT (Filled by the method) A pointer to a rectangle specifying the page's media box, specified in user space coordinates.

See Also

PDPageSetMediaBox
PDPageGetCropBox
PDPageGetBBox

Since

PI_PDMODEL_VERSION >= 0x00020000

File: PDProcs.h
Line: 3117
PDPageGetNumAnnots() 
Product availability: All
Platform availability: All

Syntax

ASInt32 PDPageGetNumAnnots(PDPage aPage)

Gets the number of annotations on a page. Annotations associated with pop-up windows (such as strikeouts) are counted as two annotations. Widget annotations (form fields) are included in the count.

Parameters

aPage — 

The page for which the number of annotations is obtained.

Returns

The number of annotations on aPage.

See Also

PDPageGetAnnot

Since

PI_PDMODEL_VERSION >= 0x00020000

File: PDProcs.h
Line: 3403
PDPageGetNumber() 
Product availability: All
Platform availability: All

Syntax

ASInt32 PDPageGetNumber(PDPage page)

Gets the page number for the specified page.

Parameters

page — 

IN/OUT The page whose page number is obtained.

Returns

The page within the document. The first page is 0.

See Also

PDPageNumFromCosObj

Since

PI_PDMODEL_VERSION >= 0x00020000

File: PDProcs.h
Line: 3031
PDPageGetOCGs() 
Product availability: All
Platform availability: All

Syntax

PDOCG PDPageGetOCGs(PDPage pdPage)

Gets the optional-content groups for the document.

Parameters

pdPage — 

The page whose OCGs are obtained.

Returns

A NULL-terminated array of PDOCG objects. The client is responsible for freeing the array with ASfree().

See Also

PDDocGetOCGs
PDPageEnumOCGs

Since

PI_PDMODEL_VERSION >= 0x00060000

File: PDProcs.h
Line: 9077
PDPageGetPalette() 
Product availability: All
Platform availability: All

Syntax

ASBool PDPageGetPalette(PDPage page, void* displayContext, char* table)

Useful for obtaining the static, platform-specific palette; the bitmap must be already selected into the displayContext to get the palette. This API was exposed for the purpose of the ImageConversion plug-in. When that code uses PDPageDrawContentsToWindow() to get a bitmap from AGM, it needs the palette that AGM used in order to get the correct results. This API is not available on Mac 64.

Parameters

page — 

The page whose palette is obtained.

 
displayContext — 

The bitmap.

 
table — 

(Filled by the method) The palette.

Returns

true if the palette was returned, false otherwise.

Since

PI_PDMODEL_VERSION >= 0x00050000

File: PDProcs.h
Line: 8160
PDPageGetPrintMatrix() 
Product availability: All
Platform availability: All

Syntax

void PDPageGetPrintMatrix(PDPage page, ASFixedMatrix* matrix, void* clientData)

Sent when the PDF Library has calculated the PostScript Print Page matrix. The PostScript Print Page matrix provides the mapping from user space to PS output space. The matrix can be used to calculate the PostScript page bounding box.

Parameters

page — 

The PDPage that is being printed.

 
matrix — 

The Page matrix, which is passed to the client.

 
clientData — 

A pointer to a block of user-supplied data that was passed when the client registered for this notification using PDFLibraryRegisterNotification().


File: PIPokes.h
Line: 2704
PDPageGetRotate() 
Product availability: All
Platform availability: All

Syntax

PDRotate PDPageGetRotate(PDPage page)

Gets the rotation value for a page.

Parameters

page — 

IN/OUT The page whose rotation is obtained.

Returns

Rotation value for the given page. It must be one of the PDRotate values.

See Also

PDPageSetRotate

Since

PI_PDMODEL_VERSION >= 0x00020000

File: PDProcs.h
Line: 3088
PDPageGetTransition() 
Product availability: All
Platform availability: All

Syntax

PDTrans PDPageGetTransition(PDPage pdp)

Gets the transition for a given page.

Parameters

pdp — 

The page whose transition is obtained.

Returns

The page's transition. If the page has no transition, it returns a NULL transition.

See Also

PDPageSetTransition
PDTransNull

Since

PI_PDMODEL_VERSION >= 0x00020002

File: PDProcs.h
Line: 5776
PDPageGetUserUnitSize() 
Product availability: All
Platform availability: All

Syntax

float PDPageGetUserUnitSize(PDPage page)

Returns the UserUnit value for the page. If the key is not present in the page dictionary the default of 1.0 is returned.

Parameters

page — 

The page whose UserUnit value is being obtained.

Returns

The value of UserUnit from the page dictionary, or a default value of 1.0 if not present.


File: PDProcs.h
Line: 11104
PDPageGetVisibleBBox() 
Product availability: All
Platform availability: All

Syntax

void PDPageGetVisibleBBox(PDPage page, PDOCContext ocContext, ASBool includeAnnots, ASFixedRect* fr)

Gets the bounding box for a given page for those contents that are visible in the given optional-content context. The bounding box is the rectangle that encloses the visible text, graphics, and images on the page.

Parameters

page — 

The page whose visible-content bounding box is obtained.

 
ocContext — 

The context within which the contents are visible.

 
includeAnnots — 

When true, include annotations as content that must be visible to affect the bounding box. When false, annotations are not considered at all.

 
fr — 

(Filled by the method) A pointer to a rectangle specifying the page's visible content bounding box, specified in user space coordinates. The client must not pass NULL.

See Also

PDPageGetBBox

Since

PI_PDMODEL_VERSION >= 0x00060002

File: PDProcs.h
Line: 10596
PDPageHasOverprintExt() 
Product availability: All
Platform availability: All

Syntax

ASBool PDPageHasOverprintExt(PDPage pdPage)

Checks whether a page contains overprint (with qualifications).

Parameters

pdPage — 

The page to check.

Returns

true only if the page contains overprint.

Since

PI_PDMODEL_VERSION >= 0x00070000

File: PDProcs.h
Line: 11713
PDPageHasTransition() 
Product availability: All
Platform availability: All

Syntax

ASBool PDPageHasTransition(PDPage pdp)

Tests whether a page has a transition.

Parameters

pdp — 

The page to test.

Returns

true if the page has a transition, false otherwise.

Since

PI_PDMODEL_VERSION >= 0x00020002

File: PDProcs.h
Line: 5764
PDPageHasTransparency() 
Product availability: All
Platform availability: All

Syntax

ASBool PDPageHasTransparency(PDPage pdPage, ASBool includeAnnotAppearances)

Checks whether a page uses any transparency features.

Parameters

pdPage — 

The page to check.

 
includeAnnotAppearances — 

If true, annotation appearances are included in the check; if false annotation appearances will be ignored.

Returns

true only if the page uses any transparency features.

Since

PI_PDMODEL_VERSION >= 0x00050000

File: PDProcs.h
Line: 8039
PDPageMakeSeparations() 
Product availability: All
Platform availability: All

Syntax

void PDPageMakeSeparations(PDPage pdPage, PDHostSepsSpec spec)

Generates print color separations for a page.

This is the entry point for creating separations for a single page. The spec structure contains an array of PDHostSepsPlate pointers, (typically based on the page inks reported by PDPageEnumInks()), with settings such as what to do on each plate and the output stream for plates that are being produced. The client owns the memory for the array and all of the records in it, and is responsible for disposing of all allocated memory.

On completion, the marked flags in the wasColorSet field of the plates indicate whether each plate was marked, meaning that any marking operation happened, even if it was clipped away or knocked out later. The special All colorant in a Separation color space does not affect the marked flags.

For Adobe Reader and Acrobat Standard, this method does nothing.

Parameters

pdPage — 

The page.

 
spec — 

The separation specification structure containing parameters for the generation.

See Also

AVDocPrintSeparations
PDPageEnumInks
PDPageMakeSeparations

Since

PI_PDMODEL_VERSION >= 0x00060000

File: PDProcs.h
Line: 8232
PDPageNotifyContentsDidChange() 
Product availability: All
Platform availability: All

Syntax

void PDPageNotifyContentsDidChange(PDPage page)

Broadcasts a PDPageContentsDidChange() notification. If the Acrobat viewer is version 2.1 or later, also broadcasts a PDPageContentsDidChangeEx() notification with invalidateViews set to true.

You must use this method after using Cos methods to change a page's contents. Do not use this method if you use PDPageAddCosContents() or PDPageRemoveCosContents() to change a page's contents, because those methods automatically generate the appropriate notifications.

Use PDPageNotifyContentsDidChangeEx() instead of this method if you wish to suppress the Acrobat viewer's immediate redraw of the page.

Parameters

page — 

IN/OUT The page that changed.

See Also

PDPageAddCosContents
PDPageRemoveCosContents
PDPageNotifyContentsDidChangeEx

Notifications

PDPageContentsDidChange
PDPageContentsDidChangeEx (in version 2.1 and later)

Since

PI_PDMODEL_VERSION >= 0x00020000

File: PDProcs.h
Line: 3020
PDPageNotifyContentsDidChangeEx() 
Product availability: All
Platform availability: All

Syntax

void PDPageNotifyContentsDidChangeEx(PDPage page, ASBool invalidateViews)

Broadcasts a PDPageContentsDidChange() notification and a PDPageContentsDidChangeEx() notification. These notify the Acrobat viewer that a page's contents have been modified, and tells the Acrobat viewer whether to redraw the page immediately.

You must use this method after using Cos methods to change a page's contents. Do not use this method if you use PDPageAddCosContents() or PDPageRemoveCosContents() to change a page's contents, because those methods automatically generate the appropriate notifications.

If your plug-in must be compatible with version 2.0 of the Acrobat viewer, you must use PDPageNotifyContentsDidChange() instead.

Parameters

page — 

The page that changed.

 
invalidateViews — 

true if the Acrobat viewer redraws the page view, false otherwise. This allows plug-ins to make a sequence of modifications to a page's contents, without having the entire page flash after each modification. Passing true for invalidateViews is equivalent to calling PDPageNotifyContentsDidChange().

See Also

PDPageAddCosContents
PDPageRemoveCosContents
PDPageNotifyContentsDidChange

Notifications

PDPageContentsDidChange
PDPageContentsDidChangeEx

Since

PI_PDMODEL_VERSION >= 0x00020001

File: PDProcs.h
Line: 5341
PDPageNumFromCosObj() 
Product availability: All
Platform availability: All

Syntax

ASInt32 PDPageNumFromCosObj(CosObj pageObj)

Gets the page number of the page specified by a Cos object.

Parameters

pageObj — 

IN/OUT The dictionary Cos object for the page whose number is obtained.

Returns

The page within the document (the first page in a document is page number zero).

See Also

PDPageGetNumber

Since

PI_PDMODEL_VERSION >= 0x00020000

File: PDProcs.h
Line: 3076
PDPageRelease() 
Product availability: All
Platform availability: All

Syntax

void PDPageRelease(PDPage page)

Decrements the specified page's reference count.

Parameters

page — 

IN/OUT The page whose reference count is decremented.

See Also

PDBeadAcquirePage
PDDocAcquirePage

Since

PI_PDMODEL_VERSION >= 0x00020000

File: PDProcs.h
Line: 3042
PDPageRemoveAnnot() 
Product availability: Acrobat, PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

void PDPageRemoveAnnot(PDPage aPage, ASInt32 annotIndex)

Removes an annotation from the specified page. Annotations are stored in Cos arrays, which are automatically compressed when an annotation is removed (see CosArrayRemove()). For this reason, if you use a loop in which you remove annotations, structure the code so the loop processes from the highest to the lowest index. If you loop the other direction, you will skip over annotations immediately following ones you remove.

Parameters

aPage — 

The page from which the annotation is removed.
 
annotIndex — 

The index (into the page's annotation array) of the annotation to remove.

See Also

PDPageGetAnnotIndex
PDPageAddNewAnnot
PDPageAddAnnot

Exceptions

pdErrOpNotPermitted is raised if:

Notifications

PDPageWillRemoveAnnot
PDPageDidRemoveAnnot

Since

PI_PDMODEL_VERSION >= 0x00020000

File: PDProcs.h
Line: 3374
PDPageRemoveCosContents() 
Product availability: Acrobat, PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

void PDPageRemoveCosContents(PDPage page)

Removes the contents of the specified page.

Parameters

page — 

IN/OUT The page whose Cos contents are removed.

See Also

PDPageAddCosContents

Notifications

PDDocDidChangePages

Since

PI_PDMODEL_VERSION >= 0x00020000

File: PDProcs.h
Line: 3500
PDPageRemoveCosResource() 
Product availability: Acrobat, PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

void PDPageRemoveCosResource(PDPage page, const char* resType, const char* resName)

Removes a Cos resource from a page object. See Section 3.7.2 in the PDF Reference for a description of page resources.

Parameters

page — 

The page whose Cos resources are removed.
 
resType — 

The resource type. The named resource types in PDF are: ExtGState, ColorSpace, Pattern, Shading, XObject, Font, ProcSet, and Properties.

 
resName — 

The resource name (for example, the name of a font might be F1).

See Also

PDPageAddCosResource
PDPageGetCosResources

Notifications

PDDocDidChangePages

Since

PI_PDMODEL_VERSION >= 0x00020000

File: PDProcs.h
Line: 3490
PDPageSetBox() 
Product availability: Acrobat, PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

void PDPageSetBox(PDPage page, ASAtom boxName, ASFixedRect box)

Sets the box specified by boxName for the page.

This method may throw exceptions.

Parameters

page — 

IN/OUT The page for which the box is to be set.

 
boxName — 

IN/OUT An ASAtom representing the type of box. The box names are:

  • ArtBox

  • BleedBox

  • CropBox

  • TrimBox

  • MediaBox

 
box — 

IN/OUT An ASFixedRect specifying the coordinates to set for the box.

See Also

PDPageGetBox

Notifications

PDDocWillChangePages
PDDocDidChangePages

Since

PI_PDMODEL_VERSION >= 0x00050000

File: PDProcs.h
Line: 7776
PDPageSetCropBox() 
Product availability: Acrobat, PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

void PDPageSetCropBox(PDPage page, ASFixedRect cropBox)

Sets the crop box for a page. The crop box is the region of the page to display and print. This method ignores the request if either the width or height of cropBox is less than 72 points (one inch).

Parameters

page — 

The page whose crop box is set.

 
cropBox — 

A rectangle specifying the page's crop box, specified in user space coordinates.

See Also

PDPageGetCropBox
PDPageSetMediaBox

Notifications

PDDocWillChangePages
PDDocDidChangePages

Since

PI_PDMODEL_VERSION >= 0x00020000

File: PDProcs.h
Line: 3164
PDPageSetDuration() 
Product availability: Acrobat, PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

void PDPageSetDuration(PDPage pdp, ASFixed fxDuration)

Sets the page's automatic-advance timing value, which is the maximum amount of time the page is displayed before the viewer automatically advances to the next page.

Parameters

pdp — 

The page whose timing is set.

 
fxDuration — 

The auto-advance timing, in seconds. If no advance timing is desired, fxDuration should be set to fxDefaultPageDuration.

See Also

PDPageGetDuration

Since

PI_PDMODEL_VERSION >= 0x00020002

File: PDProcs.h
Line: 5815
PDPageSetMediaBox() 
Product availability: Acrobat, PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

void PDPageSetMediaBox(PDPage page, ASFixedRect mediaBox)

Sets the media box for a page. The media box is the natural size of the page, for example, the dimensions of an A4 sheet of paper.

Parameters

page — 

IN/OUT The page whose media box is set.

 
mediaBox — 

IN/OUT Rectangle specifying the page's media box, specified in user space coordinates.

See Also

PDPageGetMediaBox
PDPageSetCropBox
PDPageGetBBox

Notifications

PDDocWillChangePages
PDDocDidChangePages

Since

PI_PDMODEL_VERSION >= 0x00020000

File: PDProcs.h
Line: 3134
PDPageSetRotate() 
Product availability: Acrobat, PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

void PDPageSetRotate(PDPage page, PDRotate angle)

Sets the rotation value for a page.

Parameters

page — 

The page whose rotation is set.

 
angle — 

Rotation value to be set for a given page. It must be one of the PDRotate values.

See Also

PDPageGetRotate

Notifications

PDDocWillChangePages
PDDocDidChangePages

Since

PI_PDMODEL_VERSION >= 0x00020000

File: PDProcs.h
Line: 3101
PDPageSetTransition() 
Product availability: Acrobat, PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

void PDPageSetTransition(PDPage pdp, PDTrans pdt)

Sets the transition for a given page.

Parameters

pdp — 

The page whose transition is set.

 
pdt — 

The transition for the page.

See Also

PDPageGetTransition
PDTransNull

Since

PI_PDMODEL_VERSION >= 0x00020002

File: PDProcs.h
Line: 5787
PDPageSetUserUnitSize() 
Product availability: All
Platform availability: All

Syntax

void PDPageSetUserUnitSize(PDPage page, float unitSize)

Set the UserUnit value for a page.

Parameters

page — 

The page whose UserUnit value is being set.

 
unitSize — 

UserUnit value to be set for the page dictionary. The default value is 1.0.

Exceptions

genErrBadParm is raised if unitSize <= 0.0 .

File: PDProcs.h
Line: 11112
PDPageStmGetInlineImage() 
Product availability: All
Platform availability: All

Syntax

ASUns32 PDPageStmGetInlineImage(ASStm stm, ASUns32 flags, CosDoc cosDoc, CosObj resDict, PDPageStmImageDataProc proc, void* procClientData, ASUns32* imageRawDataStmOffsetP, ASUns32* imageRawDataLenP, CosObj* imageDict)

Reads a PDF page content inline image from a stream. The stream is typically obtained by getting the Cos stream for a page contents or a Form contents, and calling CosStreamOpenStm() to open the stream using the filtered mode. This method is called after a BI token has been read from the stream. BI indicates that the following tokens comprise an inline image dictionary and data.

It begins reading at the current stream position. It returns the number of bytes read. This is the number of bytes read from the stream and indicates the amount by which the stream position has advanced.

The image attributes dictionary is returned in imageDict. The image data is passed to the PDPageStmImageDataProc(); if proc is not provided, the image data is discarded.

imageRawDataStmOffsetP and imageRawDataLenP may be NULL, in which case they are ignored.

The caller should call CosObjDestroy() on imageDict when it is done.

This method can raise memory, I/O, and parsing exceptions.

Parameters

stm — 

The stream from which data is read.

 
flags — 

The CosDoc with the PDPage that contains the inline image.

 
cosDoc — 

The Resources dictionary in which to look up ColorSpace resources for inline images.

 
resDict — 

Currently unused by this method (used by PDPageStmGetToken().)

 
proc — 

A callback method to handle inline image data.
 
procClientData — 

Client data passed to proc.

 
imageRawDataStmOffsetP — 

(Filled by the method) The offset of the data stream, after BI, relative to the beginning of stm.

 
imageRawDataLenP — 

(Filled by the method) The offset of the last byte of the data stream between the BI and EI PDF operators.

 
imageDict — 

(Filled by the method) The returned image dictionary.

Returns

The number of bytes read from stm.

See Also

CosStreamOpenStm
PDPageGetBox
PDPageStmGetToken

Since

PI_PDMODEL_VERSION >= 0x00020002

File: PDProcs.h
Line: 5653
PDPageStmGetToken() 
Product availability: All
Platform availability: All

Syntax

ASUns32 PDPageStmGetToken(ASStm stm, ASUns32 flags, PDPageStmStringOverflowProc proc, void* procClientData, PDPageStmToken pageStmToken)

Reads a PDF page content token from a stream. The stream is typically obtained by getting the Cos stream for a page contents or a Form contents, and calling CosStreamOpenStm() to open the stream using the filtered mode.

It begins reading at the current stream position, and reads exactly one token. It returns the number of bytes read. This is the number of bytes read from the stream and indicates the amount by which the stream position has advanced. The end-of-stream criteria (loop terminating condition) is the following:

If the token is an integer, real (ASFixed), or ASBool, then the value is returned in pageStmToken.iVal. If the token is a string or a name, the value is returned in pageStmToken.sVal, and the length of the token is in pageStmToken.sValLen. Strings are not NULL-terminated, but names are NULL-terminated. If a string length is greater than kPDPageStmStringMax, the PDPageStmStringOverflowProc() is called repeatedly with portions of the string. On return from PDPageStmGetToken, the value of pageStmToken.sValLen is zero, and pageStmToken.sVal is empty (ival, sVal, and sValLen are components of the PDPageStmToken). If there is no overflow proc, then the first kPDPageStmStringMax bytes of the string will be returned in pageStmToken.sVal, and the remaining bytes are lost. The value of pageStmToken.sValLen is kPDPageStmStringMax in this case.

If the token is BI (begin inline image), PDPageStmGetInlineImage() should be called to parse the inline image.

This method can raise memory, I/O, and parsing exceptions.

Parameters

stm — 

The stream from which data is read.

 
flags — 

A bit field of options such as 'skip comments' (kPDPageStmSkipComments means skip comments during token generation).

 
proc — 

A callback method to handle long strings.

 
procClientData — 

Client data passed to the callback method.

 
pageStmToken — 

The returned token.

Returns

The number of bytes read from stm.

See Also

CosStreamOpenStm
PDPageGetCosObj
PDPageStmGetInlineImage

Since

PI_PDMODEL_VERSION >= 0x00020002

File: PDProcs.h
Line: 5593
PDPageWillAddAnnot() 
Product availability: All
Platform availability: All

Syntax

void PDPageWillAddAnnot(PDPage page, ASInt32 addAfter, PDAnnot annot, void* clientData)

An annotation will be added to a page.

Parameters

page — 

The page to which the annotation will be added.
 
addAfter — 

The index in the page's annotation array after which the annotation will be added.

 
annot — 

The annotation that will be added.

 
clientData — 

A pointer to a block of user-supplied data that was passed when the client registered for this notification using AVAppRegisterNotification() .

See Also

PDPageAddAnnot
PDPageAddNewAnnot

Notifications

PDPageDidAddAnnot

File: PIPokes.h
Line: 869
PDPageWillPrintAnnot() 
Product availability: All
Platform availability: All

Syntax

void PDPageWillPrintAnnot(PDAnnot annot, ASInt32 page, void* clientData)

Clients who register for this notification will be notified just before an annotation is expected to print. This notification allows clients that manage annotations to prepare the appearance of the annotation for printing purposes. There is no requirement that the annot referred to in this parameter list actually has a print appearance.

Parameters

annot — 

The annotation to print.

 
page — 

The page on which the annotation occurs.

 
clientData — 

A pointer to a block of user-supplied data that was passed when the client registered for this notification using AVAppRegisterNotification() .

Notifications

PDPageDidPrintAnnot
PDPageDidPrintAnnots
PDPageWillPrintAnnot

File: PIPokes.h
Line: 2102
PDPageWillPrintAnnots() 
Product availability: All
Platform availability: All

Syntax

void PDPageWillPrintAnnots(PDDoc doc, ASInt32 page, ASStm stm, void* clientData)

Clients who register for PDPageWillPrintAnnots() will be called before the printed representations of any annotations have been emitted. If a page has no annotations, this will not be called. If a page has annotations, this will be called. There may not be any code emitted for the annotations on that page, however, since they may not have any appearance for printing. The status parameter passed in the PDPageDidPrintAnnot() will indicate this.

Parameters

doc — 

The document containing the annotations.

 
page — 

The page to be printed.

 
stm — 

The PostScript print stream used when printing to a PostScript printer, and NULL when printing to a non-PostScript printer. When printing to a PostScript printer, clients can write printing commands into stm (using ASStmWrite() ) to add marks to pages before any other marks have been made.
 
clientData — 

A pointer to a block of user-supplied data that was passed when the client registered for this notification using AVAppRegisterNotification() .

See Also

Numerous

Notifications

PDPageDidPrintAnnot
PDPageDidPrintAnnots
PDPageWillPrintAnnot

File: PIPokes.h
Line: 1943
PDPageWillRemoveAnnot() 
Product availability: All
Platform availability: All

Syntax

void PDPageWillRemoveAnnot(PDPage page, ASInt32 annotIndex, void* clientData)

An annotation will be removed from a page.

Parameters

page — 

The page from which an annotation will be removed.

 
annotIndex — 

The index (in the page's annotation array) of the annotation that will be removed. Use PDPageGetAnnot() to obtain the annotation from its index.

 
clientData — 

A pointer to a block of user-supplied data that was passed when the client registered for this notification using AVAppRegisterNotification() .

See Also

PDPageRemoveAnnot

Notifications

PDPageDidRemoveAnnot

File: PIPokes.h
Line: 901



© 2004-2013 Adobe Systems Incorporated. All rights reserved.
Thu Jan 21 2016, 11:19 AM IST