PTPDFView

PDFView constructor and destructor. Create PDFView without associating it to any document.

Associates this PDFView with a given PDF document.

Associates this PDFView with a given PDF document.

Associates this PDFView with a given document conversion. The conversion will be performed page-by-page, asynchronously. The pdview object will be updated to display the conversion result

Associates this PDFView with a given document conversion. The conversion will be performed page-by-page, asynchronously. The pdview object will be updated to display the conversion result

Close the associated PDF document.

Close the associated PDF document.

Acquires a write lock on the currently open document, optionally canceling all threads accessing the document.

Acquires a write lock on the currently open document, optionally canceling all threads accessing the document.

Releases the write lock from the currently open document.

Releases the write lock from the currently open document.

Try acquiring a write lock on the currently open document, waiting no longer than specified number of milliseconds.

Try acquiring a write lock on the currently open document, waiting no longer than specified number of milliseconds.

Locks the currently open document to prevent competing write threads (using Lock()) from accessing the document at the same time. Other reader threads however, will be allowed to access the document. Threads attempting to obtain write access to the document will wait in suspended state until the thread that owns the lock calls doc.UnlockRead(). Note: To avoid deadlocks obtaining a write lock while holding a read lock is not permitted and will throw an exception. If this situation is encountered please either unlock the read lock before the write lock is obtained or acquire a write lock (rather than read lock) in the first place.

Locks the currently open document to prevent competing write threads (using Lock()) from accessing the document at the same time. Other reader threads however, will be allowed to access the document. Threads attempting to obtain write access to the document will wait in suspended state until the thread that owns the lock calls doc.UnlockRead(). Note: To avoid deadlocks obtaining a write lock while holding a read lock is not permitted and will throw an exception. If this situation is encountered please either unlock the read lock before the write lock is obtained or acquire a write lock (rather than read lock) in the first place.

Releases the read lock from the currently open document.

Releases the read lock from the currently open document.

Try acquiring a read lock on the current document, waiting no longer than specified number of milliseconds.

Try acquiring a read lock on the current document, waiting no longer than specified number of milliseconds.

Sets the current page presentation mode.

Sets the current page presentation mode.

Set the color post processing transformation. This transform is applied to the rasterized bitmap as the final step in the rasterization process, and is applied directly to the resulting bitmap (disregarding any color space information). Color post processing only supported for RGBA output.

Set the color post processing transformation. This transform is applied to the rasterized bitmap as the final step in the rasterization process, and is applied directly to the resulting bitmap (disregarding any color space information). Color post processing only supported for RGBA output.

Sets the color post processing transformation. This transform is applied to the rasterized bitmap as the final step in the rasterization process, and is applied directly to the resulting bitmap (disregarding any color space information). Color post processing only supported for RGBA output.

This mode will map the brightness of the original rasterized bitmap to a gradient in image_file_contents from left to right.

Sets the color post processing transformation. This transform is applied to the rasterized bitmap as the final step in the rasterization process, and is applied directly to the resulting bitmap (disregarding any color space information). Color post processing only supported for RGBA output.

This mode will map the brightness of the original rasterized bitmap to a gradient in image_file_contents from left to right.

Converts a color based on the view’s color post processing transformation.

Converts a color based on the view’s color post processing transformation.

Sets the color post processing transformation. This transform is applied to the rasterized bitmap as the final step in the rasterization process, and is applied directly to the resulting bitmap (disregarding any color space information). Color post processing only supported for RGBA output. This mode will map the brightness of the original rasterized bitmap to a gradient between whiteColor and blackColor

Sets the color post processing transformation. This transform is applied to the rasterized bitmap as the final step in the rasterization process, and is applied directly to the resulting bitmap (disregarding any color space information). Color post processing only supported for RGBA output. This mode will map the brightness of the original rasterized bitmap to a gradient between whiteColor and blackColor

Sets the current page to the first page in the document.

Sets the current page to the first page in the document.

Sets the current page to the last page in the document.

Sets the current page to the last page in the document.

Sets the current page to the next page in the document.

Sets the current page to the next page in the document.

Sets the current page to the previous page in the document.

Sets the current page to the previous page in the document.

Sets the current page to the given page.

Sets the current page to the given page.

Changes the viewing area to fit a rectangle rect on page page_num. Rectangle must be specified in page coordinates. This will adjust current page and zoom appropriately.

Changes the viewing area to fit a rectangle rect on page page_num. Rectangle must be specified in page coordinates. This will adjust current page and zoom appropriately.

Get a vector with the pages currently visible on the screen.

Get a vector with the pages currently visible on the screen.

Returns the current zoom factor.

Returns the current zoom factor.

Sets the zoom factor to a new value. The function zooms to a point at the center of the rendering buffer.

Sets the zoom factor to a new value. The function zooms to a point at the center of the rendering buffer.

Sets the zoom factor to a new value using the given pixel coordinate (x,y) as a zoom center, which will stay fixed on the screen.

The zoom point (x,y) is represented in the screen space, which starts in the upper-left corner of the client window.

Should you want to move (x, y) to the center of the client window, you can use the OnScroll() subsequently:

    int x, y;
    double zoom;
    ...
    view.SetZoom(x, y, zoom);
    int width = view.GetBufferWidth();
    int height = view.GetBufferHeight();
    int dx = (int)(x - (double)width/2 + 0.5);
    int dy = (int)(y - (double)height/2 + 0.5);
    view.OnScroll(dx, dy);

Sets the zoom factor to a new value using the given pixel coordinate (x,y) as a zoom center, which will stay fixed on the screen.

The zoom point (x,y) is represented in the screen space, which starts in the upper-left corner of the client window.

Should you want to move (x, y) to the center of the client window, you can use the OnScroll() subsequently:

    int x, y;
    double zoom;
    ...
    view.SetZoom(x, y, zoom);
    int width = view.GetBufferWidth();
    int height = view.GetBufferHeight();
    int dx = (int)(x - (double)width/2 + 0.5);
    int dy = (int)(y - (double)height/2 + 0.5);
    view.OnScroll(dx, dy);

Sets the zoom factor to a new value using the given pixel coordinate (x,y) to find an intersecting paragraph. The width of the paragraph helps to determine the zoom value, center of the paragraph is used as a zoom center. Paragraph has to contain more than one line and be wider than 1/5th of a page width. When called on a paragraph wider than current zoom level the new zoom level is set to fit the entire page(zoom out).

The zoom point (x,y) is represented in the screen space, which starts in the upper-left corner of the client window.

Sets the zoom factor to a new value using the given pixel coordinate (x,y) to find an intersecting paragraph. The width of the paragraph helps to determine the zoom value, center of the paragraph is used as a zoom center. Paragraph has to contain more than one line and be wider than 1/5th of a page width. When called on a paragraph wider than current zoom level the new zoom level is set to fit the entire page(zoom out).

The zoom point (x,y) is represented in the screen space, which starts in the upper-left corner of the client window.

Rotates all pages in the document 90 degrees clockwise.

Rotates all pages in the document 90 degrees clockwise.

Rotates all pages in the document 90 degrees counter-clockwise.

Rotates all pages in the document 90 degrees counter-clockwise.

Converts a point expressed in screen space to a point in canvas space.

Converts a point expressed in screen space to a point in canvas space.

Converts a point expressed in canvas space to a point in screen space.

Converts a point expressed in canvas space to a point in screen space.

Converts a point expressed in canvas space to a point in a page space.

Converts a point expressed in canvas space to a point in a page space.

Converts a point from a page space to point in canvas space.

Converts a point from a page space to point in canvas space.

Converts a point expressed in screen space to a point in a page space.

Converts a point expressed in screen space to a point in a page space.

Converts a point in a page space to a point in the screen space. If PDFView is in a non-continous page view mode, and the page is not visible, the result is undefined.

Converts a point in a page space to a point in the screen space. If PDFView is in a non-continous page view mode, and the page is not visible, the result is undefined.

Snaps an xy coordinate pair (in screen space) to the nearest piece of document geometry.

Snaps an xy coordinate pair (in screen space) to the nearest piece of document geometry.

Set the point snapping mode for the SnapToNearestInDoc method. By default SnapToNearestInDoc will snap to line endpoints, midpoints, and intersections.

Set the point snapping mode for the SnapToNearestInDoc method. By default SnapToNearestInDoc will snap to line endpoints, midpoints, and intersections.

• - returns: the device transformation matrix. The device transformation
• matrix maps the page coordinate system to screen (or device) coordinate
• system. *
• - parameter: page_num same as for PDFView.Conv???() methods. *
• - note: to obtain a transformation matrix that maps screen
• coordinates to page coordinates, you can invert the device matrix.
• For example:
• “`
• Common::Matrix2D scr2page(pdfview.GetDeviceTransform());
• scr2page.Inverse(); * ”`

Sets the error handling function to be called in case an error is encountered during page rendering.

Sets the callback function (i.e. a delegate) that is called whenever current page number changes. This can be used to update the current page number within GUI applications etc.

Sets the callback function (i.e. a delegate) for JavaScript action. Can be used to handle alert event which pops up a window with alert message.

Sets the callback function (i.e. a delegate) that is called whenever current zoom (magnification) changes. This can be used to update the current zoom number within GUI applications etc.

Requests action object to be executed by PDFViewCtrl. Action must belong to the document currently displayed in PDFViewCtrl.

Undocumented

Returns the width of the scrollable space.

Returns the height of the scrollable space.

Scrolls the contents of the rendering buffer ‘pix_dx’ horizontally and ‘pix_dy’ vertically.

Sets the horizontal scroll position in scrollable space.

Sets the vertical scroll position in scrollable space.

Should you want to center to a location (px, py) expressed in a page space, you can use the following code:

    //focus
    view.SetCurrentPage(page_num);
    view.ConvPagePtToScreenPt(px, py, page_num);
    view.SetZoom((int)px, (int)py, view.GetZoom());

    //center
    int width = view.GetBufferWidth();
    int height = view.GetBufferHeight();
    int dx = (int)(px - (double)width/2 + 0.5);
    int dy = (int)(py - (double)height/2 + 0.5);
    view.OnScroll(dx, dy);

Resize rendering buffer to new dimensions.

Cancels rendering in progress. If PDFView is not busy rendering the page, the function has no side effects.

Redraws the contents of the buffer.

Redraws the given area in the buffer.

Redraws the area covered with a given annotation.

Redraws all instances (Widgets) of the field.

Updates the page layout within the view. This function must be called after document page sequence is modified (such as when a page is being added to or removed from a document) or after changes to page dimensions (e.g. after a page is rotated or resized).

Returns the pointer to the internal memory buffer containing the rasterized image of the given page. The buffer size is at least ‘GetBufferHeight*GetBufferStride’ bytes. The pixel data is stored in 8 bit per component, BGRA format.

Update the internal memory buffer that can be returned by GetBuffer(). Since PDFView may not necessarily update the buffer until it finishes rendering the current viewing area, it is required to call UpdateBuffer() to force PDFView to write the current rasterized contents to the buffer. This is important for, say, calling GetBuffer() in a different thread to implement progressive rendering.

Returns the width of the rendering buffer in pixels.

Returns the width of the rendering buffer in pixels.

Returns the stride of the rendering buffer in pixels.

Disable rendering of a particular annotation. This does not change the annotation itself, just how it is displayed in this viewer instance.

Enable rendering of a particular annotation. Only has an effect if HideAnnotation() has previously been called on the same annot.

Enable or disable annotation and forms rendering. By default, all annotations and form fields are rendered.

Enables or disables URL extraction.

@default by default URL extraction is disabled

Gets the link info at a given point, specified in client space.

Set the highlight color for required fields

This option only has an effect if field highlighting is turned on using SetHighlightFields(true). Note that signature fields have their own highlight color, independent of this one (see setSignatureHighlightColor).

Enable or disable highlighting form fields. Default is disabled.

Set the border color for required fields

This option only has an effect if field highlighting is turned on using SetHighlightFields(true).

Set the highlight color for signature fields

This option only has an effect if field highlighting is turned on using SetHighlightFields(true). Note that non-signature fields have their own highlight color, independent of this one (see setFieldHighlightColor)

Enable or disable anti-aliasing.

Anti-Aliasing is a technique used to improve the visual quality of images when displaying them on low resolution devices (for example, low DPI computer monitors).

@default Anti-aliasing is enabled by default.

Enable or disable path hinting.

Set thin line adjustment parameters.

Enable or disable image smoothing.

The rasterizer allows a trade-off between rendering quality and rendering speed. This function can be used to indicate the preference between rendering speed and quality.

Enables of disables caching of images, fonts, and other resources. Disabling caching can lower memory requirements at the expense of rendering speed.

Sets the core graphics library used for rasterization and rendering. Using this method it is possible to quickly switch between different implementations. By default, PDFNet uses a built-in, high-quality, and platform independent rasterizer.

Sets the gamma factor used for anti-aliased rendering.

Gamma correction can be used to improve the quality of anti-aliased image output and can (to some extent) decrease the appearance common anti-aliasing artifacts (such as pixel width lines between polygons).

Enable or disable support for overprint and overprint simulation. Overprint is a device dependent feature and the results will vary depending on the output color space and supported colorants (i.e. CMYK, CMYK+spot, RGB, etc).

@default By default overprint is only enabled for PDF/X files.

Sets the Optional Content Group (OCG) context that should be used when viewing the document. This function can be used to change the current OCG context. Optional content (such as PDF layers) will be selectively rendered based on the states of optional content groups in the given context.

Prompts the PDFViewCtrl to update its list of optional content groups. Call this method if you modify the PDFDoc in a way that adds or removes a layer. For example, after using Stamper to create a stamp.

Set a callback function that can be used to notify the client that PDFView is about to start rendering and modifying the contents of the rendering buffer.

Set a callback function that can be used to notify the client that PDFView finished rendering and modifying the contents of the rendering buffer.

Sets the selection mode used for text highlighting.

Selects text within the given region using the current text selection mode.

Selects text within the given region using the current text selection mode with defined snap-to-start and snap-to-end modes.

Selects text within the given region using the current text selection mode with smart snap-to-start and snap-to-end modes.

Selects texts using structural mode.

Selects texts identified by Highlights.

Selects a region according to a Selection object

Cancel the text search thread if FindText() is started in a different thread. Note that if the text search thread is currently being suspended by the render thread, it will only be canceled after it is awaken by the render thread.

Selects all text on the page.

Remove any text selection.

Requests for preparing words of the given page. Note: Words are going to be prepared asynchronously

Requests for preparing annotations of the given page. Note: Annotations are going to be prepared asynchronously

Enables or disables drawing of a thin border around each page.

Enables or disables the transparency grid (check board pattern) to reflect page transparency.

Sets the default ‘paper’ color used to draw background of each page.

Sets the default background color used to paint the area surrounding each page.

Sets the horizontal alignment used for rendering pages within the view.

Sets the vertical alignment used for rendering pages within the view.

Sets the vertical and horizontal padding and column spacing between adjacent pages in the view.

Sets the cache parameters of the page cache on disk (which caches content streams and
mipmapped images) for this specific document. These parameters will override the default cache

parameters. Note that if this function is called after the document has been rasterized, it has no effect.

Set device pixel density

Gets the annotation bounding box in screen points

Gets the annotation at the (x, y) position expressed in screen coordinates

Sets the page viewing mode

Helper function that will refresh annotation and/or field appearances if needed, and then render modified page areas, all based on the contents of the view_change parameter.

Sets the reference page view mode. In a non-continous page presentation mode, the reference page view mode is used to determine the page view mode upon a page change event. For example, if the reference page view mode is set to e_fit_width, the new page coming in will be displayed with width-fit mode.

Gets the reference page view mode. See more details about reference page view mode in {@link #setPageRefViewMode(int)}.

Specify the different thumbnail settings for the viewer. It is recommended that this not be called after SetDoc in order to avoid clearing cached thumbnails. Calling this method with different parameters will also clear the persistent disk cache if it is in use.

Remove all thumbnails from the persistent disk cache.

Retrieves the specified thumbnail from the persistent thumbnail cache on disk, then calling proc on the resulting thumbnail.

Gets the data size of a cached thumbnail.

Retrieves the specified thumbnail from the persistent thumbnail cache on disk if it is available.

Cancel all pending GetThumbAsync requests. Your callback function will still be called for each canceled request, but ‘was_thumb_found’ will be set to ‘false’.

Sets a callback for issuing a render request on the UI thread. The callback will be called from a secondary thread. The called code is responsible for dispatching an event to the UI thread using the relevant mechanism.

Sets the FindText handling function to be called once FindTextAsync is done, whether it was interrupted, canceled, or completed.

Searches for the provided search string in the documents in a secondary thread, and calls FindTextHandler with the resulting selection.