Skip to main content

DocumentViewerBase Members

The base for classes that provide the Print Preview functionality in Windows Forms applications.

Constructors

Name Description
DocumentViewerBase() Initializes a new instance of the DocumentViewerBase class with default settings.

Fields

Name Description
ScrollStateAutoScrolling protected static Determines the value of the AutoScroll property. Inherited from ScrollableControl.
ScrollStateFullDrag protected static Determines whether the user has enabled full window drag. Inherited from ScrollableControl.
ScrollStateHScrollVisible protected static Determines whether the value of the HScroll property is set to true. Inherited from ScrollableControl.
ScrollStateUserHasScrolled protected static Determines whether the user had scrolled through the ScrollableControl control. Inherited from ScrollableControl.
ScrollStateVScrollVisible protected static Determines whether the value of the VScroll property is set to true. Inherited from ScrollableControl.

Properties

Name Description
AccessibilityObject Gets the AccessibleObject assigned to the control. Inherited from Control.
AccessibleDefaultActionDescription Gets or sets the default action description of the control for use by accessibility client applications. Inherited from Control.
AccessibleDescription Gets or sets the description of the control used by accessibility client applications. Inherited from Control.
AccessibleName Gets or sets the name of the control used by accessibility client applications. Inherited from Control.
AccessibleRole Gets or sets the accessible role of the control. Inherited from Control.
ActiveControl Gets or sets the active control on the container control. Inherited from ContainerControl.
AllowDrop Gets or sets a value indicating whether the control can accept data that the user drags onto it. Inherited from Control.
Anchor Gets 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.
Appearance Gets the appearance settings used to paint the user control. Inherited from XtraUserControl.
AutoScaleDimensions Gets or sets the dimensions that the control was designed to. Inherited from ContainerControl.
AutoScaleFactor protected Gets the scaling factor between the current and design-time automatic scaling dimensions. Inherited from ContainerControl.
AutoScaleMode Gets or sets the automatic scaling mode of the control. Inherited from ContainerControl.
AutoScroll Gets 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.
AutoScrollMargin Gets or sets the size of the auto-scroll margin. Inherited from ScrollableControl.
AutoScrollMinSize Gets or sets the minimum size of the auto-scroll. Inherited from ScrollableControl.
AutoScrollOffset Gets or sets where this control is scrolled to in ScrollControlIntoView(Control). Inherited from Control.
AutoScrollPosition Gets or sets the location of the auto-scroll position. Inherited from ScrollableControl.
AutoSize This property is not relevant for this class. Inherited from UserControl.
AutoSizeMode Gets or sets how the control will resize itself. Inherited from UserControl.
AutoValidate Gets or sets how the control performs validation when the user changes focus to another control. Inherited from UserControl.
AutoZoom Specifies whether or not the auto-zoom mode is enabled for the print preview.
BackColor Specifies the background color of a DocumentViewer.
BackgroundImage Obsolete. This property is overridden and never used. To customize the DocumentViewer‘s background image, use custom skins.
BackgroundImageLayout Obsolete. This property is overridden and never used. To customize the DocumentViewer‘s background image and its layout, use custom skins.
BindingContext Gets or sets the BindingContext for the control. Inherited from ContainerControl.
BorderStyle Specifies the border style of the DocumentViewer.
Bottom Gets the distance, in pixels, between the bottom edge of the control and the top edge of its container’s client area. Inherited from Control.
Bounds Gets or sets the size and location of the control including its nonclient elements, in pixels, relative to the parent control. Inherited from Control.
CanEnableIme protected Gets a value indicating whether the ImeMode property can be set to an active value, to enable IME support. Inherited from ContainerControl.
CanFocus Gets a value indicating whether the control can receive focus. Inherited from Control.
CanRaiseEvents protected Determines if events can be raised on the control. Inherited from Control.
CanSelect Gets a value indicating whether the control can be selected. Inherited from Control.
Capture Gets or sets a value indicating whether the control has captured the mouse. Inherited from Control.
CausesValidation Gets 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 static Gets 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.
ClientRectangle Gets the rectangle that represents the client area of the control. Inherited from Control.
ClientSize Gets or sets the height and width of the client area of the control. Inherited from Control.
CompanyName Gets the name of the company or creator of the application containing the control. Inherited from Control.
Container Gets the IContainer that contains the Component. Inherited from Component.
ContainsFocus Gets a value indicating whether the control, or one of its child controls, currently has the input focus. Inherited from Control.
ContextMenu Gets or sets the shortcut menu associated with the control. Inherited from Control.
ContextMenuStrip Gets or sets the ContextMenuStrip associated with this control. Inherited from Control.
Continuous For internal use.
Controls Gets the collection of controls contained within the control. Inherited from Control.
Created Gets a value indicating whether the control has been created. Inherited from Control.
CurrentAutoScaleDimensions Gets the current run-time dimensions of the screen. Inherited from ContainerControl.
Cursor Gets or sets the cursor that is displayed when the mouse pointer is over the control. Inherited from Control.
DataBindings Gets the data bindings for the control. Inherited from Control.
DefaultBackColor static Gets the default background color of the control. Inherited from Control.
DefaultCursor protected Gets or sets the default cursor for the control. Inherited from Control.
DefaultFont static Gets the default font of the control. Inherited from Control.
DefaultForeColor static Gets the default foreground color of the control. Inherited from Control.
DefaultImeMode protected Gets the default Input Method Editor (IME) mode supported by the control. Inherited from Control.
DefaultMargin protected Gets the space, in pixels, that is specified by default between controls. Inherited from Control.
DefaultMaximumSize protected Gets the length and height, in pixels, that is specified as the default maximum size of a control. Inherited from Control.
DefaultMinimumSize protected Gets the length and height, in pixels, that is specified as the default minimum size of a control. Inherited from Control.
DefaultPadding protected Gets the internal spacing, in pixels, of the contents of a control. Inherited from Control.
DefaultSize protected Gets the default size of the control. Inherited from UserControl.
DesignMode For internal use.
DisplayRectangle Gets the rectangle that represents the virtual display area of the control. Inherited from ScrollableControl.
Disposing Gets a value indicating whether the base Control class is in the process of disposing. Inherited from Control.
Dock Gets or sets which control borders are docked to its parent control and determines how a control is resized with its parent. Inherited from Control.
DockPadding Gets the dock padding settings for all edges of the control. Inherited from ScrollableControl.
Document Specifies the document assigned to the DocumentViewer.
DocumentIsCreating For internal use.
DocumentIsEmpty Specifies whether or not the current document is empty.
DoubleBuffered protected Gets or sets a value indicating whether this control should redraw its surface using a secondary buffer to reduce or prevent flicker. Inherited from Control.
Enabled Gets or sets a value indicating whether the control can respond to user interaction. Inherited from Control.
EnableIXtraResizeableControlInterfaceProxy This member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from XtraUserControl.
EnableSmoothScrolling Specifies whether to enable smooth scrolling in the Document Viewer control.
Events protected Gets the list of event handlers that are attached to this Component. Inherited from Component.
Focused Gets a value indicating whether the control has input focus. Inherited from Control.
Font Gets or sets font settings applied to the control. Inherited from XtraUserControl.
FontHeight protected Gets or sets the height of the font of the control. Inherited from Control.
ForeColor Specifies the foreground color of the DocumentViewer.
Handle Gets the window handle that the control is bound to. Inherited from Control.
HandTool For internal use.
HasChildren Gets a value indicating whether the control contains one or more child controls. Inherited from Control.
Height Gets or sets the height of the control. Inherited from Control.
HorizontalScroll Gets the characteristics associated with the horizontal scroll bar. Inherited from ScrollableControl.
HScroll protected Gets or sets a value indicating whether the horizontal scroll bar is visible. Inherited from ScrollableControl.
ImeMode Gets or sets the Input Method Editor (IME) mode of the control. Inherited from Control.
ImeModeBase protected Gets or sets the IME mode of a control. Inherited from Control.
InvokeRequired Gets 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.
IsAccessible Gets or sets a value indicating whether the control is visible to accessibility applications. Inherited from Control.
IsDisposed Gets a value indicating whether the control has been disposed of. Inherited from Control.
IsHandleCreated Gets a value indicating whether the control has a handle associated with it. Inherited from Control.
IsMetric Gets or sets a value indicating whether or not to use the metric system for measurements in the print preview.
IsMirrored Gets a value indicating whether the control is mirrored. Inherited from Control.
LayoutEngine Gets a cached instance of the control’s layout engine. Inherited from Control.
Left Gets 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.
Location Gets or sets the coordinates of the upper-left corner of the control relative to the upper-left corner of its container. Inherited from Control.
LookAndFeel Contains settings that specify the look and feel of the current XtraUserControl and all DevExpress controls placed on it. Inherited from XtraUserControl.
Margin Gets or sets the space between controls. Inherited from Control.
Margins For internal use.
MaximumSize Gets or sets the size that is the upper limit that GetPreferredSize(Size) can specify. Inherited from Control.
MaxPageColumns Gets the maximum number of columns for multi-page reports displayed within the DocumentViewer.
MaxPageRows Gets the maximum number of rows for a multi-page report displayed within the DocumentViewer.
MaxZoom Gets the maximum zoom factor of a report page within the DocumentViewer.
MinimumSize Gets or sets the size that is the lower limit that GetPreferredSize(Size) can specify. Inherited from Control.
MinZoom Gets the minimum zoom factor of a report page within the DocumentViewer.
ModifierKeys static Gets a value indicating which of the modifier keys (SHIFT, CTRL, and ALT) is in a pressed state. Inherited from Control.
MouseButtons static Gets a value indicating which of the mouse buttons is in a pressed state. Inherited from Control.
MousePosition static Gets the position of the mouse cursor in screen coordinates. Inherited from Control.
Name Gets or sets the name of the control. Inherited from Control.
Padding Gets or sets padding within the control. Inherited from Control.
PageBorderColor Specifies the color used to draw borders around all pages in the DocumentViewer.
PageBorderVisibility Specifies whether or not borders should be painted around all and selected document pages in the DocumentViewer.
PageBorderWidth Specifies the width of the borders around all pages in the DocumentViewer.
Parent Gets or sets the parent container of the control. Inherited from Control.
ParentForm Gets the form that the container control is assigned to. Inherited from ContainerControl.
PopupForm For internal use.
PreferredSize Gets the size of a rectangular area into which the control can fit. Inherited from Control.
ProductName Gets the product name of the assembly containing the control. Inherited from Control.
ProductVersion Gets the version of the assembly containing the control. Inherited from Control.
PropagatingImeMode protected static Gets an object that represents a propagating IME mode. Inherited from Control.
RecreatingHandle Gets a value indicating whether the control is currently re-creating its handle. Inherited from Control.
Region Gets or sets the window region associated with the control. Inherited from Control.
RenderRightToLeft protected This property is now obsolete. Inherited from Control.
ResizeRedraw protected Gets or sets a value indicating whether the control redraws itself when resized. Inherited from Control.
Right Gets the distance, in pixels, between the right edge of the control and the left edge of its container’s client area. Inherited from Control.
RightToLeft Gets or sets a value indicating whether control’s elements are aligned to support locales using right-to-left fonts. Inherited from Control.
SelectedPage Obtains the currently selected report page.
SelectedPageBorderColor Specifies the color of borders around the currently selected page in the DocumentViewer.
SelectedPageBorderWidth Specifies the width of the borders around the currently selected page in the DocumentViewer.
SelectedPageIndex Specifies the index of a currently selected page in the DocumentViewer.
ShowFocusCues protected Gets a value indicating whether the control should display focus rectangles. Inherited from Control.
ShowKeyboardCues protected Gets a value indicating whether the user interface is in the appropriate state to show or hide keyboard accelerators. Inherited from Control.
ShowPageMargins Specifies whether or not the DocumentViewer shows page margin lines.
ShowToolTips Specifies whether or not to display hints in the DocumentViewer.
Site Gets or sets the site of the XtraUserControl. Inherited from XtraUserControl.
Size Gets or sets the height and width of the control. Inherited from Control.
Status Specifies whether or not the current document is empty or null.
TabIndex Gets or sets the tab order of the control within its container. Inherited from Control.
TabStop Gets or sets a value indicating whether the user can give the focus to this control using the TAB key. Inherited from Control.
Tag Gets or sets the object that contains data about the control. Inherited from Control.
Text Gets or sets the text associated with this control. Inherited from UserControl.
TooltipBackColor Specifies the background color of all tooltips in the DocumentViewer.
TooltipFont Specifies the font of all tooltips in the DocumentViewer.
TooltipForeColor Specifies the foreground color of all tooltips in the DocumentViewer.
Top Gets 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.
TopLevelControl Gets 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.
UseDirectXPaint Specifies whether the Document Viewer control uses the DirectX Hardware Acceleration.
UseWaitCursor Gets or sets a value indicating whether to use the wait cursor for the current control and all child controls. Inherited from Control.
VerticalScroll Gets the characteristics associated with the vertical scroll bar. Inherited from ScrollableControl.
ViewColumns For internal use.
ViewControl For internal use.
ViewManager For internal use.
ViewRows For internal use.
Visible Gets or sets a value indicating whether the control and all its child controls are displayed. Inherited from Control.
VScroll protected Gets or sets a value indicating whether the vertical scroll bar is visible. Inherited from ScrollableControl.
Width Gets or sets the width of the control. Inherited from Control.
WindowTarget This property is not relevant for this class. Inherited from Control.
Zoom Specifies the current zoom factor of a document page in the DocumentViewer.

Methods

Name Description
AccessibilityNotifyClients(AccessibleEvents, Int32, Int32) protected Notifies the accessibility client applications of the specified AccessibleEvents for the specified child control . Inherited from Control.
AccessibilityNotifyClients(AccessibleEvents, Int32) protected Notifies the accessibility client applications of the specified AccessibleEvents for the specified child control. Inherited from Control.
AdjustFormScrollbars(Boolean) protected Adjusts the scroll bars on the container based on the current control positions and the control currently selected. Inherited from ContainerControl.
BeginInvoke(Delegate, Object[]) Executes the specified delegate asynchronously with the specified arguments, on the thread that the control’s underlying handle was created on. Inherited from Control.
BeginInvoke(Delegate) Executes the specified delegate asynchronously on the thread that the control’s underlying handle was created on. Inherited from Control.
BringToFront() Brings the control to the front of the z-order. Inherited from Control.
Contains(Control) Retrieves a value indicating whether the specified control is a child of the control. Inherited from Control.
CreateControl() Forces the creation of the visible control, including the creation of the handle and any visible child controls. Inherited from Control.
CreateControlsInstance() protected Creates a new instance of the control collection for the control. Inherited from Control.
CreateGraphics() Creates the Graphics for the control. Inherited from Control.
CreateHandle() protected Creates a handle for the control. Inherited from Control.
CreateObjRef(Type) Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. Inherited from MarshalByRefObject.
DefWndProc(Message) protected Sends the specified message to the default window procedure. Inherited from Control.
DestroyHandle() protected Destroys the handle associated with the control. Inherited from Control.
Dispose() Releases all resources used by the Component. Inherited from Component.
DoDragDrop(Object, DragDropEffects) Begins a drag-and-drop operation. Inherited from Control.
DrawToBitmap(Bitmap, Rectangle) Supports rendering to the specified bitmap. Inherited from Control.
EndInvoke(IAsyncResult) Retrieves the return value of the asynchronous operation represented by the IAsyncResult passed. Inherited from Control.
Equals(Object, Object) static Determines whether the specified object instances are considered equal. Inherited from Object.
Equals(Object) Determines whether the specified object is equal to the current object. Inherited from Object.
FindForm() Retrieves the form that the control is on. Inherited from Control.
Focus() Sets input focus to the control. Inherited from Control.
FromChildHandle(IntPtr) static Retrieves the control that contains the specified handle. Inherited from Control.
FromHandle(IntPtr) static Returns the control that is currently associated with the specified handle. Inherited from Control.
GetAccessibilityObjectById(Int32) protected Retrieves the specified AccessibleObject. Inherited from Control.
GetAutoSizeMode() protected Retrieves a value indicating how a control will behave when its AutoSize property is enabled. Inherited from Control.
GetChildAtPoint(Point, GetChildAtPointSkip) Retrieves the child control that is located at the specified coordinates, specifying whether to ignore child controls of a certain type. Inherited from Control.
GetChildAtPoint(Point) Retrieves the child control that is located at the specified coordinates. Inherited from Control.
GetContainerControl() Returns the next ContainerControl up the control’s chain of parent controls. Inherited from Control.
GetHashCode() Serves as the default hash function. Inherited from Object.
GetLifetimeService() Retrieves the current lifetime service object that controls the lifetime policy for this instance. Inherited from MarshalByRefObject.
GetNextControl(Control, Boolean) Retrieves the next control forward or back in the tab order of child controls. Inherited from Control.
GetPreferredSize(Size) Retrieves the size of a rectangular area into which a control can be fitted. Inherited from Control.
GetScaledBounds(Rectangle, SizeF, BoundsSpecified) protected Retrieves the bounds within which the control is scaled. Inherited from Control.
GetScrollState(Int32) protected Determines whether the specified flag has been set. Inherited from ScrollableControl.
GetService(Type) protected Returns an object that represents a service provided by the Component or by its Container. Inherited from Component.
GetStyle(ControlStyles) protected Retrieves the value of the specified control style bit for the control. Inherited from Control.
GetTopLevel() protected Determines if the control is a top-level control. Inherited from Control.
GetType() Gets the Type of the current instance. Inherited from Object.
Hide() Conceals the control from the user. Inherited from Control.
InitializeLifetimeService() Obtains a lifetime service object to control the lifetime policy for this instance. Inherited from MarshalByRefObject.
InitLayout() protected Called after the control has been added to another container. Inherited from Control.
Invalidate() Invalidates the entire surface of the control and causes the control to be redrawn. Inherited from Control.
Invalidate(Boolean) Invalidates a specific region of the control and causes a paint message to be sent to the control. Optionally, invalidates the child controls assigned to the control. Inherited from Control.
Invalidate(Rectangle, Boolean) Invalidates the specified region of the control (adds it to the control’s update region, which is the area that will be repainted at the next paint operation), and causes a paint message to be sent to the control. Optionally, invalidates the child controls assigned to the control. Inherited from Control.
Invalidate(Rectangle) Invalidates the specified region of the control (adds it to the control’s update region, which is the area that will be repainted at the next paint operation), and causes a paint message to be sent to the control. Inherited from Control.
Invalidate(Region, Boolean) Invalidates the specified region of the control (adds it to the control’s update region, which is the area that will be repainted at the next paint operation), and causes a paint message to be sent to the control. Optionally, invalidates the child controls assigned to the control. Inherited from Control.
Invalidate(Region) Invalidates the specified region of the control (adds it to the control’s update region, which is the area that will be repainted at the next paint operation), and causes a paint message to be sent to the control. Inherited from Control.
Invoke(Delegate, Object[]) Executes the specified delegate, on the thread that owns the control’s underlying window handle, with the specified list of arguments. Inherited from Control.
Invoke(Delegate) Executes the specified delegate on the thread that owns the control’s underlying window handle. Inherited from Control.
InvokeGotFocus(Control, EventArgs) protected Raises the GotFocus event for the specified control. Inherited from Control.
InvokeLostFocus(Control, EventArgs) protected Raises the LostFocus event for the specified control. Inherited from Control.
InvokeOnClick(Control, EventArgs) protected Raises the Click event for the specified control. Inherited from Control.
InvokePaint(Control, PaintEventArgs) protected Raises the Paint event for the specified control. Inherited from Control.
InvokePaintBackground(Control, PaintEventArgs) protected Raises the PaintBackground event for the specified control. Inherited from Control.
IsInputChar(Char) protected Determines if a character is an input character that the control recognizes. Inherited from Control.
IsInputKey(Keys) protected Determines whether the specified key is a regular input key or a special key that requires preprocessing. Inherited from Control.
IsKeyLocked(Keys) static Determines whether the CAPS LOCK, NUM LOCK, or SCROLL LOCK key is in effect. Inherited from Control.
IsMnemonic(Char, String) static Determines if the specified character is the mnemonic character assigned to the control in the specified string. Inherited from Control.
MemberwiseClone() protected Creates a shallow copy of the current Object. Inherited from Object.
MemberwiseClone(Boolean) protected Creates a shallow copy of the current MarshalByRefObject object. Inherited from MarshalByRefObject.
NotifyInvalidate(Rectangle) protected Raises the Invalidated event with a specified region of the control to invalidate. Inherited from Control.
OnAutoSizeChanged(EventArgs) protected Raises the AutoSizeChanged event. Inherited from Control.
OnAutoValidateChanged(EventArgs) protected Raises the AutoValidateChanged event. Inherited from ContainerControl.
OnBindingContextChanged(EventArgs) protected Raises the BindingContextChanged event. Inherited from Control.
OnCausesValidationChanged(EventArgs) protected Raises the CausesValidationChanged event. Inherited from Control.
OnChangeUICues(UICuesEventArgs) protected Raises the ChangeUICues event. Inherited from Control.
OnClick(EventArgs) protected Raises the Click event. Inherited from Control.
OnClientSizeChanged(EventArgs) protected Raises the ClientSizeChanged event. Inherited from Control.
OnContextMenuChanged(EventArgs) protected Raises the ContextMenuChanged event. Inherited from Control.
OnContextMenuStripChanged(EventArgs) protected Raises the ContextMenuStripChanged event. Inherited from Control.
OnCreateControl() protected Raises the CreateControl event. Inherited from UserControl.
OnCursorChanged(EventArgs) protected Raises the CursorChanged event. Inherited from Control.
OnDockChanged(EventArgs) protected Raises the DockChanged event. Inherited from Control.
OnDoubleClick(EventArgs) protected Raises the DoubleClick event. Inherited from Control.
OnDragDrop(DragEventArgs) protected Raises the DragDrop event. Inherited from Control.
OnDragEnter(DragEventArgs) protected Raises the DragEnter event. Inherited from Control.
OnDragLeave(EventArgs) protected Raises the DragLeave event. Inherited from Control.
OnDragOver(DragEventArgs) protected Raises the DragOver event. Inherited from Control.
OnEnabledChanged(EventArgs) protected Raises the EnabledChanged event. Inherited from Control.
OnEnter(EventArgs) protected Raises the Enter event. Inherited from Control.
OnFontChanged(EventArgs) protected Raises the FontChanged event. Inherited from ContainerControl.
OnGiveFeedback(GiveFeedbackEventArgs) protected Raises the GiveFeedback event. Inherited from Control.
OnHelpRequested(HelpEventArgs) protected Raises the HelpRequested event. Inherited from Control.
OnImeModeChanged(EventArgs) protected Raises the ImeModeChanged event. Inherited from Control.
OnInvalidated(InvalidateEventArgs) protected Raises the Invalidated event. Inherited from Control.
OnKeyDown(KeyEventArgs) protected Raises the KeyDown event. Inherited from Control.
OnKeyPress(KeyPressEventArgs) protected Raises the KeyPress event. Inherited from Control.
OnKeyUp(KeyEventArgs) protected Raises the KeyUp event. Inherited from Control.
OnLayout(LayoutEventArgs) protected Raises the Layout event. Inherited from ContainerControl.
OnLeave(EventArgs) protected Raises the Leave event. Inherited from Control.
OnLocationChanged(EventArgs) protected Raises the LocationChanged event. Inherited from Control.
OnLostFocus(EventArgs) protected Raises the LostFocus event. Inherited from Control.
OnMarginChanged(EventArgs) protected Raises the MarginChanged event. Inherited from Control.
OnMouseCaptureChanged(EventArgs) protected Raises the MouseCaptureChanged event. Inherited from Control.
OnMouseClick(MouseEventArgs) protected Raises the MouseClick event. Inherited from Control.
OnMouseDoubleClick(MouseEventArgs) protected Raises the MouseDoubleClick event. Inherited from Control.
OnMouseDown(MouseEventArgs) protected Raises the MouseDown event. Inherited from UserControl.
OnMouseEnter(EventArgs) protected Raises the MouseEnter event. Inherited from Control.
OnMouseHover(EventArgs) protected Raises the MouseHover event. Inherited from Control.
OnMouseLeave(EventArgs) protected Raises the MouseLeave event. Inherited from Control.
OnMouseUp(MouseEventArgs) protected Raises the MouseUp event. Inherited from Control.
OnMouseWheel(MouseEventArgs) protected Raises the MouseWheel event. Inherited from ScrollableControl.
OnMove(EventArgs) protected Raises the Move event. Inherited from Control.
OnNotifyMessage(Message) protected Notifies the control of Windows messages. Inherited from Control.
OnPaddingChanged(EventArgs) protected Raises the PaddingChanged event. Inherited from ScrollableControl.
OnPaintBackground(PaintEventArgs) protected Paints the background of the control. Inherited from ScrollableControl.
OnParentBackColorChanged(EventArgs) protected Raises the BackColorChanged event when the BackColor property value of the control’s container changes. Inherited from Control.
OnParentBackgroundImageChanged(EventArgs) protected Raises the BackgroundImageChanged event when the BackgroundImage property value of the control’s container changes. Inherited from Control.
OnParentBindingContextChanged(EventArgs) protected Raises the BindingContextChanged event when the BindingContext property value of the control’s container changes. Inherited from Control.
OnParentCursorChanged(EventArgs) protected Raises the CursorChanged event. Inherited from Control.
OnParentEnabledChanged(EventArgs) protected Raises the EnabledChanged event when the Enabled property value of the control’s container changes. Inherited from Control.
OnParentFontChanged(EventArgs) protected Raises the FontChanged event when the Font property value of the control’s container changes. Inherited from Control.
OnParentForeColorChanged(EventArgs) protected Raises the ForeColorChanged event when the ForeColor property value of the control’s container changes. Inherited from Control.
OnParentRightToLeftChanged(EventArgs) protected Raises the RightToLeftChanged event when the RightToLeft property value of the control’s container changes. Inherited from Control.
OnParentVisibleChanged(EventArgs) protected Raises the VisibleChanged event when the Visible property value of the control’s container changes. Inherited from Control.
OnPreviewKeyDown(PreviewKeyDownEventArgs) protected Raises the PreviewKeyDown event. Inherited from Control.
OnPrint(PaintEventArgs) protected Raises the Paint event. Inherited from Control.
OnQueryContinueDrag(QueryContinueDragEventArgs) protected Raises the QueryContinueDrag event. Inherited from Control.
OnRegionChanged(EventArgs) protected Raises the RegionChanged event. Inherited from Control.
OnResize(EventArgs) protected Raises the Resize event. Inherited from UserControl.
OnRightToLeftChanged(EventArgs) protected Raises the RightToLeftChanged event. Inherited from ScrollableControl.
OnScroll(ScrollEventArgs) protected Raises the Scroll event. Inherited from ScrollableControl.
OnStyleChanged(EventArgs) protected Raises the StyleChanged event. Inherited from Control.
OnSystemColorsChanged(EventArgs) protected Raises the SystemColorsChanged event. Inherited from Control.
OnTabIndexChanged(EventArgs) protected Raises the TabIndexChanged event. Inherited from Control.
OnTabStopChanged(EventArgs) protected Raises the TabStopChanged event. Inherited from Control.
OnTextChanged(EventArgs) protected Raises the TextChanged event. Inherited from Control.
OnValidated(EventArgs) protected Raises the Validated event. Inherited from Control.
OnValidating(CancelEventArgs) protected Raises the Validating event. Inherited from Control.
OnVisibleChanged(EventArgs) protected Raises the VisibleChanged event. Inherited from ScrollableControl.
PerformAutoScale() Performs scaling of the container control and its children. Inherited from ContainerControl.
PerformLayout() Forces the control to apply layout logic to all its child controls. Inherited from Control.
PerformLayout(Control, String) Forces the control to apply layout logic to all its child controls. Inherited from Control.
PointToClient(Point) Computes the location of the specified screen point into client coordinates. Inherited from Control.
PointToScreen(Point) Computes the location of the specified client point into screen coordinates. Inherited from Control.
PreProcessControlMessage(Message) Preprocesses keyboard or input messages within the message loop before they are dispatched. Inherited from Control.
PreProcessMessage(Message) Preprocesses keyboard or input messages within the message loop before they are dispatched. Inherited from Control.
ProcessCmdKey(Message, Keys) protected Processes a command key. Inherited from ContainerControl.
ProcessDialogChar(Char) protected Processes a dialog character. Inherited from ContainerControl.
ProcessKeyEventArgs(Message) protected Processes a key message and generates the appropriate control events. Inherited from Control.
ProcessKeyMessage(Message) protected Processes a keyboard message. Inherited from Control.
ProcessKeyPreview(Message) protected Previews a keyboard message. Inherited from Control.
ProcessMnemonic(Char) protected Processes a mnemonic character. Inherited from ContainerControl.
ProcessTabKey(Boolean) protected Selects the next available control and makes it the active control. Inherited from ContainerControl.
RaiseDragEvent(Object, DragEventArgs) protected Raises the appropriate drag event. Inherited from Control.
RaiseKeyEvent(Object, KeyEventArgs) protected Raises the appropriate key event. Inherited from Control.
RaiseMouseEvent(Object, MouseEventArgs) protected Raises the appropriate mouse event. Inherited from Control.
RaisePaintEvent(Object, PaintEventArgs) protected Raises the appropriate paint event. Inherited from Control.
RecreateHandle() protected Forces the re-creation of the handle for the control. Inherited from Control.
RectangleToClient(Rectangle) Computes the size and location of the specified screen rectangle in client coordinates. Inherited from Control.
RectangleToScreen(Rectangle) Computes the size and location of the specified client rectangle in screen coordinates. Inherited from Control.
ReferenceEquals(Object, Object) static Determines whether the specified Object instances are the same instance. Inherited from Object.
ReflectMessage(IntPtr, Message) protected static Reflects the specified message to the control that is bound to the specified handle. Inherited from Control.
Refresh() Forces the control to invalidate its client area and immediately redraw itself and any child controls. Inherited from Control.
ResetBackColor() Sets the DocumentViewerBase.BackColor property to Empty.
ResetBindings() Causes a control bound to the BindingSource to reread all the items in the list and refresh their displayed values. Inherited from Control.
ResetCursor() Resets the Cursor property to its default value. Inherited from Control.
ResetFont() Resets the Font property to its default value. Inherited from Control.
ResetForeColor() Sets the DocumentViewerBase.ForeColor property to Empty.
ResetImeMode() Resets the ImeMode property to its default value. Inherited from Control.
ResetMouseEventArgs() protected Resets the control to handle the MouseLeave event. Inherited from Control.
ResetRightToLeft() Resets the RightToLeft property to its default value. Inherited from Control.
ResetText() Resets the Text property to its default value (Empty). Inherited from Control.
ResumeLayout() Resumes usual layout logic. Inherited from Control.
ResumeLayout(Boolean) Resumes usual layout logic, optionally forcing an immediate layout of pending layout requests. Inherited from Control.
RtlTranslateAlignment(ContentAlignment) protected Converts the specified ContentAlignment to the appropriate ContentAlignment to support right-to-left text. Inherited from Control.
RtlTranslateAlignment(HorizontalAlignment) protected Converts the specified HorizontalAlignment to the appropriate HorizontalAlignment to support right-to-left text. Inherited from Control.
RtlTranslateAlignment(LeftRightAlignment) protected Converts the specified LeftRightAlignment to the appropriate LeftRightAlignment to support right-to-left text. Inherited from Control.
RtlTranslateContent(ContentAlignment) protected Converts the specified ContentAlignment to the appropriate ContentAlignment to support right-to-left text. Inherited from Control.
RtlTranslateHorizontal(HorizontalAlignment) protected Converts the specified HorizontalAlignment to the appropriate HorizontalAlignment to support right-to-left text. Inherited from Control.
RtlTranslateLeftRight(LeftRightAlignment) protected Converts the specified LeftRightAlignment to the appropriate LeftRightAlignment to support right-to-left text. Inherited from Control.
Scale(SizeF) Scales the control and all child controls by the specified scaling factor. Inherited from Control.
Scale(Single, Single) Scales the entire control and any child controls. Inherited from Control.
Scale(Single) Scales the control and any child controls. Inherited from Control.
ScaleCore(Single, Single) protected This method is not relevant for this class. Inherited from ScrollableControl.
ScrollControlIntoView(Control) Scrolls the specified child control into view on an auto-scroll enabled control. Inherited from ScrollableControl.
ScrollPageDown() Scrolls one page down.
ScrollPageUp() Scrolls one page up.
ScrollToControl(Control) protected Calculates the scroll offset to the specified child control. Inherited from ScrollableControl.
Select() Activates the control. Inherited from Control.
Select(Boolean, Boolean) protected Activates a child control. Optionally specifies the direction in the tab order to select the control from. Inherited from ContainerControl.
SelectFirstPage() Moves selection to the first page of a document in the DocumentViewer.
SelectLastPage() Moves selection to the last page of a document in the DocumentViewer.
SelectNextControl(Control, Boolean, Boolean, Boolean, Boolean) Activates the next control. Inherited from Control.
SelectNextPage() Moves selection to the next page of a document in the DocumentViewer.
SelectPrevPage() Moves selection to the previous page of a document in the DocumentViewer.
SendToBack() Sends the control to the back of the z-order. Inherited from Control.
SetAutoScrollMargin(Int32, Int32) Sets the size of the auto-scroll margins. Inherited from ScrollableControl.
SetAutoSizeMode(AutoSizeMode) protected Sets a value indicating how a control will behave when its AutoSize property is enabled. Inherited from Control.
SetBounds(Int32, Int32, Int32, Int32, BoundsSpecified) Sets the specified bounds of the control to the specified location and size. Inherited from Control.
SetBounds(Int32, Int32, Int32, Int32) Sets the bounds of the control to the specified location and size. Inherited from Control.
SetClientSizeCore(Int32, Int32) protected Sets the size of the client area of the control. Inherited from Control.
SetCursor(Cursor) Sets the cursor kind to be used within the DocumentViewer.
SetDisplayRectLocation(Int32, Int32) protected Positions the display window to the specified value. Inherited from ScrollableControl.
SetFocus() Sets the input focus to the current instance of DocumentViewer.
SetPageView(PageViewModes) Determines the number of columns and rows used to display pages of a multipage report within a Print Preview.
SetPageView(Int32, Int32) Determines the number of columns and rows used to display pages of a multipage report within a Print Preview.
SetScrollState(Int32, Boolean) protected Sets the specified scroll state flag. Inherited from ScrollableControl.
SetStyle(ControlStyles, Boolean) protected Sets a specified ControlStyles flag to either true or false. Inherited from Control.
SetTopLevel(Boolean) protected Sets the control as the top-level control. Inherited from Control.
Show() Displays the control to the user. Inherited from Control.
ShowPage(IPage) Shows the specified page in the Document Viewer.
SizeFromClientSize(Size) protected Determines the size of the entire control from the height and width of its client area. Inherited from Control.
SuspendLayout() Temporarily suspends the layout logic for the control. Inherited from Control.
IContainerControl.ActivateControl(Control) Activates the specified control. Inherited from ContainerControl.
IDropTarget.OnDragDrop(DragEventArgs) Raises the DragDrop event. Inherited from Control.
IDropTarget.OnDragEnter(DragEventArgs) Raises the DragEnter event. Inherited from Control.
IDropTarget.OnDragLeave(EventArgs) Raises the DragLeave event. Inherited from Control.
IDropTarget.OnDragOver(DragEventArgs) Raises the DragOver event. Inherited from Control.
ToString() Returns a String containing the name of the Component, if any. This method should not be overridden. Inherited from Component.
Update() Causes the control to redraw the invalidated regions within its client area. Inherited from Control.
UpdateBounds() protected Updates the bounds of the control with the current size and location. Inherited from Control.
UpdateBounds(Int32, Int32, Int32, Int32, Int32, Int32) protected Updates the bounds of the control with the specified size, location, and client size. Inherited from Control.
UpdateBounds(Int32, Int32, Int32, Int32) protected Updates the bounds of the control with the specified size and location. Inherited from Control.
UpdateDefaultButton() protected When overridden by a derived class, updates which button is the default button. Inherited from ContainerControl.
UpdatePageView() For internal use. Redraws the current page view in the DocumentViewer.
UpdateScrollBars() Redraws the control’s scroll bars.
UpdateStyles() protected Forces the assigned styles to be reapplied to the control. Inherited from Control.
UpdateZOrder() protected Updates the control in its parent’s z-order. Inherited from Control.
Validate() Verifies the value of the control losing focus by causing the Validating and Validated events to occur, in that order. Inherited from ContainerControl.
Validate(Boolean) Verifies the value of the control that is losing focus; conditionally dependent on whether automatic validation is turned on. Inherited from ContainerControl.
ValidateChildren() Causes all of the child controls within a control that support validation to validate their data. Inherited from UserControl.
ValidateChildren(ValidationConstraints) Causes all of the child controls within a control that support validation to validate their data. Inherited from UserControl.
ViewWholePage() Allows you to show the currently displayed page in full.
ZoomIn() Zooms in on the page currently displayed in the DocumentViewer.
ZoomOut() Zooms out the page currently displayed in the DocumentViewer.

Events

Name Description
AutoSizeChanged Occurs when the AutoSize property changes. Inherited from UserControl.
AutoValidateChanged Occurs when the AutoValidate property changes. Inherited from UserControl.
BackColorChanged Occurs when the value of the BackColor property changes. Inherited from Control.
BackgroundImageChanged Hides the BackgroundImageChanged event of the base class.
BackgroundImageLayoutChanged Hides the BackgroundImageLayoutChanged event of the base class.
BindingContextChanged Occurs when the value of the BindingContext property changes. Inherited from Control.
CausesValidationChanged Occurs when the value of the CausesValidation property changes. Inherited from Control.
ChangeUICues Occurs when the focus or keyboard user interface (UI) cues change. Inherited from Control.
Click Occurs when the control is clicked. Inherited from Control.
ClientSizeChanged Occurs when the value of the ClientSize property changes. Inherited from Control.
ContextMenuChanged Occurs when the value of the ContextMenu property changes. Inherited from Control.
ContextMenuStripChanged Occurs when the value of the ContextMenuStrip property changes. Inherited from Control.
ControlAdded Occurs when a new control is added to the Control.ControlCollection. Inherited from Control.
ControlRemoved Occurs when a control is removed from the Control.ControlCollection. Inherited from Control.
CursorChanged Occurs when the value of the Cursor property changes. Inherited from Control.
Disposed Occurs when the component is disposed by a call to the Dispose() method. Inherited from Component.
DockChanged Occurs when the value of the Dock property changes. Inherited from Control.
DocumentChanged Occurs when a DocumentViewer receives a document change notification.
DoubleClick Occurs when the control is double-clicked. Inherited from Control.
DragDrop Occurs when a drag-and-drop operation is completed. Inherited from Control.
DragEnter Occurs when an object is dragged into the control’s bounds. Inherited from Control.
DragLeave Occurs when an object is dragged out of the control’s bounds. Inherited from Control.
DragOver Occurs when an object is dragged over the control’s bounds. Inherited from Control.
EnabledChanged Occurs when the Enabled property value has changed. Inherited from Control.
Enter Occurs when the control is entered. Inherited from Control.
FontChanged Occurs when the Font property value changes. Inherited from Control.
ForeColorChanged Occurs when the ForeColor property value changes. Inherited from Control.
GiveFeedback Occurs during a drag operation. Inherited from Control.
GotFocus Occurs when the control receives focus. Inherited from Control.
HandleCreated Occurs when a handle is created for the control. Inherited from Control.
HandleDestroyed Occurs when the control’s handle is in the process of being destroyed. Inherited from Control.
HelpRequested Occurs when the user requests help for a control. Inherited from Control.
ImeModeChanged Occurs when the ImeMode property has changed. Inherited from Control.
Invalidated Occurs when a control’s display requires redrawing. Inherited from Control.
KeyDown Occurs when a key is pressed while the control has focus. Inherited from Control.
KeyPress Occurs when a character. space or backspace key is pressed while the control has focus. Inherited from Control.
KeyUp Occurs when a key is released while the control has focus. Inherited from Control.
Layout Occurs when a control should reposition its child controls. Inherited from Control.
Leave Occurs when the input focus leaves the control. Inherited from Control.
Load Occurs before the control becomes visible for the first time. Inherited from UserControl.
LocationChanged Occurs when the Location property value has changed. Inherited from Control.
LostFocus Occurs when the control loses focus. Inherited from Control.
MarginChanged Occurs when the control’s margin changes. Inherited from Control.
MouseCaptureChanged Occurs when the control loses mouse capture. Inherited from Control.
MouseClick Occurs when the control is clicked by the mouse. Inherited from Control.
MouseDoubleClick Occurs when the control is double clicked by the mouse. Inherited from Control.
MouseDown Occurs when the mouse pointer is over the control and a mouse button is pressed. Inherited from Control.
MouseEnter Occurs when the mouse pointer enters the control. Inherited from Control.
MouseHover Occurs when the mouse pointer rests on the control. Inherited from Control.
MouseLeave Occurs when the mouse pointer leaves the control. Inherited from Control.
MouseMove Occurs when the mouse pointer is moved over the control. Inherited from Control.
MouseUp Occurs when the mouse pointer is over the control and a mouse button is released. Inherited from Control.
MouseWheel Occurs when the mouse wheel moves while the control has focus. Inherited from Control.
Move Occurs when the control is moved. Inherited from Control.
PaddingChanged Occurs when the control’s padding changes. Inherited from Control.
Paint Occurs when the control is redrawn. Inherited from Control.
PaintEx A DirectX-compatible event that replaces the standard Control.Paint event. Occurs when the control is redrawn. Inherited from XtraUserControl.
ParentChanged Occurs when the Parent property value changes. Inherited from Control.
PreviewKeyDown Occurs before the KeyDown event when a key is pressed while focus is on this control. Inherited from Control.
QueryAccessibilityHelp Occurs when AccessibleObject is providing help to accessibility applications. Inherited from Control.
QueryContinueDrag Occurs during a drag-and-drop operation and enables the drag source to determine whether the drag-and-drop operation should be canceled. Inherited from Control.
RegionChanged Occurs when the value of the Region property changes. Inherited from Control.
Resize Occurs when the control is resized. Inherited from Control.
RightToLeftChanged Occurs when the RightToLeft property value changes. Inherited from Control.
Scroll Occurs when the user or code scrolls through the client area. Inherited from ScrollableControl.
SelectedPageChanged Occurs when the selected page within the print preview is changed.
SizeChanged Occurs when the Size property value changes. Inherited from Control.
StyleChanged Occurs when the control style changes. Inherited from Control.
SystemColorsChanged Occurs when the system colors change. Inherited from Control.
TabIndexChanged Occurs when the TabIndex property value changes. Inherited from Control.
TabStopChanged Occurs when the TabStop property value changes. Inherited from Control.
TextChanged Raises the TextChanged event. Inherited from UserControl.
Validated Occurs when the control is finished validating. Inherited from Control.
Validating Occurs when the control is validating. Inherited from Control.
VisibleChanged Occurs when the Visible property value changes. Inherited from Control.
ZoomChanged Occurs after the document current zoom factor has changed.
See Also