Skip to main content

TdxPDFCustomViewer Members

The base class for the PDF Viewer control.

Constructors

Name Description
Create(TComponent) Inherited from TComponent.
CreateParented(HWND) Inherited from TWinControl.

Properties

Name Description
Action Inherited from TControl.
ActiveCanvas Provides access to the control’s GDI-based canvas. Inherited from TcxControl.
Align Inherited from TControl.
AlignDisabled Inherited from TWinControl.
AlignWithMargins Inherited from TControl.
Anchors Inherited from TControl.
AutoSize Inherited from TControl.
AutoSizeMode protected Inherited from TcxScrollingControl.
BevelEdges Inherited from TWinControl.
BevelInner Inherited from TWinControl.
BevelKind Inherited from TWinControl.
BevelOuter Inherited from TWinControl.
BevelWidth Inherited from TWinControl.
BiDiMode Inherited from TControl.
BorderSize protected Inherited from TcxControl.
BorderStyle protected Specifies the control’s border style. Inherited from TcxControl.
BorderWidth Inherited from TWinControl.
Bounds Returns the control’s boundaries. Inherited from TcxControl.
BoundsRect Inherited from TControl.
Brush Inherited from TWinControl.
Canvas Provides access to the control’s GDI-based canvas. Inherited from TcxControl.
Caption Inherited from TControl.
ClientBounds Returns the control’s client area. Inherited from TcxControl.
ClientHeight Inherited from TControl.
ClientOrigin Inherited from TControl.
ClientRect Inherited from TControl.
ClientWidth Inherited from TControl.
Color Inherited from TControl.
ComObject Inherited from TComponent.
ComponentCount Inherited from TComponent.
ComponentIndex Inherited from TComponent.
Components Inherited from TComponent.
ComponentState Inherited from TComponent.
ComponentStyle Inherited from TComponent.
Constraints Inherited from TControl.
ControlCount Inherited from TWinControl.
Controls Inherited from TWinControl.
ControlState Inherited from TControl.
ControlStyle Inherited from TControl.
Ctl3D Inherited from TWinControl.
CurrentPageIndex Specifies a zero-based index of the current page in a PDF document.
CurrentPPI Inherited from TControl.
Cursor Inherited from TControl.
CustomHint Inherited from TControl.
DesignInfo Inherited from TComponent.
DialogsLookAndFeel protected Specifies the look and feel of all dialogs displayed by the PDF Viewer control.
DockClientCount Inherited from TWinControl.
DockClients Inherited from TWinControl.
DockManager Inherited from TWinControl.
DockOrientation Inherited from TControl.
DockSite Inherited from TWinControl.
Document Provides access to the loaded PDF document and its settings.
DoubleBuffered Inherited from TWinControl.
DragAndDropObject Inherited from TcxControl.
DragAndDropObjectClass Inherited from TcxControl.
DragAndDropState Inherited from TcxControl.
DragCursor Inherited from TControl.
DragKind Inherited from TControl.
DragMode Inherited from TControl.
Enabled Inherited from TControl.
ExplicitHeight Inherited from TControl.
ExplicitLeft Inherited from TControl.
ExplicitTop Inherited from TControl.
ExplicitWidth Inherited from TControl.
Floating Inherited from TControl.
FloatingDockSiteClass Inherited from TControl.
FocusOnClick protected Specifies if clicking the control focuses it. Inherited from TcxControl.
Font Inherited from TControl.
Handle Inherited from TWinControl.
HandTool Specifies if the Hand tool is enabled.
Height Inherited from TControl.
HelpContext Inherited from TControl.
HelpKeyword Inherited from TControl.
HelpType Inherited from TControl.
Highlights Provides access to the content highlights in the loaded PDF document.
Hint Specifies a hint message for the control. Inherited from TcxControl.
HitTest Returns HitTest information about a specific point within the PDF Viewer.
HostDockSite Inherited from TControl.
HScrollBar protected Inherited from TcxControl.
HScrollBarVisible protected Inherited from TcxControl.
ImeMode Inherited from TWinControl.
ImeName Inherited from TWinControl.
IsDesigning Indicates if the control is currently being manipulated by the form designer. Inherited from TcxControl.
IsDestroying Indicates if the control is about to be destroyed. Inherited from TcxControl.
IsDrawingLocked Inherited from TWinControl.
IsFocused Identifies if the control is focused. Inherited from TcxControl.
IsLoading Indicates if the control is being loaded. Inherited from TcxControl.
Keys protected Inherited from TcxControl.
Left Inherited from TControl.
LeftPos protected Inherited from TcxScrollingControl.
LookAndFeel protected Provides access to the control’s look & feel settings. Inherited from TcxControl.
LookAndFeelPainter protected Inherited from TcxControl.
LRDockWidth Inherited from TControl.
MarginColor protected Inherited from TdxCustomPreview.
Margins protected Inherited from TdxCustomPreview.
MaxZoomFactor protected Specifies the maximum zoom factor value (as a percentage) that can be applied to the displayed document. Inherited from TdxCustomPreview.
MeasurementUnits protected Inherited from TdxCustomPreview.
MinZoomFactor protected Specifies the minimum zoom factor value (as a percentage) that can be applied to the displayed document. Inherited from TdxCustomPreview.
MouseCapture Inherited from TControl.
MouseCaptureObject Provides access to the dragged object during a drag-and-drop operation. Inherited from TcxControl.
MouseDownPos Specifies the mouse pointer position when an OnMouseDown event occurs. Inherited from TcxControl.
MouseInClient Inherited from TWinControl.
Name Inherited from TComponent.
Observers Inherited from TComponent.
OptionsBehavior protected Provides access to the PDF Viewer control’s core behavior and functionality settings.
OptionsFindPanel protected Provides access to the Find panel settings.
OptionsForm protected Provides access to interactive form settings.
OptionsHint protected Inherited from TdxCustomPreview.
OptionsLockedStateImage protected Specifies display settings for a “Locked View“ image.
OptionsNavigationPane protected Provides access to the Navigation pane settings.
OptionsSelection protected Provides access to content selection settings in a PDF document.
OptionsStore protected Inherited from TdxCustomPreview.
OptionsView protected Provides access to display settings of a PDF document page.
OptionsZoom protected Provides access to the document view zoom settings.
Owner Inherited from TComponent.
Padding Inherited from TWinControl.
PageCount Specifies the number document pages available for viewing. Inherited from TdxCustomPreview.
PageXCount protected Inherited from TdxCustomPreview.
PageYCount protected Inherited from TdxCustomPreview.
Parent Inherited from TControl.
ParentBackground protected Inherited from TcxControl.
ParentBiDiMode Inherited from TControl.
ParentColor Inherited from TControl.
ParentCtl3D Inherited from TWinControl.
ParentCustomHint Inherited from TControl.
ParentDoubleBuffered Inherited from TWinControl.
ParentFont Inherited from TControl.
ParentShowHint Inherited from TControl.
ParentWindow Inherited from TWinControl.
PasswordAttemptsLimit Specifies the number of allowed attempts to enter the PDF document‘s protection password.
PixelsPerInch Inherited from TWinControl.
PopupMenu protected Specifies the popup menu associated with the control. Inherited from TcxControl.
RaiseOnNonMainThreadUsage Inherited from TControl.
RedrawDisabled Inherited from TWinControl.
RotationAngle Specifies the rotation angle applied to the document view.
ScaleFactor Inherited from TControl.
ScrollBars protected Inherited from TcxControl.
Selection Provides access to the content selection in the loaded PDF document.
SelPage protected Inherited from TdxCustomPreview.
SelPageIndex protected Inherited from TdxCustomPreview.
ShowHint Inherited from TControl.
Showing Inherited from TWinControl.
StyleElements Inherited from TControl.
StyleName Inherited from TControl.
TabOrder Inherited from TWinControl.
TabStop Inherited from TcxControl.
Tag Inherited from TComponent.
TBDockHeight Inherited from TControl.
Text Inherited from TControl.
TextSearch Provides access to the PDF Viewer’s text search methods.
TipMode Inherited from TWinControl.
Top Inherited from TControl.
TopPos protected Inherited from TcxScrollingControl.
Touch Inherited from TControl.
Transparent protected Specifies if the control is transparent in GDI render mode. Inherited from TcxControl.
UndockHeight Inherited from TControl.
UndockWidth Inherited from TControl.
UseDockManager Inherited from TWinControl.
VCLComObject Inherited from TComponent.
Visible Inherited from TControl.
VisibleDockClientCount Inherited from TWinControl.
VScrollBar protected Inherited from TcxControl.
VScrollBarVisible protected Inherited from TcxControl.
Width Inherited from TControl.
WindowProc Inherited from TControl.
ZoomFactor protected Specifies the zoom factor (as a percentage) applied to the displayed document. Inherited from TdxCustomPreview.
ZoomMode protected Specifies the active zoom factor calculation mode. Inherited from TdxCustomPreview.
ZoomStep protected Specifies the step increment/decrement of the zoom factor. Inherited from TdxCustomPreview.

Methods

Name Description
AcceptMousePosForClick(Integer,Integer) Inherited from TcxControl.
AddFontListener(IcxFontListener) Inherited from TcxControl.
Assign(TPersistent) Inherited from TPersistent.
AssignTo(TPersistent) Inherited from TPersistent.
BeginDrag(Boolean,Integer) Inherited from TControl.
BeginDragAndDrop Inherited from TcxControl.
BeginInvoke(TAsyncConstArrayFunctionEvent,Untyped[],TObject) Inherited from TComponent.
BeginInvoke(TAsyncConstArrayProc,Untyped[],TObject) Inherited from TComponent.
BeginInvoke(TAsyncConstArrayProcedureEvent,Untyped[],TObject) Inherited from TComponent.
BeginInvoke(TAsyncFunctionEvent,TObject) Inherited from TComponent.
BeginInvoke(TAsyncProcedureEvent,TObject) Inherited from TComponent.
BeginInvoke(TProc,TObject) Inherited from TComponent.
BeginInvoke<TResult>(TAsyncConstArrayFunc<TResult>,Untyped[],TObject) Inherited from TComponent.
BeginInvoke<TResult>(TFunc<TResult>,TObject) Inherited from TComponent.
BeginUpdate Disables repainting of the document view until the EndUpdate or CancelUpdate procedure is called. Inherited from TdxCustomPreview.
BringToFront Inherited from TControl.
Broadcast(Untyped) Inherited from TWinControl.
CancelUpdate Enables repainting of the document view after a call to the BeginUpdate procedure. Inherited from TdxCustomPreview.
CanFocus Inherited from TWinControl.
CanFocusEx Inherited from TcxControl.
CanGoToNextView Identifies if the control can navigate to the next recorded view state.
CanGoToPrevView Identifies if the control can navigate to the preceding recorded view state.
ChangeScale(Integer,Integer) Inherited from TControl.
CheckNonMainThreadUsage Inherited from TControl.
Clear Closes the loaded PDF document.
ClearViewStateHistory Clears the history of the loaded document’s view states.
Click Inherited from TControl.
ClientToParent(TPoint,TWinControl) Inherited from TControl.
ClientToScreen(TPoint) Inherited from TControl.
ClientToScreen(TRect) Inherited from TControl.
ConstrainedResize(Integer,Integer,Integer,Integer) Inherited from TControl.
ContainsControl(TControl) Inherited from TWinControl.
ControlAtPos(TPoint,Boolean,Boolean,Boolean) Inherited from TWinControl.
CreateParentedControl(HWND) Inherited from TWinControl.
DestroyComponents Inherited from TComponent.
Destroying Inherited from TComponent.
DisableAlign Inherited from TWinControl.
Dock(TWinControl,TRect) Inherited from TControl.
DockDrop(TDragDockObject,Integer,Integer) Inherited from TWinControl.
DragDrop(TObject,Integer,Integer) Inherited from TControl.
Dragging Inherited from TControl.
DrawTextBiDiModeFlags(Longint) Inherited from TControl.
DrawTextBiDiModeFlagsReadingOnly Inherited from TControl.
EnableAlign Inherited from TWinControl.
EndDrag(Boolean) Inherited from TControl.
EndFunctionInvoke(IAsyncResult) Inherited from TComponent.
EndInvoke(IAsyncResult) Inherited from TComponent.
EndInvoke<TResult>(IAsyncResult) Inherited from TComponent.
EndUpdate Enables repainting of the document view after a call to the BeginUpdate procedure. Inherited from TdxCustomPreview.
Equals(TObject) Inherited from TObject.
ExecuteAction(TBasicAction) Inherited from TComponent.
FindChildControl(String) Inherited from TWinControl.
FindComponent(String) Inherited from TComponent.
FinishDragAndDrop(Boolean) Inherited from TcxControl.
FlipChildren(Boolean) Inherited from TWinControl.
Focused Inherited from TWinControl.
FreeNotification(TComponent) Inherited from TComponent.
FreeOnRelease Inherited from TComponent.
GetChildren(TGetChildProc,TComponent) Inherited from TComponent.
GetControlsAlignment Inherited from TControl.
GetDragImages Inherited from TControl.
GetHashCode Inherited from TObject.
GetNamePath Inherited from TPersistent.
GetOwner Inherited from TPersistent.
GetParentComponent Inherited from TComponent.
GetStyleName Inherited from TControl.
GetSystemMetrics(Integer) Inherited from TControl.
GetTabControlList(TList) Inherited from TWinControl.
GetTabOrderList(TList) Inherited from TWinControl.
GetTextBuf(PChar,Integer) Inherited from TControl.
GetTextLen Inherited from TControl.
GoToFirstPage Selects and displays the first page of the displayed document. Inherited from TdxCustomPreview.
GoToLastPage Selects and displays the last available page of the displayed document. Inherited from TdxCustomPreview.
GoToNextPage Selects and displays the next available page of the displayed document. Inherited from TdxCustomPreview.
GoToNextView Navigates to the next state recorded in the history of view states.
GoToPrevPage Selects and displays the previous page of the displayed document. Inherited from TdxCustomPreview.
GoToPrevView Navigates to the preceding state recorded in the history of view states.
HandleAllocated Inherited from TWinControl.
HandleNeeded Inherited from TWinControl.
HasParent Inherited from TComponent.
Hide Inherited from TControl.
HideFindPanel Hides the displayed Find panel.
InitiateAction Inherited from TControl.
InsertComponent(TComponent) Inherited from TComponent.
InsertControl(TControl) Inherited from TWinControl.
Invalidate Inherited from TControl.
InvalidateRect(TRect,Boolean) Adds a specified portion of the control’s client area to the window update region. Inherited from TcxControl.
InvalidateRgn(TcxRegion,Boolean) Inherited from TcxControl.
InvalidateWithChildren Inherited from TcxControl.
IsCustomStyleActive Inherited from TControl.
IsDocumentLoaded Identifies if the PDF Viewer has a loaded document.
IsFindPanelVisible Identifies if the Find panel is currently displayed.
IsImplementorOf(IInterface) Inherited from TComponent.
IsLightStyleColor(TColor) Inherited from TControl.
IsMouseInPressedArea(Integer,Integer) Inherited from TcxControl.
IsRightToLeft Inherited from TControl.
IsScrollDataValid protected Inherited from TcxScrollingControl.
Loaded Inherited from TComponent.
LoadFromFile(string) Loads a PDF document from the specified file.
LoadFromStream(TStream) Loads a PDF document from the specified stream.
LockDrawing Inherited from TWinControl.
LockScrollBars Inherited from TcxControl.
ManualDock(TWinControl,TControl,TAlign) Inherited from TControl.
ManualFloat(TRect) Inherited from TControl.
MouseDown(TMouseButton,TShiftState,Integer,Integer) Inherited from TControl.
MouseMove(TShiftState,Integer,Integer) Inherited from TControl.
MouseUp(TMouseButton,TShiftState,Integer,Integer) Inherited from TControl.
MouseWheelHandler(TMessage) Inherited from TControl.
Notification(TComponent,TOperation) Inherited from TComponent.
PaintTo(HDC,Integer,Integer) Inherited from TWinControl.
PaintTo(TCanvas,Integer,Integer) Inherited from TWinControl.
ParentToClient(TPoint,TWinControl) Inherited from TControl.
Perform(Cardinal,WPARAM,LPARAM) Inherited from TControl.
Perform(Cardinal,WPARAM,PChar) Inherited from TControl.
Perform(Cardinal,WPARAM,TRect) Inherited from TControl.
PostMouseMove Inherited from TcxControl.
PostMouseMove(TPoint) Inherited from TcxControl.
PreProcessMessage(TMsg) Inherited from TWinControl.
Realign Inherited from TWinControl.
ReferenceInterface(IInterface,TOperation) Inherited from TComponent.
Refresh Inherited from TControl.
RemoveComponent(TComponent) Inherited from TComponent.
RemoveControl(TControl) Inherited from TWinControl.
RemoveFontListener(IcxFontListener) Inherited from TcxControl.
RemoveFreeNotification(TComponent) Inherited from TComponent.
Repaint Inherited from TControl.
ReplaceDockedControl(TControl,TWinControl,TControl,TAlign) Inherited from TControl.
RotateClockwise Rotates the document view clockwise.
RotateCounterclockwise Rotates the document view counterclockwise.
ScaleBy(Integer,Integer) Inherited from TWinControl.
ScaleForPPI(Integer) Inherited from TControl.
ScaleRectSize(TRect) Inherited from TControl.
ScaleValue(Double) Inherited from TControl.
ScaleValue(Integer) Inherited from TControl.
ScaleValue(TPoint) Inherited from TControl.
ScaleValue(TRect) Inherited from TControl.
ScaleValue(TSize) Inherited from TControl.
ScreenToClient(TPoint) Inherited from TControl.
ScreenToClient(TRect) Inherited from TControl.
ScrollBy(Integer,Integer) Inherited from TWinControl.
ScrollContent(TcxDirection) Inherited from TcxControl.
ScrollWindow(Integer,Integer,TRect) Inherited from TcxControl.
SendToBack Inherited from TControl.
SetBounds(Integer,Integer,Integer,Integer) Inherited from TControl.
SetDesignVisible(Boolean) Inherited from TControl.
SetFocus Inherited from TWinControl.
SetParentComponent(TComponent) Inherited from TComponent.
SetScrollBarInfo(TScrollBarKind,Integer,Integer,Integer,Integer,Integer,Boolean,Boolean) Inherited from TcxControl.
SetSubComponent(Boolean) Inherited from TComponent.
SetTextBuf(PChar) Inherited from TControl.
Show Inherited from TControl.
ShowFindPanel Displays the Find panel.
StartDrag(TDragObject) Inherited from TcxControl.
SystemInfoChanged(Cardinal) Inherited from TcxControl.
ToString Inherited from TObject.
TranslationChanged Inherited from TcxControl.
UnlockDrawing Inherited from TWinControl.
UnlockScrollBars Inherited from TcxControl.
Update Inherited from TControl.
UpdateAction(TBasicAction) Inherited from TComponent.
UpdateControlState Inherited from TWinControl.
UpdateWithChildren Inherited from TcxControl.
UseRightToLeftAlignment Inherited from TControl.
UseRightToLeftReading Inherited from TControl.
UseRightToLeftScrollBar Inherited from TControl.
WndProc(TMessage) Inherited from TControl.
ZoomIn Zooms the document view in. Inherited from TdxCustomPreview.
ZoomOut Zooms the document view out. Inherited from TdxCustomPreview.

Events

Name Description
OnAfterDragMargin protected Inherited from TdxCustomPreview.
OnAlignInsertBefore Inherited from TWinControl.
OnAlignPosition Inherited from TWinControl.
OnAttachmentOpen protected Enables you to respond to an attempt to open a file attached to the opened PDF document.
OnAttachmentSave protected Enables you to respond to an attempt to save a file attached to the opened PDF document.
OnBeforeDragMargin protected Inherited from TdxCustomPreview.
OnCalcPageCount protected Inherited from TdxCustomPreview.
OnCanResize Inherited from TControl.
OnCanShowMarginHint protected Inherited from TdxCustomPreview.
OnClick Inherited from TControl.
OnConstrainedResize Inherited from TControl.
OnContextPopup Inherited from TControl.
OnCustomDrawPreRenderPage protected Inherited from TdxPDFDocumentCustomViewer.
OnCustomDrawPreRenderPageThumbnail protected
OnDblClick Inherited from TControl.
OnDockDrop Inherited from TWinControl.
OnDockOver Inherited from TWinControl.
OnDocumentLoaded protected Enables you to respond to a PDF document load success.
OnDocumentUnloaded protected Enables you to respond to a document clear operation.
OnDragDrop Inherited from TControl.
OnDragMargin protected Inherited from TdxCustomPreview.
OnDragOver Inherited from TControl.
OnDrawPageBackground protected Inherited from TdxCustomPreview.
OnDrawPageContent protected Inherited from TdxCustomPreview.
OnEndDock Inherited from TControl.
OnEndDrag Inherited from TControl.
OnEnter Inherited from TWinControl.
OnExit Inherited from TWinControl.
OnFocusChanged protected Inherited from TcxControl.
OnGesture Inherited from TControl.
OnGetPageNumberHint protected Inherited from TdxCustomPreview.
OnGetPassword protected Enables you to respond to the password request when the PDF Viewer control starts to load an encrypted document.
OnGetSiteInfo Inherited from TWinControl.
OnHideFindPanel protected Enables you to respond to hiding the Find panel.
OnHyperlinkClick protected Allows you to respond to clicking a hyperlink within the displayed PDF document.
OnKeyDown Inherited from TWinControl.
OnKeyPress Inherited from TWinControl.
OnKeyUp Inherited from TWinControl.
OnMarginChanged protected Inherited from TdxCustomPreview.
OnMouseActivate Inherited from TControl.
OnMouseDown Inherited from TControl.
OnMouseEnter protected Occurs when the mouse pointer enters into the control. Inherited from TcxControl.
OnMouseLeave protected Occurs when the mouse pointer leaves the control. Inherited from TcxControl.
OnMouseMove Inherited from TControl.
OnMouseUp Inherited from TControl.
OnMouseWheel Inherited from TControl.
OnMouseWheelDown Inherited from TControl.
OnMouseWheelUp Inherited from TControl.
OnPrepareLockedStateImage protected Allows you to custom paint a “Locked View” image.
OnResize Inherited from TControl.
OnSearchProgress protected Enables you to track the search progress within the loaded PDF document.
OnSelectedPageChanged protected Enables you to respond to navigating to a different available page in the displayed document. Inherited from TdxCustomPreview.
OnSelectedPageChanging protected Inherited from TdxCustomPreview.
OnSelectingPage protected Inherited from TdxCustomPreview.
OnSelectionChanged protected Enables you to respond to content selection changes in the loaded PDF document.
OnShowFindPanel protected Enables you to respond to invoking the Find panel.
OnStartDock Inherited from TControl.
OnStartDrag Inherited from TControl.
OnUnDock Inherited from TWinControl.
OnZoomFactorChanged protected Enables you to respond to zooming the document view in or out. Inherited from TdxCustomPreview.
OnZoomModeChanged protected Inherited from TdxCustomPreview.
See Also