Back to Devexpress

DocumentViewer Properties

windowsforms-devexpress-dot-xtraprinting-dot-preview-dot-documentviewer-dot-underscore-properties.md

latest53.6 KB
Original Source

DocumentViewer Properties

The control to publish (preview, print and export) documents in Windows Forms applications.

NameDescription
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.
AllowDropGets or sets a value indicating whether the control can accept data that the user drags onto it. Inherited from Control.
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.
AutoZoomSpecifies whether or not the auto-zoom mode is enabled for the print preview. Inherited from DocumentViewerBase.
BackColorSpecifies the background color of a DocumentViewer. Inherited from DocumentViewerBase.
BackgroundImageObsolete. This property is overridden and never used. To customize the DocumentViewer‘s background image, use custom skins. Inherited from DocumentViewerBase.
BackgroundImageLayoutObsolete. This property is overridden and never used. To customize the DocumentViewer‘s background image and its layout, use custom skins. Inherited from DocumentViewerBase.
BindingContextGets or sets the BindingContext for the control. Inherited from ContainerControl.
BorderStyleSpecifies the border style of the DocumentViewer. Inherited from DocumentViewerBase.
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.
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.
ContextMenuGets or sets the shortcut menu associated with the control. Inherited from Control.
ContextMenuStripGets or sets the ContextMenuStrip associated with this control. Inherited from Control.
ContinuousFor internal use. Inherited from DocumentViewerBase.
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.
CurrentAutoScaleDimensionsGets the current run-time dimensions of the screen. Inherited from ContainerControl.
CursorGets or sets the cursor that is displayed when the mouse pointer is over the control. Inherited from Control.
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.
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.
DesignModeFor internal use. Inherited from DocumentViewerBase.
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.
DockingViewStyleSpecifies the View style for dock panels. Inherited from PrintControl.
DockManagerProvides access to the DockManager, specifying the settings of dock panels in Print Preview. Inherited from PrintControl.
DockPaddingGets the dock padding settings for all edges of the control. Inherited from ScrollableControl.
DocumentSpecifies the document assigned to the DocumentViewer. Inherited from DocumentViewerBase.
DocumentHasBookmarksIndicates whether or not a Document opened in Print Preview has any bookmarks. Inherited from PrintControl.
DocumentIsCreatingFor internal use. Inherited from DocumentViewerBase.
DocumentIsEmptySpecifies whether or not the current document is empty. Inherited from DocumentViewerBase.
DocumentMapVisibleIndicates whether or not the Document Map is visible in Print Preview. Inherited from PrintControl.
DocumentSourceSpecifies a document supplier for the DocumentViewer.
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.
EditingFieldsHighlightedIndicates whether the editing fields are highlighted in the document displayed in the Print Preview. Inherited from PrintControl.
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.
EnableSmoothScrollingSpecifies whether to enable smooth scrolling in the Document Viewer control. Inherited from DocumentViewerBase.
Events protectedGets the list of event handlers that are attached to this Component. Inherited from Component.
FindPanelVisibleIndicates whether or not the Find panel is visible in Print Preview. Inherited from PrintControl.
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.
ForeColorSpecifies the foreground color of the DocumentViewer. Inherited from DocumentViewerBase.
HandleGets the window handle that the control is bound to. Inherited from Control.
HandToolFor internal use. Inherited from DocumentViewerBase.
HasChildrenGets a value indicating whether the control contains one or more child controls. Inherited from Control.
HeightGets or sets the height of the control. Inherited from Control.
HorizontalScrollGets the characteristics associated with the horizontal scroll bar. Inherited from ScrollableControl.
HorizontalScrollBarVisibilitySpecifies the visibility of the horizontal scroll bar in Print Preview. Inherited from PrintControl.
HScroll protectedGets or sets a value indicating whether the horizontal scroll bar is visible. Inherited from ScrollableControl.
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.
IsHandleCreatedGets a value indicating whether the control has a handle associated with it. Inherited from Control.
IsMetricGets or sets a value indicating whether or not to use the metric system for measurements in the print preview. Inherited from DocumentViewerBase.
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.
MarginsFor internal use. Inherited from DocumentViewerBase.
MaximumSizeGets or sets the size that is the upper limit that GetPreferredSize(Size) can specify. Inherited from Control.
MaxPageColumnsGets the maximum number of columns for multi-page reports displayed within the DocumentViewer. Inherited from DocumentViewerBase.
MaxPageRowsGets the maximum number of rows for a multi-page report displayed within the DocumentViewer. Inherited from DocumentViewerBase.
MaxZoomGets the maximum zoom factor of a report page within the DocumentViewer. Inherited from DocumentViewerBase.
MinimumSizeGets or sets the size that is the lower limit that GetPreferredSize(Size) can specify. Inherited from Control.
MinZoomGets the minimum zoom factor of a report page within the DocumentViewer. Inherited from DocumentViewerBase.
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.
PaddingGets or sets padding within the control. Inherited from Control.
PageBorderColorSpecifies the color used to draw borders around all pages in DocumentViewer. Inherited from DocumentViewerBase.
PageBorderVisibilitySpecifies whether borders should be painted on all document pages or selected pages in the DocumentViewer. Inherited from DocumentViewerBase.
PageBorderWidthSpecifies the width of the borders around all pages in the DocumentViewer. Inherited from DocumentViewerBase.
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.
PopupFormFor internal use. Inherited from DocumentViewerBase.
PreferredSizeGets the size of a rectangular area into which the control can fit. Inherited from Control.
PrintingSystemSpecifies a Printing System assigned to the DocumentViewer.
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.
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.
RenderRightToLeft protectedThis property is now obsolete. Inherited from Control.
RequestDocumentCreationSpecifies whether to create a document automatically, or on a user request.
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.
SelectedPageObtains the currently selected report page. Inherited from DocumentViewerBase.
SelectedPageBorderColorSpecifies the color of borders around the selected page in DocumentViewer. Inherited from DocumentViewerBase.
SelectedPageBorderWidthSpecifies the width of the borders around the currently selected page in DocumentViewer. Inherited from DocumentViewerBase.
SelectedPageIndexSpecifies the index of a currently selected page in the DocumentViewer. Inherited from DocumentViewerBase.
ShowFocusCues protectedGets a value indicating whether the control should display focus rectangles. Inherited from Control.
ShowKeyboardCues protectedGets a value indicating whether the user interface is in the appropriate state to show or hide keyboard accelerators. Inherited from Control.
ShowPageMarginsSpecifies whether or not the DocumentViewer shows page margin lines. Inherited from DocumentViewerBase.
ShowToolTipsSpecifies whether or not to display hints in the DocumentViewer. Inherited from DocumentViewerBase.
SiteGets or sets the site of the XtraUserControl. Inherited from XtraUserControl.
SizeGets or sets the height and width of the control. Inherited from Control.
StatusSpecifies whether or not the current document is empty or null. Inherited from DocumentViewerBase.
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.
ThumbnailsVisibleIndicates whether or not the Thumbnails panel is visible in Print Preview. Inherited from PrintControl.
TooltipBackColorSpecifies the background color of all tooltips in the DocumentViewer. Inherited from DocumentViewerBase.
TooltipFontSpecifies the font of all tooltips in the DocumentViewer. Inherited from DocumentViewerBase.
TooltipForeColorSpecifies the foreground color of all tooltips in the DocumentViewer. Inherited from DocumentViewerBase.
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.
UseAsyncDocumentCreationGets or sets whether the DocumentViewer should create a report document asynchronously in a separate task. Inherited from PrintControl.
UseDirectXPaintSpecifies whether the Document Viewer control uses the DirectX Hardware Acceleration. Inherited from DocumentViewerBase.
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.
VerticalScrollBarVisibilitySpecifies the visibility of the vertical scroll bar in Print Preview. Inherited from PrintControl.
ViewColumnsFor internal use. Inherited from DocumentViewerBase.
ViewControlFor internal use. Inherited from DocumentViewerBase.
ViewManagerFor internal use. Inherited from DocumentViewerBase.
ViewRowsFor internal use. Inherited from DocumentViewerBase.
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.
ZoomSpecifies the current zoom factor of a document page in the DocumentViewer. Inherited from DocumentViewerBase.

See Also

DocumentViewer Class

DocumentViewer Members

DevExpress.XtraPrinting.Preview Namespace