Back to Devexpress

dxPDFViewer Unit

vcl-dxpdfviewer-d6dbf922.md

latest8.1 KB
Original Source

dxPDFViewer Unit

Classes

NameDescription
TdxPDFCustomViewerThe base class for the PDF Viewer control.
TdxPDFViewerA PDF Viewer control.
TdxPDFViewerCellHitTestThe base class for all HitTest classes that provide information about visual elements of the PDF Viewer and its loaded document.
TdxPDFViewerCustomHitTestThe base class for all HitTest classes that provide information about the PDF Viewer‘s visual elements located at the test point.
TdxPDFViewerCustomObjectThe base class for classes that implement many visual and non-visual elements of the PDF Viewer control.
TdxPDFViewerDocumentHitTestContains HitTest information of the document currently displayed by the PDF Viewer.
TdxPDFViewerHighlightsStores colored content highlights within the loaded PDF document.
TdxPDFViewerHitTest
TdxPDFViewerLockedStateImageOptionsStores the PDF Viewer control’s “Locked View” appearance settings.
TdxPDFViewerNavigationPanePage
TdxPDFViewerOptionsAttachmentsContains settings of the Attachments page on the PDF Viewer control’s Navigation pane.
TdxPDFViewerOptionsBehaviorStores the global behavior and functionality settings of the PDF Viewer control.
TdxPDFViewerOptionsBookmarksStores settings of the Bookmarks page within the PDF Viewer control’s Navigation pane.
TdxPDFViewerOptionsFindPanelStores the Find panel settings.
TdxPDFViewerOptionsFormStores interactive form settings.
TdxPDFViewerOptionsNavigationPageThe base class for all classes that implement individual pages displayed by the PDF Viewer control’s Navigation pane.
TdxPDFViewerOptionsNavigationPaneStores the Navigation pane settings.
TdxPDFViewerOptionsPersistentThe base class for all classes that implement the PDF Viewer control’s settings.
TdxPDFViewerOptionsSelectionStores content selection settings.
TdxPDFViewerOptionsThumbnailsStores settings of the Thumbnails page within the PDF Viewer control’s Navigation pane.
TdxPDFViewerOptionsViewContains display settings of a PDF document’s page.
TdxPDFViewerOptionsZoomStores the PDF Viewer control’s zoom settings.
TdxPDFViewerSelectionImplements the selection operation in a PDF document.
TdxPDFViewerTextSearchImplements the text search functionality in the PDF Viewer.

Enums

NameDescription
TdxPDFViewerBookmarksTextSizeEnumerates available relative text sizes for bookmarks displayed by the PDF Viewer control’s Navigation pane.
TdxPDFViewerFindPanelAlignmentEnumerates the available Find panel positioning options.
TdxPDFViewerFindPanelAnimationEnumerates the available show/hide Find panel animation effects.
TdxPDFViewerFindPanelDisplayModeEnumerates available visibility modes for the PDF Viewer‘s Find panel.
TdxPDFViewerNavigationPaneActivePageEnumerates available page display states of the PDF Viewer control’s Navigation pane.
TdxPDFViewerPageLayoutEnumerates page layout types in a zoomed-out PDF document.

Methods

NameDescription
ShowPrintDialog(TdxPDFCustomViewer)Invokes the Print dialog.

Constants

NameDescription
dxPDFViewerDefaultScrollStepSpecifies the minimum number of pixels by which the document view can be scrolled vertically and/or horizontally.
dxPDFViewerDefaultSizeSpecifies the default dimensions of the PDF Viewer control.
dxPDFViewerDefaultZoomFactorSpecifies the default zoom factor value (as a percentage) applied to the first loaded PDF document.
dxPDFViewerFindPanelDefaultAnimationTimeSpecifies the default duration of the Find panel display/hide animation, in milliseconds.
dxPDFViewerMaxZoomFactorSpecifies the default maximum zoom factor value (as a percentage) that can be applied to the loaded PDF document.
dxPDFViewerMinZoomFactorSpecifies the default minimum zoom factor value (as a percentage) that can be applied to the loaded PDF document.
dxPDFViewerZoomStepSpecifies the zoom factor increment/decrement value (as a percentage) for the zoom in/out operations.
hcBackground
hcPageArea
hcSelectionFrame

Types

NameDescription
TdxPDFViewerOnAttachmentActionEventThe procedural type for attachment action events.
TdxPDFViewerOnHyperlinkClickEventThe PDF Viewer control’s hyperlink activation event type.
TdxPDFViewerPrepareLockedStateImageEventThe PDF Viewer control’s “Locked View” draw event type.