Back to Devexpress

PdfViewer Properties

windowsforms-devexpress-dot-xtrapdfviewer-dot-pdfviewer-dot-underscore-properties.md

latest50.0 KB
Original Source

PdfViewer Properties

Represents the PDF Viewer, which displays PDF files in WinForms applications.

NameDescription
AcceptsTabGets or sets a value indicating whether pressing the TAB key is processed by the PDF Viewer instead of moving the focus to the next control in the tab order.
AccessibilityObjectGets the AccessibleObject assigned to the control. Inherited from Control.
AccessibleDefaultActionDescriptionGets or sets the default action description of the control for use by accessibility client applications. Inherited from Control.
AccessibleDescriptionGets or sets the description of the control used by accessibility client applications. Inherited from Control.
AccessibleNameGets or sets the name of the control used by accessibility client applications. Inherited from Control.
AccessibleRoleGets or sets the accessible role of the control. Inherited from Control.
ActiveControlGets or sets the active control on the container control. Inherited from ContainerControl.
AllowCommentFilteringGets or sets whether to allow users to filter annotation comments in the Comments page on the navigation pane.
AllowCommentRepliesGets or sets whether the comment replies are allowed.
AllowCommentSortingGets or sets whether to allow users to sort annotation comments in the Comments page on the navigation pane.
AllowDropGets or sets a value indicating whether the control can accept data that the user drags onto it. Inherited from Control.
AllowEditLockedAnnotationsGets or sets whether to allow users to edit locked annotations in the loaded document.
AnchorGets or sets the edges of the container to which a control is bound and determines how a control is resized with its parent. Inherited from Control.
AppearanceGets the appearance settings used to paint the user control. Inherited from XtraUserControl.
AutoScaleDimensionsGets or sets the dimensions that the control was designed to. Inherited from ContainerControl.
AutoScaleFactor protectedGets the scaling factor between the current and design-time automatic scaling dimensions. Inherited from ContainerControl.
AutoScaleModeGets or sets the automatic scaling mode of the control. Inherited from ContainerControl.
AutoScrollGets or sets a value indicating whether the container enables the user to scroll to any controls placed outside of its visible boundaries. Inherited from ScrollableControl.
AutoScrollMarginGets or sets the size of the auto-scroll margin. Inherited from ScrollableControl.
AutoScrollMinSizeGets or sets the minimum size of the auto-scroll. Inherited from ScrollableControl.
AutoScrollOffsetGets or sets where this control is scrolled to in ScrollControlIntoView(Control). Inherited from Control.
AutoScrollPositionGets or sets the location of the auto-scroll position. Inherited from ScrollableControl.
AutoSizeThis property is not relevant for this class. Inherited from UserControl.
AutoSizeModeGets or sets how the control will resize itself. Inherited from UserControl.
AutoValidateGets or sets how the control performs validation when the user changes focus to another control. Inherited from UserControl.
BackColorGets or sets the user control’s background color. Inherited from XtraUserControl.
BackgroundImageGets or sets the background image displayed in the control. Inherited from Control.
BackgroundImageLayoutGets or sets the background image layout as defined in the ImageLayout enumeration. Inherited from Control.
BindingContextGets or sets the BindingContext for the control. Inherited from ContainerControl.
BookmarksReturns a list of document bookmarks.
BorderStyleGets or sets the border style of the user control. Inherited from UserControl.
BottomGets the distance, in pixels, between the bottom edge of the control and the top edge of its container’s client area. Inherited from Control.
BoundsGets or sets the size and location of the control including its nonclient elements, in pixels, relative to the parent control. Inherited from Control.
CanEnableIme protectedGets a value indicating whether the ImeMode property can be set to an active value, to enable IME support. Inherited from ContainerControl.
CanFocusGets a value indicating whether the control can receive focus. Inherited from Control.
CanRaiseEvents protectedDetermines if events can be raised on the control. Inherited from Control.
CanSelectGets a value indicating whether the control can be selected. Inherited from Control.
CaptureGets or sets a value indicating whether the control has captured the mouse. Inherited from Control.
CausesValidationGets or sets a value indicating whether the control causes validation to be performed on any controls that require validation when it receives focus. Inherited from Control.
CheckForIllegalCrossThreadCalls staticGets or sets a value indicating whether to catch calls on the wrong thread that access a control’s Handle property when an application is being debugged. Inherited from Control.
ClientRectangleGets the rectangle that represents the client area of the control. Inherited from Control.
ClientSizeGets or sets the height and width of the client area of the control. Inherited from Control.
CommentFilterObtains filter options for annotations and comments.
CommentFilterAuthorsObtains a collection of annotation author names.
CommentSortModeGets or sets the sorting mode for the annotations and comments in the Comments navigation pane.
CompanyNameGets the name of the company or creator of the application containing the control. Inherited from Control.
ContainerGets the IContainer that contains the Component. Inherited from Component.
ContainsFocusGets a value indicating whether the control, or one of its child controls, currently has the input focus. Inherited from Control.
ContentMarginModeSpecifies the mode for calculating the outer border width displayed by a PdfViewer around document pages.
ContentMinMarginSpecifies the minimum width of the outer border displayed by a PdfViewer around document pages.
ContextMenuGets or sets the shortcut menu associated with the control. Inherited from Control.
ContinueSearchFromGets or sets where the PDF Viewer continues its search after you scroll a document.
ControlsGets the collection of controls contained within the control. Inherited from Control.
CreatedGets a value indicating whether the control has been created. Inherited from Control.
CreateParams protectedGets the required creation parameters when the control handle is created. Inherited from UserControl.
CurrentAutoScaleDimensionsGets the current run-time dimensions of the screen. Inherited from ContainerControl.
CurrentPageNumberSpecifies the number of the currently displayed page.
CursorGets or sets the cursor that is displayed when the mouse pointer is over the control. Inherited from Control.
CursorModeGets or sets a value that specifies the interaction mode for keyboard and cursor.
DataBindingsGets the data bindings for the control. Inherited from Control.
DefaultBackColor staticGets the default background color of the control. Inherited from Control.
DefaultCursor protectedGets or sets the default cursor for the control. Inherited from Control.
DefaultDocumentDirectorySpecifies the initial directory displayed by the Save As dialog and Open File dialog.
DefaultFont staticGets the default font of the control. Inherited from Control.
DefaultForeColor staticGets the default foreground color of the control. Inherited from Control.
DefaultImeMode protectedGets the default Input Method Editor (IME) mode supported by the control. Inherited from Control.
DefaultMargin protectedGets the space, in pixels, that is specified by default between controls. Inherited from Control.
DefaultMaximumSize protectedGets the length and height, in pixels, that is specified as the default maximum size of a control. Inherited from Control.
DefaultMinimumSize protectedGets the length and height, in pixels, that is specified as the default minimum size of a control. Inherited from Control.
DefaultPadding protectedGets the internal spacing, in pixels, of the contents of a control. Inherited from Control.
DefaultSize protectedGets the default size of the control. Inherited from UserControl.
DesignMode protectedGets a value that indicates whether the Component is currently in design mode. Inherited from Component.
DestinationNamesReturns a list of destination names.
DetachStreamAfterLoadCompleteSpecifies whether the PDF Viewer component completes all input operations after loading a document.
DisplayRectangleGets the rectangle that represents the virtual display area of the control. Inherited from ScrollableControl.
DisposingGets a value indicating whether the base Control class is in the process of disposing. Inherited from Control.
DockGets or sets which control borders are docked to its parent control and determines how a control is resized with its parent. Inherited from Control.
DockPaddingGets the dock padding settings for all edges of the control. Inherited from ScrollableControl.
DocumentCreatorIf the document was converted to PDF from another format, specifies the name of the conforming product that created the original document from which it was converted.
DocumentFilePathGets or sets the path to the PDF file, which is currently opened in the PdfViewer control.
DocumentProducerIf the document was converted to PDF from another format, specifies the name of the conforming product that converted it to PDF.
DocumentPropertiesProvides access to the basic information about a document.
DoubleBuffered protectedGets or sets a value indicating whether this control should redraw its surface using a secondary buffer to reduce or prevent flicker. Inherited from Control.
EnabledGets or sets a value indicating whether the control can respond to user interaction. Inherited from Control.
EnableIXtraResizeableControlInterfaceProxyThis member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from XtraUserControl.
Events protectedGets the list of event handlers that are attached to this Component. Inherited from Component.
FindDialogOptionsProvides the text search options assigned to the Find Text dialog.
FocusedGets a value indicating whether the control has input focus. Inherited from Control.
FontGets or sets font settings applied to the control. Inherited from XtraUserControl.
FontHeight protectedGets or sets the height of the font of the control. Inherited from Control.
ForeColorGets or sets the control’s foreground color. Inherited from XtraUserControl.
HandleGets the window handle that the control is bound to. Inherited from Control.
HandToolObsolete. Specifies whether to browse a document (by using the Hand Tool ), or select parts of its content (by using the Select Tool ).
HasChildrenGets a value indicating whether the control contains one or more child controls. Inherited from Control.
HasSelectionSpecifies whether or not any PDF content is selected.
HeightGets or sets the height of the control. Inherited from Control.
HighlightedFormFieldColorGets or sets a color which is used to highlight form fields in a PDF document.
HighlightFormFieldsGets or sets a value which indicates whether to use a color to highlight form fields in a PDF document.
HorizontalScrollGets the characteristics associated with the horizontal scroll bar. Inherited from ScrollableControl.
HorizontalScrollPositionSpecifies the horizontal position of the PdfViewer scroll bar.
HScroll protectedGets or sets a value indicating whether the horizontal scroll bar is visible. Inherited from ScrollableControl.
ImageCacheSizeSpecifies the size of the PDF image cache (in megabytes).
ImeModeGets or sets the Input Method Editor (IME) mode of the control. Inherited from Control.
ImeModeBase protectedGets or sets the IME mode of a control. Inherited from Control.
InvokeRequiredGets a value indicating whether the caller must call an invoke method when making method calls to the control because the caller is on a different thread than the one the control was created on. Inherited from Control.
IsAccessibleGets or sets a value indicating whether the control is visible to accessibility applications. Inherited from Control.
IsDisposedGets a value indicating whether the control has been disposed of. Inherited from Control.
IsDocumentChangedIndicates whether the current document has been changed.
IsDocumentOpenedGets a value indicating whether any document is currently being loaded into the PdfViewer.
IsFindDialogVisibleIndicates the visibility state of the Find dialog in a PDF Viewer.
IsHandleCreatedGets a value indicating whether the control has a handle associated with it. Inherited from Control.
IsMirroredGets a value indicating whether the control is mirrored. Inherited from Control.
LayoutEngineGets a cached instance of the control’s layout engine. Inherited from Control.
LeftGets or sets the distance, in pixels, between the left edge of the control and the left edge of its container’s client area. Inherited from Control.
LocationGets or sets the coordinates of the upper-left corner of the control relative to the upper-left corner of its container. Inherited from Control.
LookAndFeelContains settings that specify the look and feel of the current XtraUserControl and all DevExpress controls placed on it. Inherited from XtraUserControl.
MarginGets or sets the space between controls. Inherited from Control.
MarkupToolsSettingsProvides access to the markup tools settings.
MaximumSizeGets or sets the size that is the upper limit that GetPreferredSize(Size) can specify. Inherited from Control.
MaxPrintingDpiSpecifies the maximum DPI (dots per inch) value allowed for document printing.
MaxZoomFactorReturns the maximum allowed zoom factor.
MenuManagerSpecifies an object that controls the look and feel of the popup menus.
MinimumSizeGets or sets the size that is the lower limit that GetPreferredSize(Size) can specify. Inherited from Control.
MinZoomFactorReturns the minimum allowed zoom factor.
ModifierKeys staticGets a value indicating which of the modifier keys (SHIFT, CTRL, and ALT) is in a pressed state. Inherited from Control.
MouseButtons staticGets a value indicating which of the mouse buttons is in a pressed state. Inherited from Control.
MousePosition staticGets the position of the mouse cursor in screen coordinates. Inherited from Control.
NameGets or sets the name of the control. Inherited from Control.
NavigationPaneInitialSelectedPageGets or sets a value that specifies a page (thumbnails, bookmarks or attachments) that will be selected on the navigation pane after loading a new PDF document.
NavigationPaneInitialVisibilitySpecifies the initial visible state of a navigation pane after loading a new PDF document.
NavigationPaneMinWidthReturns the minimum width of a navigation pane.
NavigationPanePageVisibilitySpecifies the visibility of pages ( Bookmarks , Thumbnails , Attachments , Comments , Signatures , and Layers ) on the Navigation pane.
NavigationPaneSelectedPageGets or sets a value that is used to select a current page (thumbnails, bookmarks or attachments) programmatically on the navigation pane. You can also obtain the currently selected page that is opened on the navigation pane.
NavigationPaneVisibilitySpecifies the current visible state of a navigation pane.
NavigationPaneWidthGets or sets the navigation pane width (where outlines are located).
OutlineViewerSettingsProvides access to the settings of the PDF outline viewer.
PaddingGets or sets padding within the control. Inherited from Control.
PageCountReturns the total number of pages in a document.
ParentGets or sets the parent container of the control. Inherited from Control.
ParentFormGets the form that the container control is assigned to. Inherited from ContainerControl.
PasswordAttemptsLimitSpecifies the maximum number of allowed attempts to enter the PDF file’s security password.
PreferredSizeGets the size of a rectangular area into which the control can fit. Inherited from Control.
ProductNameGets the product name of the assembly containing the control. Inherited from Control.
ProductVersionGets the version of the assembly containing the control. Inherited from Control.
PropagatingImeMode protected staticGets an object that represents a propagating IME mode. Inherited from Control.
ReadOnlySpecifies whether document modifications are prohibited.
RecreatingHandleGets a value indicating whether the control is currently re-creating its handle. Inherited from Control.
RegionGets or sets the window region associated with the control. Inherited from Control.
RenderingEngineSpecifies the engine used to render page content.
RenderPageContentWithDirectXObsolete. Gets or sets whether to render page content with DirectX.
RenderRightToLeft protectedThis property is now obsolete. Inherited from Control.
ResizeRedraw protectedGets or sets a value indicating whether the control redraws itself when resized. Inherited from Control.
RightGets the distance, in pixels, between the right edge of the control and the left edge of its container’s client area. Inherited from Control.
RightToLeftGets or sets a value indicating whether control’s elements are aligned to support locales using right-to-left fonts. Inherited from Control.
RotationAngleSpecifies the rotation angle of a document in the PdfViewer.
ShowFocusCues protectedGets a value indicating whether the control should display focus rectangles. Inherited from Control.
ShowImagePlaceholderObsolete. Gets or sets a value which indicates whether to show placeholders for images in unsupported image formats.
ShowKeyboardCues protectedGets a value indicating whether the user interface is in the appropriate state to show or hide keyboard accelerators. Inherited from Control.
ShowPrintStatusDialogGets or sets whether or not to show a print status dialog when printing a document.
ShowSavingProgressDialogSpecifies whether or not to show the Saving a file… dialog.
SiteGets or sets the site of the XtraUserControl. Inherited from XtraUserControl.
SizeGets or sets the height and width of the control. Inherited from Control.
TabIndexGets or sets the tab order of the control within its container. Inherited from Control.
TabStopGets or sets a value indicating whether the user can give the focus to this control using the TAB key. Inherited from Control.
TagGets or sets the object that contains data about the control. Inherited from Control.
TextGets or sets the text associated with this control. Inherited from UserControl.
TopGets or sets the distance, in pixels, between the top edge of the control and the top edge of its container’s client area. Inherited from Control.
TopLevelControlGets the parent control that is not parented by another Windows Forms control. Typically, this is the outermost Form that the control is contained in. Inherited from Control.
UseWaitCursorGets or sets a value indicating whether to use the wait cursor for the current control and all child controls. Inherited from Control.
VerticalScrollGets the characteristics associated with the vertical scroll bar. Inherited from ScrollableControl.
VerticalScrollPositionSpecifies the vertical position of the PdfViewer scroll bar.
VisibleGets or sets a value indicating whether the control and all its child controls are displayed. Inherited from Control.
VScroll protectedGets or sets a value indicating whether the vertical scroll bar is visible. Inherited from ScrollableControl.
WidthGets or sets the width of the control. Inherited from Control.
WindowTargetThis property is not relevant for this class. Inherited from Control.
ZoomFactorSpecifies the document’s zoom factor.
ZoomModeSpecifies the document zoom mode.

See Also

PdfViewer Class

PdfViewer Members

DevExpress.XtraPdfViewer Namespace