TTMSFNCWXPDFViewer Class

PDF viewer control that displays documents from a URL, file or Base64 string and exposes page navigation, zooming, rotation, text search, thumbnail generation and form-field extraction as published members.

API unit family: TMSFNCWXPDFViewer Inherits from: TTMSFNCWXCustomPDFViewer

Syntax

TTMSFNCWXPDFViewer = class(TTMSFNCWXCustomPDFViewer)

Properties

Name	Description
ActivePage	Gets or sets the one-based page number currently displayed. (inherited from TTMSFNCWXCustomPDFViewer)
CalculateThumbnails	Determines whether page thumbnails are generated automatically when a document is loaded. (inherited from TTMSFNCWXCustomPDFViewer)
LibraryLocation	Determines whether the rendering library and its assets are loaded from an online location or from local resources. (inherited from TTMSFNCWXCustomPDFViewer)
PDFRotationAngle	Gets or sets the rotation applied to the displayed page. (inherited from TTMSFNCWXCustomPDFViewer)
PageCount	Gets the total number of pages in the currently loaded document. (inherited from TTMSFNCWXCustomPDFViewer)
Password	Gets or sets the password used to open a password-protected document. (inherited from TTMSFNCWXCustomPDFViewer)
ThumbnailSize	Gets or sets the edge length, in pixels, used when generating page thumbnails. (inherited from TTMSFNCWXCustomPDFViewer)
Zoom	Gets or sets the zoom factor applied to the displayed page. (inherited from TTMSFNCWXCustomPDFViewer)

Methods

Name	Description
FitToPage	Adjusts the zoom factor so the current page fits the control. (inherited from TTMSFNCWXCustomPDFViewer)
GenerateImageActualPage	Renders the current page to a Base64-encoded image. (inherited from TTMSFNCWXCustomPDFViewer)
GenerateThumbnails	Generates thumbnails for every page of the loaded document. (inherited from TTMSFNCWXCustomPDFViewer)
GetFormFields	Requests the form field data contained in the document. (inherited from TTMSFNCWXCustomPDFViewer)
GetPageAsText	Requests the text content of a page. (inherited from TTMSFNCWXCustomPDFViewer)
LoadFromBase64	Loads a document from a Base64-encoded string and displays it. (inherited from TTMSFNCWXCustomPDFViewer)
LoadFromFile	Loads a document from a local file and displays it. (inherited from TTMSFNCWXCustomPDFViewer)
LoadFromUrl	Loads a document from a URL and displays it. (inherited from TTMSFNCWXCustomPDFViewer)
NextPage	Navigates to the next page, if one exists. (inherited from TTMSFNCWXCustomPDFViewer)
PreviousPage	Navigates to the previous page, if one exists. (inherited from TTMSFNCWXCustomPDFViewer)
SavePageTextAsJSON	Extracts the text of a page and saves it to a JSON file. (inherited from TTMSFNCWXCustomPDFViewer)
SearchText	Searches the loaded document for the supplied text. (inherited from TTMSFNCWXCustomPDFViewer)
ShowPage	Displays the page at the given index. (inherited from TTMSFNCWXCustomPDFViewer)
TurnAngleLeft	Rotates the current page 90 degrees counter-clockwise. (inherited from TTMSFNCWXCustomPDFViewer)
TurnAngleRight	Rotates the current page 90 degrees clockwise. (inherited from TTMSFNCWXCustomPDFViewer)
ZoomIn	Increases the zoom factor by one step. (inherited from TTMSFNCWXCustomPDFViewer)
ZoomOut	Decreases the zoom factor by one step. (inherited from TTMSFNCWXCustomPDFViewer)

Events

Name	Description
OnFoundSearchText	Occurs for each match located during a text search. (inherited from TTMSFNCWXCustomPDFViewer)
OnGenerateImagePage	Occurs when the active page has been rendered to a Base64-encoded image. (inherited from TTMSFNCWXCustomPDFViewer)
OnGenerateThumbnail	Occurs when a thumbnail image for a page has been generated. (inherited from TTMSFNCWXCustomPDFViewer)
OnGetFormFields	Occurs when the document's form field data has been collected. (inherited from TTMSFNCWXCustomPDFViewer)
OnGetPageText	Occurs when the text content of a requested page becomes available. (inherited from TTMSFNCWXCustomPDFViewer)
OnHyperlinkClick	Occurs when a hyperlink inside the document is clicked. (inherited from TTMSFNCWXCustomPDFViewer)
OnLoadError	Occurs when a document fails to load. (inherited from TTMSFNCWXCustomPDFViewer)
OnLoaded	Occurs when a document has finished loading and its page count is known. (inherited from TTMSFNCWXCustomPDFViewer)
OnNotFoundSearchText	Occurs when a text search completes without finding any match. (inherited from TTMSFNCWXCustomPDFViewer)
OnPageLoaded	Occurs when the viewer surface has loaded and is ready to display content. (inherited from TTMSFNCWXCustomPDFViewer)
OnPageRendered	Occurs after the active page has been rendered. (inherited from TTMSFNCWXCustomPDFViewer)
OnPinchIn	Occurs when a pinch-in gesture is detected on the rendered document. (inherited from TTMSFNCWXCustomPDFViewer)
OnPinchOut	Occurs when a pinch-out gesture is detected on the rendered document. (inherited from TTMSFNCWXCustomPDFViewer)
OnSearchTextFinished	Occurs when a text search has completed, summarizing the matches found. (inherited from TTMSFNCWXCustomPDFViewer)
OnThumbnailProgress	Occurs as thumbnail generation progresses, reporting position and total count. (inherited from TTMSFNCWXCustomPDFViewer)
OnTouchEnd	Occurs when a touch interaction ends on the rendered document. (inherited from TTMSFNCWXCustomPDFViewer)
OnTouchMove	Occurs while a touch point moves over the rendered document. (inherited from TTMSFNCWXCustomPDFViewer)
OnTouchStart	Occurs when a touch interaction starts on the rendered document. (inherited from TTMSFNCWXCustomPDFViewer)
OnViewerInitialized	Occurs once the viewer has fully initialized and can accept document operations. (inherited from TTMSFNCWXCustomPDFViewer)