Table of Contents

TTMSFNCWXDocxViewer Class

Document viewer component that renders Word (.docx) documents and publishes the navigation, rendering options, and events for design-time use.

API unit family: TMSFNCWXDocxViewer Inherits from: TTMSFNCWXCustomDocxViewer

Syntax

TTMSFNCWXDocxViewer = class(TTMSFNCWXCustomDocxViewer)

Properties

Name Description
ActivePage Gets or sets the one-based number of the currently active page. Setting the value scrolls the corresponding page into view. (inherited from TTMSFNCWXCustomDocxViewer)
ActivePageIndex Gets or sets the zero-based index of the currently active page. Setting the value scrolls the corresponding page into view. (inherited from TTMSFNCWXCustomDocxViewer)
Base64Document Holds the document content as a Base64-encoded string. Assigning a value renders the document. Prefer LoadFromBase64 or LoadFromFile to populate this property. (inherited from TTMSFNCWXCustomDocxViewer)
LibraryLocation Selects whether the rendering library is loaded from an online source or from local resources bundled with the application. (inherited from TTMSFNCWXCustomDocxViewer)
Options Provides the rendering options that control how the loaded document is displayed. Changing an option re-renders the document. (inherited from TTMSFNCWXCustomDocxViewer)
PageCount Gets the total number of pages in the rendered document. (inherited from TTMSFNCWXCustomDocxViewer)

Methods

Name Description
EndUpdate Ends a batched update and re-renders the document once the update count reaches zero. (inherited from TTMSFNCWXCustomDocxViewer)
LoadFromBase64 Loads a document from a Base64-encoded string and renders it in the viewer. (inherited from TTMSFNCWXCustomDocxViewer)
LoadFromFile Loads a document from a file on disk, encoding its content and rendering it in the viewer. (inherited from TTMSFNCWXCustomDocxViewer)
NextPage Scrolls the page following the currently active page into view. (inherited from TTMSFNCWXCustomDocxViewer)
PreviousPage Scrolls the page preceding the currently active page into view. (inherited from TTMSFNCWXCustomDocxViewer)
ShowPage Scrolls the requested page into view. (inherited from TTMSFNCWXCustomDocxViewer)
ZoomIn Increases the zoom level of the rendered document by one step. (inherited from TTMSFNCWXCustomDocxViewer)
ZoomOut Decreases the zoom level of the rendered document by one step. (inherited from TTMSFNCWXCustomDocxViewer)

Events

Name Description
OnDocumentRendered Occurs after the document has finished rendering, reporting the total page count. (inherited from TTMSFNCWXCustomDocxViewer)
OnLinkClick Occurs when a hyperlink inside the rendered document is clicked, reporting the link target. (inherited from TTMSFNCWXCustomDocxViewer)
OnPageChange Occurs when the active page changes, for example through navigation or scrolling. (inherited from TTMSFNCWXCustomDocxViewer)
OnPageClick Occurs when a page in the rendered document is clicked, reporting the clicked page index. (inherited from TTMSFNCWXCustomDocxViewer)
OnScroll Occurs while the document is being scrolled, reporting the page index currently in view. (inherited from TTMSFNCWXCustomDocxViewer)
OnScrollEnd Occurs when scrolling reaches the end of the document, reporting the last visible page index. (inherited from TTMSFNCWXCustomDocxViewer)