PDFViewCtrl

PDFViewCtrl class supports a number of 'built-in' tool modes. ToolMode enumerates tool modes supported by PDFViewCtrl.

only two pages fit in the current view (similar to booklet view).

pages are displayed sequentially with two pages per row.

display the pages in two columns, with odd-numbered pages on the right.

display the pages two at a time, with odd-numbered pages on the right.

fit height

fit page

fit width

The Constant e_pan.

invert postprocess

no prostprocess

pages are displayed sequentially (one underneath another).

only one page at a time fits in the current view.

The Constant e_text_rect_select.

The Constant e_text_struct_select.

zoom

PDFViewCtrl constructor. Create PDFViewCtrl without associating it to any document.

Instantiates a new PDFViewCtrl.

this method returns the first page number that has text selection on it. Useful when there are selections on multiple pages at the same time.

this method returns the last page number that has text selection on it. Useful when there are selections on multiple pages at the same time.

Checks for selection on page.

Returns true if redo operation is available.

Returns true if Undo operation is available.

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

Cancels rendering in progress and returns immediately, potentially before rendering has actually stopped.

Remove any text selection.

Frees the native memory of the object. This can be explicity called to control the deallocation of native memory and avoid situations where the garbage collector does not free the object in a timely manner.

Convert a point in canvas space to a point in a page space.

Convert a point expressed in canvas space to a point in the current page space.

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

Convert a point in page space to a point in canvas space.

Convert a point in a page space to a point in canvas space.

Convert a point from a page space to screen space.

Convert a point from a page space to a point in screen space.

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

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

Convert a point expressed in screen space to the current page space. page.

Frees the native memory of the object. This can be explicity called to control the deallocation of native memory and avoid situations where the garbage collector does not free the object in a timely manner.

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

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.

Try acquiring a write lock on the currently open 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.

Releases the write lock from the currently open document.

Releases the read lock from the currently open document.

Enable Undo/Redo in this PDFview.

Selects text by searching for a given string of text asynchronously, and calling a user callback upon completion

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

Note: For details about client space, please refer to convScreenPtToCanvasPt(double, double).

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

Gets the list of annotations at line (x1, y1, x2, y2) expressed in screen coordinates *

Gets the list of annotations on a given page.

Get the width of the rendering buffer in pixels.

Note: this method is typically used only in PDFNet for C++

Get the stride of the rendering buffer in pixels.

Note: this method is typically used only in PDFNet for C++

Get the width of the rendering buffer in pixels.

Note: this method is typically used only in PDFNet for C++

Returns the height of the scrollable space.

Returns the width of the scrollable space.

Get the current page.

Get the device transform matrix

Get the device transformation matrix

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

Get the document.

Get the external annot manager belonging to this PDFViewCtrl

Get the external annot manager belonging to this PDFViewCtrl

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

Note: To get valid links, setUrlExtraction(boolean) must be set to true before setting the document.

Returns any meta-data associated with the next sate in the undo chain.

Returns any meta-data associated with the previous sate in the undo chain.

Get the oCG context.

Get the page count.

Get the page number from screen pt.

Get the page presentation mode.

Get the page view mode.

Get the rotation.

Gets annotation bounding box in screen points

Get the selection.

Get the tool mode.

Get the current zoom factor.

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

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

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

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

Checks for selection.

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

Invalidate rect.

The InvalidateRect function adds a rectangle to the buffer/window update region. The update region represents the portion of the buffer/window's client area that must be redrawn

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

Go to the next state in the undo/redo chain. Returns any meta-data associated with that state.

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.

Determine whether this DocumentConversion has progress reporting capability.

Rotates all pages in the document 90 degrees clockwise.

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

Selects all text on the page.

Selects texts by Highlights.

Selects all words that intersect the given selection rectangle.

Selects texts by PDFViewCtrl.Selection.

Selects text taking into account page logical structure. This type of selection is similar to HTML like selection in web-browsers.

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

Note: Anti-aliasing is enabled by default.

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

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

Enables or disables caching.

Note: by default caching is enabled

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 current page to the given page.

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

Set the default 'paper' color used to draw background of each page.

Set the default 'paper' color used to draw background of each page.

Set device DPI, and scale factor. This affects the rendering of certain content, such as annotations with the no_zoom flag.

Associates this PDFViewCtrl with a given PDF document.

Note: Acquires a write lock on the document

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

Set the error report process

Set the highlight color for 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`).

Set the callback function (i.e. a delegate) that is called when FindTextAsync is completed.

Set the gamma factor used for anti-aliased rendering.

Note: Gamma correction is used only in the built-in rasterizer.

Sets the horizontal scroll position in the scrollable space..

Enable or disable highlighting form fields. Default is disabled.

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

Set the image smoothing.

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.

* Note: image smoothing option has effect only if the source image has higher resolution that the output resolution of the image on the rasterized page. PDFNet automatically controls at what resolution/zoom factor, 'image smoothing' needs to take effect.

* Note: image smoothing is enabled.

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

Note: Unlike PDFDraw.SetOCGContext() this method copies the given context. As a result, in order to modify the state of OCG groups in the curent context use GetOCGContext() to obtain the currently selected content and then modify states.

Enable or disable support for overprint. 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). By default overprint is enabled.

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

Set the current page presentation mode.

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

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

Set the page viewing mode.

Note: The default PageView mode is FIT_WIDTH.

Enable or disable path hinting. Path hinting is used to slightly adjust paths in order to avoid or alleviate artifacts of hair line cracks between certain graphical elements.

Note: Path hinting is enabled by default.

Set the preferred size.

Enables or disables progressive rendering in PDFViewCtrl.

Note: Progressive rendering is useful when a PDF page contain lots of elements (e.g. many vector paths, text, or many little images). When progressive rendering is enabled PDFNet will use painter algorithm to draw the page. This way user may be able to see partially rendered page. If a page contains only a single large image, there would be no visible benefit from progressive rendering.

Set 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 RequestRenderInWorkerThread Callback

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

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

Set thin line adjustment parameters.

Set the new tool mode (such as pan, text select, etc).

Enables or disables URL extraction.

Sets the vertical scroll position in the scrollable space..

Note: In this context the canvas is defined in the screen coordinate system and is a rectangle that surrounds all pages in the current page layout.

Set the vertical alignment used for rendering pages within 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 the zoom factor to a new value. The function zooms to a point at the center of the rendering buffer.

Set the zoom factor to a new value using the given pixel coordinate (x,y) as a zoom center. The zoom point (x,y) is represented in the screen coordinate system, which starts in the upper-left corner of the client window.

Specify the different thumbnail settings for the viewer.

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

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

Set the zoom factor to a new value using the given pixel coordinate (x,y) as a zoom center. The zoom point (x,y) is represented in the screen coordinate system, which starts in the upper-left corner of the client window.

Returns the point within the document geometry that is closest to another arbtrary point in screen space

Get the state of the conversion process. Pair this with ConvertNextPage().

Return to the previous state. Returns any meta-data associated with that state.

Redraws the area covered with a given annotation.

Redraws the contents of the buffer.

Redraws the given area in the buffer.

Redraws all instances (Widgets) of the field.

Updates the page layout within the view.