An enumerated data type that specifies whether thumbnail images or bookmarks are shown.

Value options for PDPageMode.

Specifies page rotation, in degrees. It is used for routines that set or get the value of a page's Rotate key.

Value options for PDRotate.

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.

A label used to describe a page. This is used to allow for non-sequential page numbering or the addition of arbitrary labels for a page (such as the inclusion of Roman numerals at the beginning of a book). A PDPageLabel specifies the numbering style to use (for example, upper-case or lower-case Roman, decimal, and so on), the starting number for the first page, and an arbitrary prefix to be preappended to each number (for example, "A-" is used to generate "A-1", "A-2", "A-3", and so on).

Represents an ink used on a page.

Creates a PDEContent from the PDPage object's contents and resources. The PDEContent is cached, so that subsequent calls on the same PDPage return the same PDEContent, even if the request is from another PDFEdit client. The PDEContent remains in the cache as long as someone has it acquired- until someone not using the PDFEdit API changes the PDPage object's contents, such as the viewer rotating a page 90 degrees. Requires ‘Export’ permission on PDDoc.

Do not call PDERelease() on PDEContent you have acquired with PDPageAcquirePDEContent(); call PDPageReleasePDEContent() to release it.

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.

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

Completely replaces the contents of the specified page with newContents.

Adds a Cos resource to a page object. See the description of Resource Dictionaries in ISO 32000-1:2008, Document Management- Portable Document Format-Part 1: PDF 1.7, section 7.8.3, page 82.

You can find this document on the web store of the International Standards Organization (ISO).

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:

• Get the page's Resources dictionary.
  
• Get the ProcSet array from the Resources dictionary.
  
• Add an element to the ProcSet array.
  

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().

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.

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.

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.

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.

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.

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.

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.

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.

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.

Gets the annotIndex annotation on the page.

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

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.

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

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().

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.

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

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.

Gets the document that contains the specified page.

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.

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.

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).

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.

Gets the page number for the specified page.

Gets the optional-content groups for the document.

Gets filters used by PDPageSetPDEContent().

The caller is responsible for allocating the filter array filters that receives the filters. filters can be NULL to just obtain the number of filters.

Gets flags used by PDPageSetPDEContent().

Gets the rotation value for a page.

Gets the transition for a given page.

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.

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, this method does nothing.

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.

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.

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

Indicates a page's PDEContent has changed.

Call this after you alter a PDPage object's PDEContent but do not call PDPageSetPDEContent(), so others who have acquired the PDEContent know it has changed.

Registers for the PagePDEContentDidChange() notification.

Register for the PagePDEContentNotCached() notification.

This notification is also sent when others change (or delete) a PDPage object's contents without using PDFEdit methods. For instance, rotating or deleting a page in the viewer results in this notification being sent.

PDFEdit registers for almost a half dozen different notifications for the different ways Acrobat can alter page contents; you may need only this notification.

Decrements the specified page's reference count.

Decrements a PDPage object's PDEContent internal reference count.

The PDEContent is not automatically deleted when the reference count becomes zero: it remains in the cache until the cache slot is needed for another PDPage. Thus, you do not need to keep a PDEContent acquired for performance reasons. There is a notification for which you can register that is sent when a PDEContent is actually removed from the cache, thus enabling the use of PDFEdit object's tagging methods PDEAddTag(), PDEGetTag(), and PDERemoveTag() on the PDEContent object.

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.

Removes the contents of the specified page.

Removes a Cos resource from a page object. See the description of Resource Dictionaries in ISO 32000-1:2008, Document Management- Portable Document Format-Part 1: PDF 1.7, section 7.8.3, page 82.

Resumes destruction of PDEContent objects when a PDPageContentsDidChange() notification occurs. Only use this API if you called PDPageSuspendPDEContentChanged().

Sets the box specified by boxName for the page.

This method may throw exceptions.

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).

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.

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.

Sets the page's PDEContent back into the PDPage object's Cos object, using the same compression filters with which the content was previously encoded.

In order to properly synchronize the page's contents after setting them with PDPageSetPDEContent(), you must call PDPageNotifyContentsDidChange(). If you do not call PDPageNotifyContentsDidChange(), the page displayed will use the old page contents.

Sets the page's PDEContent back into the PDPage object's Cos object, using the same compression filters with which the content was previously encoded. This method calls PDPageNotifyContentsDidChangeEx().

This method differs from PDPageSetPDEContent() in that it returns no value, but does raise an exception if it is unable to set the content.

Sets the filters used by PDPageSetPDEContent(). The filters are not instantiated until PDPageSetPDEContent() is called.

Sets flags used by PDPageSetPDEContent(). The flags are not instantiated until PDPageSetPDEContent() is called.

Sets the rotation value for a page.

Sets the transition for a given page.

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.

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:

• A NULL object is returned (an object of type CosNull).
  
• The number of bytes read (return value) is 1.
  

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.

Suspends destruction of PDEContent objects when a PagePDEContentDidChange() notification occurs. Only use this API if you are about to call PDPageNotifyContentsDidChange() and you do not want PDFEdit to destroy all PDEContent objects associated with that PDPage. This is used, for example, when AVAppSetPreference() is called. Make sure to call PDPageSuspendPDEContentChanged() on the PDPage object after you call PDPageNotifyContentsDidChange().

Un-registers for the PagePDEContentDidChange() notification.

Un-registers for the PagePDEContentNotCached() notification.