Click or drag to resize

DocumentViewer Class

The DocumentViewer control simplifies the process of synchronizing a ThumbnailView with a ImageViewer.

The control's ThumbnailView can be docked on any side using the ThumbnailDockStyle property. A SeparatorProperties can be enabled, allowing the end user to resize the ThumbnailView and the ImageViewer will fill the rest of the control.

Synchronization is performed using the ThumbnailImageViewerSynchronizer class. When a thumbnail is selected, its full size image is loaded into the viewer where it can be modified. When an image is modified its thumbnail will be updated to match the change.

Inheritance Hierarchy

Namespace:  Atalasoft.Imaging.WinControls
Assembly:  Atalasoft.dotImage.WinControls (in Atalasoft.dotImage.WinControls.dll) Version: 11.0.0.0.0.297 (.NET 4.5.2, x86)
Syntax
public class DocumentViewer : Control

The DocumentViewer type exposes the following members.

Constructors
  NameDescription
Public methodDocumentViewer
Initializes a new instance of the DocumentViewer class
Top
Properties
  NameDescription
Public propertyAccessibilityObject
Gets the AccessibleObject assigned to the control.
(Inherited from Control.)
Public propertyAccessibleDefaultActionDescription
Gets or sets the default action description of the control for use by accessibility client applications.
(Inherited from Control.)
Public propertyAccessibleDescription
Gets or sets the description of the control used by accessibility client applications.
(Inherited from Control.)
Public propertyAccessibleName
Gets or sets the name of the control used by accessibility client applications.
(Inherited from Control.)
Public propertyAccessibleRole
Gets or sets the accessible role of the control
(Inherited from Control.)
Public propertyAllowDrop
Gets or sets a value indicating whether the control can accept data that the user drags onto it.
(Inherited from Control.)
Public propertyAnchor
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.)
Public propertyAsynchronous
Indicates whether processing is performed in a background thread. The default value is false
Public propertyAutoScrollOffset
Gets or sets where this control is scrolled to in ScrollControlIntoView(Control).
(Inherited from Control.)
Public propertyAutoSize
This property is not relevant for this class.
(Inherited from Control.)
Public propertyBackColor
Gets or sets the background color for the control.
(Inherited from Control.)
Public propertyBackgroundImage
Gets or sets the background image displayed in the control.
(Inherited from Control.)
Public propertyBackgroundImageLayout
Gets or sets the background image layout as defined in the ImageLayout enumeration.
(Inherited from Control.)
Public propertyBindingContext
Gets or sets the BindingContext for the control.
(Inherited from Control.)
Public propertyBottom
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.)
Public propertyBounds
Gets or sets the size and location of the control including its nonclient elements, in pixels, relative to the parent control.
(Inherited from Control.)
Protected propertyCanEnableIme
Gets a value indicating whether the ImeMode property can be set to an active value, to enable IME support.
(Inherited from Control.)
Public propertyCanFocus
Gets a value indicating whether the control can receive focus.
(Inherited from Control.)
Protected propertyCanRaiseEvents
Determines if events can be raised on the control.
(Inherited from Control.)
Public propertyCanSelect
Gets a value indicating whether the control can be selected.
(Inherited from Control.)
Public propertyCapture
Gets or sets a value indicating whether the control has captured the mouse.
(Inherited from Control.)
Public propertyCausesValidation
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.)
Public propertyClientRectangle
Gets the rectangle that represents the client area of the control.
(Inherited from Control.)
Public propertyClientSize
Gets or sets the height and width of the client area of the control.
(Inherited from Control.)
Public propertyCompanyName
Gets the name of the company or creator of the application containing the control.
(Inherited from Control.)
Public propertyContainer
Gets the IContainer that contains the Component.
(Inherited from Component.)
Public propertyContainsFocus
Gets a value indicating whether the control, or one of its child controls, currently has the input focus.
(Inherited from Control.)
Public propertyContextMenu
Gets or sets the shortcut menu associated with the control.
(Inherited from Control.)
Public propertyContextMenuStrip
Gets or sets the ContextMenuStrip associated with this control.
(Inherited from Control.)
Public propertyControls
Gets the collection of controls contained within the control.
(Inherited from Control.)
Public propertyCount
Gets the number of thumbnails in the ThumbnailView.
Public propertyCreated
Gets a value indicating whether the control has been created.
(Inherited from Control.)
Protected propertyCreateParams
Gets the required creation parameters when the control handle is created.
(Inherited from Control.)
Public propertyCurrentImageIndex
Gets the index of the image loaded in the viewer.
Public propertyCursor
Gets or sets the cursor that is displayed when the mouse pointer is over the control.
(Inherited from Control.)
Public propertyDataBindings
Gets the data bindings for the control.
(Inherited from Control.)
Protected propertyDefaultCursor
Gets or sets the default cursor for the control.
(Inherited from Control.)
Protected propertyDefaultImeMode
Gets the default Input Method Editor (IME) mode supported by the control.
(Inherited from Control.)
Protected propertyDefaultMargin
Gets the space, in pixels, that is specified by default between controls.
(Inherited from Control.)
Protected propertyDefaultMaximumSize
Gets the length and height, in pixels, that is specified as the default maximum size of a control.
(Inherited from Control.)
Protected propertyDefaultMinimumSize
Gets the length and height, in pixels, that is specified as the default minimum size of a control.
(Inherited from Control.)
Protected propertyDefaultPadding
Gets the internal spacing, in pixels, of the contents of a control.
(Inherited from Control.)
Protected propertyDefaultSize
Gets the default size of the control.
(Inherited from Control.)
Protected propertyDesignMode
Gets a value that indicates whether the Component is currently in design mode.
(Inherited from Component.)
Public propertyDisplayRectangle
Gets the rectangle that represents the display area of the control.
(Inherited from Control.)
Public propertyDisposing
Gets a value indicating whether the base Control class is in the process of disposing.
(Inherited from Control.)
Public propertyDock
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.)
Protected propertyDoubleBuffered
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.)
Public propertyEnabled
Gets or sets a value indicating whether the control can respond to user interaction.
(Inherited from Control.)
Protected propertyEvents
Gets the list of event handlers that are attached to this Component.
(Inherited from Component.)
Public propertyFocused
Gets a value indicating whether the control has input focus.
(Inherited from Control.)
Public propertyFont
Gets or sets the font of the text displayed by the control.
(Inherited from Control.)
Protected propertyFontHeight
Gets or sets the height of the font of the control.
(Inherited from Control.)
Public propertyForeColor
Gets or sets the foreground color of the control.
(Inherited from Control.)
Public propertyHandle
Gets the window handle that the control is bound to.
(Inherited from Control.)
Public propertyHasChildren
Gets a value indicating whether the control contains one or more child controls.
(Inherited from Control.)
Public propertyHeight
Gets or sets the height of the control.
(Inherited from Control.)
Public propertyCode exampleImageControl
Gets the image control properties.
Public propertyImeMode
Gets or sets the Input Method Editor (IME) mode of the control.
(Inherited from Control.)
Protected propertyImeModeBase
Gets or sets the IME mode of a control.
(Inherited from Control.)
Public propertyInvokeRequired
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.)
Public propertyIsAccessible
Gets or sets a value indicating whether the control is visible to accessibility applications.
(Inherited from Control.)
Public propertyIsDisposed
Gets a value indicating whether the control has been disposed of.
(Inherited from Control.)
Public propertyIsHandleCreated
Gets a value indicating whether the control has a handle associated with it.
(Inherited from Control.)
Public propertyIsMirrored
Gets a value indicating whether the control is mirrored.
(Inherited from Control.)
Public propertyLayoutEngine
Gets a cached instance of the control's layout engine.
(Inherited from Control.)
Public propertyLeft
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.)
Public propertyLocation
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.)
Public propertyMargin
Gets or sets the space between controls.
(Inherited from Control.)
Public propertyMaximumSize
Gets or sets the size that is the upper limit that GetPreferredSize(Size) can specify.
(Inherited from Control.)
Public propertyMinimumSize
Gets or sets the size that is the lower limit that GetPreferredSize(Size) can specify.
(Inherited from Control.)
Public propertyName
Gets or sets the name of the control.
(Inherited from Control.)
Public propertyPadding
Gets or sets padding within the control.
(Inherited from Control.)
Public propertyParent
Gets or sets the parent container of the control.
(Inherited from Control.)
Public propertyPreferredSize
Gets the size of a rectangular area into which the control can fit.
(Inherited from Control.)
Public propertyProductName
Gets the product name of the assembly containing the control.
(Inherited from Control.)
Public propertyProductVersion
Gets the version of the assembly containing the control.
(Inherited from Control.)
Public propertyRecreatingHandle
Gets a value indicating whether the control is currently re-creating its handle.
(Inherited from Control.)
Public propertyRedoCount
Gets the number of redo operations.
Public propertyRegion
Gets or sets the window region associated with the control.
(Inherited from Control.)
Protected propertyRenderRightToLeft Obsolete.
This property is now obsolete.
(Inherited from Control.)
Protected propertyResizeRedraw
Gets or sets a value indicating whether the control redraws itself when resized.
(Inherited from Control.)
Public propertyRight
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.)
Public propertyRightToLeft
Gets or sets a value indicating whether control's elements are aligned to support locales using right-to-left fonts.
(Inherited from Control.)
Protected propertyScaleChildren
Gets a value that determines the scaling of child controls.
(Inherited from Control.)
Public propertySelectFirstPageOnOpen
Gets or sets a value indicating whether the first page of an image is automatically selected after a call to Open(String).
Public propertyCode exampleSeparator
Gets the properties used for the separator.
Protected propertyShowFocusCues
Gets a value indicating whether the control should display focus rectangles.
(Inherited from Control.)
Protected propertyShowKeyboardCues
Gets a value indicating whether the user interface is in the appropriate state to show or hide keyboard accelerators.
(Inherited from Control.)
Public propertySite
Gets or sets the site of the control.
(Inherited from Control.)
Public propertySize
Gets or sets the height and width of the control.
(Inherited from Control.)
Protected propertySquareResolutionRequired
Gets or sets a value indicating whether the images must have equal X and Y resolution values.
Public propertyTabIndex
Gets or sets the tab order of the control within its container.
(Inherited from Control.)
Public propertyTabStop
Gets or sets a value indicating whether the user can give the focus to this control using the TAB key.
(Inherited from Control.)
Public propertyTag
Gets or sets the object that contains data about the control.
(Inherited from Control.)
Public propertyText
Gets or sets the text associated with this control.
(Inherited from Control.)
Public propertyCode exampleThumbnailControl
Gets the ThumbnailView properties.
Public propertyCode exampleThumbnailControlSize
Gets or sets the width or height of the ThumbnailView.
Public propertyCode exampleThumbnailDockStyle
Gets or sets a value indicating which side the thumbnail control should be docked against.
Public propertyTop
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.)
Public propertyTopLevelControl
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.)
Public propertyUndoCount
Gets the number of undo operations.
Public propertyUndoLevels
Gets or sets the maximum number of undo operations to hold.
Public propertyUseWaitCursor
Gets or sets a value indicating whether to use the wait cursor for the current control and all child controls.
(Inherited from Control.)
Public propertyVisible
Gets or sets a value indicating whether the control and all its child controls are displayed.
(Inherited from Control.)
Public propertyWidth
Gets or sets the width of the control.
(Inherited from Control.)
Public propertyWindowTarget
This property is not relevant for this class.
(Inherited from Control.)
Top
Methods
  NameDescription
Protected methodAccessibilityNotifyClients(AccessibleEvents, Int32)
Notifies the accessibility client applications of the specified AccessibleEvents for the specified child control.
(Inherited from Control.)
Protected methodAccessibilityNotifyClients(AccessibleEvents, Int32, Int32)
Notifies the accessibility client applications of the specified AccessibleEvents for the specified child control .
(Inherited from Control.)
Public methodCode exampleAdd(RandomAccessImageSource)
Adds images from a RandomAccessImageSource into the DocumentViewer.
Public methodCode exampleAdd(Stream, ThumbnailCaptionRequestEventHandler)
Adds all pages from an image and gets the thumbnail caption and tooltip from a ThumbnailCaptionRequestEventHandler.
Public methodAdd(String, ThumbnailCaptionRequestEventHandler)
Adds all pages from a file into the control and gets the thumbnail caption and tooltip from a ThumbnailCaptionRequestEventHandler.
Public methodCode exampleAdd(RandomAccessImageSource, ThumbnailCaptionRequestEventHandler)
Adds images from a RandomAccessImageSource and gets the thumbnail caption and tooltip from a ThumbnailCaptionRequestEventHandler.
Public methodAdd(AtalaImage, String, String)
Adds an AtalaImage to the thumbnail control.
Public methodAdd(Stream, Int32, String, String)
Loads one or more images from a Stream.
Public methodAdd(String, Int32, String, String)
Adds one or more images from a file.
Public methodApplyCommand
Public methodBeginInvoke(Delegate)
Executes the specified delegate asynchronously on the thread that the control's underlying handle was created on.
(Inherited from Control.)
Public methodBeginInvoke(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.)
Public methodBringToFront
Brings the control to the front of the z-order.
(Inherited from Control.)
Public methodClear
Public methodClearSelection
Public methodContains
Retrieves a value indicating whether the specified control is a child of the control.
(Inherited from Control.)
Protected methodCreateAccessibilityInstance
Creates a new accessibility object for the control.
(Inherited from Control.)
Public methodCreateControl
Forces the creation of the visible control, including the creation of the handle and any visible child controls.
(Inherited from Control.)
Protected methodCreateControlsInstance
Creates a new instance of the control collection for the control.
(Inherited from Control.)
Public methodCreateGraphics
Creates the Graphics for the control.
(Inherited from Control.)
Protected methodCreateHandle
Creates a handle for the control.
(Inherited from Control.)
Public methodCreateObjRef
Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.
(Inherited from MarshalByRefObject.)
Protected methodDefWndProc
Sends the specified message to the default window procedure.
(Inherited from Control.)
Protected methodDestroyHandle
Destroys the handle associated with the control.
(Inherited from Control.)
Public methodDispose
Releases all resources used by the Component.
(Inherited from Component.)
Protected methodDispose(Boolean)
Releases resources used by the control.
(Overrides ControlDispose(Boolean).)
Public methodDoDragDrop
Begins a drag-and-drop operation.
(Inherited from Control.)
Public methodDrawToBitmap
Supports rendering to the specified bitmap.
(Inherited from Control.)
Public methodEndInvoke
Retrieves the return value of the asynchronous operation represented by the IAsyncResult passed.
(Inherited from Control.)
Public methodEnsureVisible
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize (Overrides ComponentFinalize.)
Public methodFindForm
Retrieves the form that the control is on.
(Inherited from Control.)
Public methodFocus
Sets input focus to the control.
(Inherited from Control.)
Protected methodGetAccessibilityObjectById
Retrieves the specified AccessibleObject.
(Inherited from Control.)
Protected methodGetAutoSizeMode
Retrieves a value indicating how a control will behave when its AutoSize property is enabled.
(Inherited from Control.)
Public methodGetChildAtPoint(Point)
Retrieves the child control that is located at the specified coordinates.
(Inherited from Control.)
Public methodGetChildAtPoint(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.)
Public methodGetContainerControl
Returns the next ContainerControl up the control's chain of parent controls.
(Inherited from Control.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Protected methodGetImageSource
Public methodGetLifetimeService
Retrieves the current lifetime service object that controls the lifetime policy for this instance.
(Inherited from MarshalByRefObject.)
Public methodGetNextControl
Retrieves the next control forward or back in the tab order of child controls.
(Inherited from Control.)
Public methodGetPreferredSize
Retrieves the size of a rectangular area into which a control can be fitted.
(Inherited from Control.)
Protected methodGetScaledBounds
Retrieves the bounds within which the control is scaled.
(Inherited from Control.)
Protected methodGetService
Returns an object that represents a service provided by the Component or by its Container.
(Inherited from Component.)
Protected methodGetStyle
Retrieves the value of the specified control style bit for the control.
(Inherited from Control.)
Protected methodGetTemporaryXmpFileName
Returns the temorary filename used by the DocumentAnnotationViewer to store XMP annotation data.
Protected methodGetTopLevel
Determines if the control is a top-level control.
(Inherited from Control.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodHide
Conceals the control from the user.
(Inherited from Control.)
Public methodInitializeLifetimeService
Obtains a lifetime service object to control the lifetime policy for this instance.
(Inherited from MarshalByRefObject.)
Protected methodInitLayout
Called after the control has been added to another container.
(Inherited from Control.)
Public methodInsert(Int32, RandomAccessImageSource)
Inserts images from a RandomAccessImageSource into the collection.
Public methodInsert(Int32, RandomAccessImageSource, ThumbnailCaptionRequestEventHandler)
Inserts images from a RandomAccessImageSource and gets the thumbnail caption and tooltip from a ThumbnailCaptionRequestEventHandler.
Public methodInsert(Int32, Stream, ThumbnailCaptionRequestEventHandler)
Inserts all images from a stream into the ThumbnailView and gets the thumbnail caption and tooltip from a ThumbnailCaptionRequestEventHandler.
Public methodInsert(Int32, String, ThumbnailCaptionRequestEventHandler)
Inserts all pages from a file into the ThumbnailView and gets the thumbnail caption and tooltip from a ThumbnailCaptionRequestEventHandler.
Public methodInsert(Int32, AtalaImage, String, String)
Inserts an AtalaImage into the thumbnail control.
Public methodInsert(Int32, Stream, Int32, String, String)
Inserts one or more images into the ThumbnailView from a Stream.
Public methodInsert(Int32, String, Int32, String, String)
Inserts one or more images into the ThumbnailView from a file.
Public methodInvalidate
Invalidates the entire surface of the control and causes the control to be redrawn.
(Inherited from Control.)
Public methodInvalidate(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.)
Public methodInvalidate(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.)
Public methodInvalidate(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.)
Public methodInvalidate(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.)
Public methodInvalidate(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.)
Public methodInvoke(Delegate)
Executes the specified delegate on the thread that owns the control's underlying window handle.
(Inherited from Control.)
Public methodInvoke(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.)
Protected methodInvokeGotFocus
Raises the GotFocus event for the specified control.
(Inherited from Control.)
Protected methodInvokeLostFocus
Raises the LostFocus event for the specified control.
(Inherited from Control.)
Protected methodInvokeOnClick
Raises the Click event for the specified control.
(Inherited from Control.)
Protected methodInvokePaint
Raises the Paint event for the specified control.
(Inherited from Control.)
Protected methodInvokePaintBackground
Raises the PaintBackground event for the specified control.
(Inherited from Control.)
Protected methodIsInputChar
Determines if a character is an input character that the control recognizes.
(Inherited from Control.)
Protected methodIsInputKey
Determines whether the specified key is a regular input key or a special key that requires preprocessing.
(Inherited from Control.)
Public methodIsThumbnailVisible(Int32, Boolean)
Returns a value indicating whether the thumbnail at the specified index is currently visible.
Public methodIsThumbnailVisible(Thumbnail, Boolean)
Returns a value indicating whether the specified thumbnail is currently visible.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodMemberwiseClone(Boolean)
Creates a shallow copy of the current MarshalByRefObject object.
(Inherited from MarshalByRefObject.)
Protected methodNotifyInvalidate
Raises the Invalidated event with a specified region of the control to invalidate.
(Inherited from Control.)
Protected methodOnAutoSizeChanged
Raises the AutoSizeChanged event.
(Inherited from Control.)
Protected methodOnBackColorChanged
Raises the BackColorChanged event.
(Inherited from Control.)
Protected methodOnBackgroundImageChanged
Raises the BackgroundImageChanged event.
(Inherited from Control.)
Protected methodOnBackgroundImageLayoutChanged (Inherited from Control.)
Protected methodOnBindingContextChanged
Raises the BindingContextChanged event.
(Inherited from Control.)
Protected methodOnCausesValidationChanged
Raises the CausesValidationChanged event.
(Inherited from Control.)
Protected methodOnChangeUICues
Raises the ChangeUICues event.
(Inherited from Control.)
Protected methodOnClear
Protected methodOnClick
Raises the Click event.
(Inherited from Control.)
Protected methodOnClientSizeChanged
Raises the ClientSizeChanged event.
(Inherited from Control.)
Protected methodOnContextMenuChanged
Raises the ContextMenuChanged event.
(Inherited from Control.)
Protected methodOnContextMenuStripChanged
Raises the ContextMenuStripChanged event.
(Inherited from Control.)
Protected methodOnControlAdded
Raises the ControlAdded event.
(Inherited from Control.)
Protected methodOnControlRemoved
Raises the ControlRemoved event.
(Inherited from Control.)
Protected methodOnCreateControl (Overrides ControlOnCreateControl.)
Protected methodOnCursorChanged
Raises the CursorChanged event.
(Inherited from Control.)
Protected methodOnDockChanged (Overrides ControlOnDockChanged(EventArgs).)
Protected methodOnDoubleClick
Raises the DoubleClick event.
(Inherited from Control.)
Protected methodOnDragDrop
Raises the DragDrop event.
(Inherited from Control.)
Protected methodOnDragEnter
Raises the DragEnter event.
(Inherited from Control.)
Protected methodOnDragLeave
Raises the DragLeave event.
(Inherited from Control.)
Protected methodOnDragOver
Raises the DragOver event.
(Inherited from Control.)
Protected methodOnEnabledChanged
Raises the EnabledChanged event.
(Inherited from Control.)
Protected methodOnEnter
Raises the Enter event.
(Inherited from Control.)
Protected methodOnFontChanged
Raises the FontChanged event.
(Inherited from Control.)
Protected methodOnForeColorChanged
Raises the ForeColorChanged event.
(Inherited from Control.)
Protected methodOnGiveFeedback
Raises the GiveFeedback event.
(Inherited from Control.)
Protected methodOnGotFocus
Raises the GotFocus event.
(Inherited from Control.)
Protected methodOnHandleCreated
Raises the HandleCreated event.
(Inherited from Control.)
Protected methodOnHandleDestroyed
Raises the HandleDestroyed event.
(Inherited from Control.)
Protected methodOnHelpRequested
Raises the HelpRequested event.
(Inherited from Control.)
Protected methodOnImageInserted
Called when an image is inserted into the collection through the Open(String), Add(AtalaImage, String, String) or Insert(Int32, String, Int32, String, String) methods.
Protected methodOnImeModeChanged
Raises the ImeModeChanged event.
(Inherited from Control.)
Protected methodOnInvalidated
Raises the Invalidated event.
(Inherited from Control.)
Protected methodOnKeyDown
Raises the KeyDown event.
(Inherited from Control.)
Protected methodOnKeyPress
Raises the KeyPress event.
(Inherited from Control.)
Protected methodOnKeyUp
Raises the KeyUp event.
(Inherited from Control.)
Protected methodOnLayout
Raises the Layout event.
(Inherited from Control.)
Protected methodOnLeave
Raises the Leave event.
(Inherited from Control.)
Protected methodOnLocationChanged
Raises the LocationChanged event.
(Inherited from Control.)
Protected methodOnLostFocus
Raises the LostFocus event.
(Inherited from Control.)
Protected methodOnMarginChanged
Raises the MarginChanged event.
(Inherited from Control.)
Protected methodOnMouseCaptureChanged
Raises the MouseCaptureChanged event.
(Inherited from Control.)
Protected methodOnMouseClick
Raises the MouseClick event.
(Inherited from Control.)
Protected methodOnMouseDoubleClick
Raises the MouseDoubleClick event.
(Inherited from Control.)
Protected methodOnMouseDown
Raises the MouseDown event.
(Inherited from Control.)
Protected methodOnMouseEnter
Raises the MouseEnter event.
(Inherited from Control.)
Protected methodOnMouseHover
Raises the MouseHover event.
(Inherited from Control.)
Protected methodOnMouseLeave
Raises the MouseLeave event.
(Inherited from Control.)
Protected methodOnMouseMove
Raises the MouseMove event.
(Inherited from Control.)
Protected methodOnMouseUp
Raises the MouseUp event.
(Inherited from Control.)
Protected methodOnMouseWheel
Raises the MouseWheel event.
(Inherited from Control.)
Protected methodOnMove
Raises the Move event.
(Inherited from Control.)
Protected methodOnNotifyMessage
Notifies the control of Windows messages.
(Inherited from Control.)
Protected methodOnOpenDocument
Called when the Open(String), Add(AtalaImage, String, String) or Insert(Int32, String, Int32, String, String) method is used to allow derived classes to perform any pre-open actions.
Protected methodOnPaddingChanged
Raises the PaddingChanged event.
(Inherited from Control.)
Protected methodOnPaint (Overrides ControlOnPaint(PaintEventArgs).)
Protected methodOnPaintBackground
Paints the background of the control.
(Inherited from Control.)
Protected methodOnParentBackColorChanged
Raises the BackColorChanged event when the BackColor property value of the control's container changes.
(Inherited from Control.)
Protected methodOnParentBackgroundImageChanged
Raises the BackgroundImageChanged event when the BackgroundImage property value of the control's container changes.
(Inherited from Control.)
Protected methodOnParentBindingContextChanged
Raises the BindingContextChanged event when the BindingContext property value of the control's container changes.
(Inherited from Control.)
Protected methodOnParentChanged
Raises the ParentChanged event.
(Inherited from Control.)
Protected methodOnParentCursorChanged
Raises the CursorChanged event.
(Inherited from Control.)
Protected methodOnParentEnabledChanged
Raises the EnabledChanged event when the Enabled property value of the control's container changes.
(Inherited from Control.)
Protected methodOnParentFontChanged
Raises the FontChanged event when the Font property value of the control's container changes.
(Inherited from Control.)
Protected methodOnParentForeColorChanged
Raises the ForeColorChanged event when the ForeColor property value of the control's container changes.
(Inherited from Control.)
Protected methodOnParentRightToLeftChanged
Raises the RightToLeftChanged event when the RightToLeft property value of the control's container changes.
(Inherited from Control.)
Protected methodOnParentVisibleChanged
Raises the VisibleChanged event when the Visible property value of the control's container changes.
(Inherited from Control.)
Protected methodOnPreviewKeyDown
Raises the PreviewKeyDown event.
(Inherited from Control.)
Protected methodOnPrint
Raises the Paint event.
(Inherited from Control.)
Protected methodOnPrintingPage
Called just before each page is printed to allow derived classes to modify the image.
Protected methodOnQueryContinueDrag
Raises the QueryContinueDrag event.
(Inherited from Control.)
Protected methodOnRegionChanged
Raises the RegionChanged event.
(Inherited from Control.)
Protected methodOnResize
Raises the Resize event.
(Inherited from Control.)
Protected methodOnRightToLeftChanged
Raises the RightToLeftChanged event.
(Inherited from Control.)
Protected methodOnSelectedIndexChanged
Called when the current image index has changed.
Protected methodOnSizeChanged
Raises the SizeChanged event.
(Inherited from Control.)
Protected methodOnStyleChanged
Raises the StyleChanged event.
(Inherited from Control.)
Protected methodOnSystemColorsChanged
Raises the SystemColorsChanged event.
(Inherited from Control.)
Protected methodOnTabIndexChanged
Raises the TabIndexChanged event.
(Inherited from Control.)
Protected methodOnTabStopChanged
Raises the TabStopChanged event.
(Inherited from Control.)
Protected methodOnTextChanged
Raises the TextChanged event.
(Inherited from Control.)
Protected methodOnThumbnailControlSizeChanged
Protected methodOnThumbnailDockStyleChanged
Protected methodOnValidated
Raises the Validated event.
(Inherited from Control.)
Protected methodOnValidating
Raises the Validating event.
(Inherited from Control.)
Protected methodOnVisibleChanged
Raises the VisibleChanged event.
(Inherited from Control.)
Public methodCode exampleOpen(Stream)
Opens all pages of an image from a stream.
Public methodOpen(String)
Opens an image from a filename. If the file is a multipage document, all pages are added to the control.
Public methodCode exampleOpen(RandomAccessImageSource)
Adds images from a RandomAccessImageSource into the viewer.
Public methodCode exampleOpen(Stream, ThumbnailCaptionRequestEventHandler)
Opens all pages from a stream and gets the caption and tooltip from the specified ThumbnailCaptionRequestEventHandler.
Public methodOpen(Stream, Int32)
Opens the specified page from an image.
Public methodOpen(String, ThumbnailCaptionRequestEventHandler)
Opens all pages in an image and gets the caption and tooltip from the specified ThumbnailCaptionRequestEventHandler.
Public methodOpen(String, Int32)
Opens the specified frame index from a file.
Public methodCode exampleOpen(RandomAccessImageSource, ThumbnailCaptionRequestEventHandler)
Adds images from a RandomAccessImageSource and gets the caption and tooltip from the specified ThumbnailCaptionRequestEventHandler.
Public methodOpen(Stream, Int32, String, String)
Opens the specified page from an image and provides the thumbnail caption and tooltip.
Public methodOpen(String, Int32, String, String)
Opens the specified frame from an image and provides the thumbnail caption and tooltip.
Public methodPerformLayout
Forces the control to apply layout logic to all its child controls.
(Inherited from Control.)
Public methodPerformLayout(Control, String)
Forces the control to apply layout logic to all its child controls.
(Inherited from Control.)
Public methodPointToClient
Computes the location of the specified screen point into client coordinates.
(Inherited from Control.)
Public methodPointToScreen
Computes the location of the specified client point into screen coordinates.
(Inherited from Control.)
Public methodPreProcessControlMessage
Preprocesses keyboard or input messages within the message loop before they are dispatched.
(Inherited from Control.)
Public methodPreProcessMessage
Preprocesses keyboard or input messages within the message loop before they are dispatched.
(Inherited from Control.)
Public methodCode examplePrint
This method will print the contents of the DocumentViewer.
Protected methodProcessCmdKey
Processes a command key.
(Inherited from Control.)
Protected methodProcessDialogChar
Processes a dialog character.
(Inherited from Control.)
Protected methodProcessDialogKey
Processes a dialog key.
(Inherited from Control.)
Protected methodProcessKeyEventArgs
Processes a key message and generates the appropriate control events.
(Inherited from Control.)
Protected methodProcessKeyMessage
Processes a keyboard message.
(Inherited from Control.)
Protected methodProcessKeyPreview
Previews a keyboard message.
(Inherited from Control.)
Protected methodProcessMnemonic
Processes a mnemonic character.
(Inherited from Control.)
Protected methodRaiseDragEvent
Raises the appropriate drag event.
(Inherited from Control.)
Protected methodRaiseKeyEvent
Raises the appropriate key event.
(Inherited from Control.)
Protected methodRaiseMouseEvent
Raises the appropriate mouse event.
(Inherited from Control.)
Protected methodRaisePaintEvent
Raises the appropriate paint event.
(Inherited from Control.)
Protected methodRecreateHandle
Forces the re-creation of the handle for the control.
(Inherited from Control.)
Public methodRectangleToClient
Computes the size and location of the specified screen rectangle in client coordinates.
(Inherited from Control.)
Public methodRectangleToScreen
Computes the size and location of the specified client rectangle in screen coordinates.
(Inherited from Control.)
Public methodRedo
Performs a redo operation on the viewer.
Public methodRefresh
Forces the control to invalidate its client area and immediately redraw itself and any child controls.
(Inherited from Control.)
Public methodRemove
Public methodRemoveAt
Public methodRemoveSelected
Public methodResetBackColor
Resets the BackColor property to its default value.
(Inherited from Control.)
Public methodResetBindings
Causes a control bound to the BindingSource to reread all the items in the list and refresh their displayed values.
(Inherited from Control.)
Public methodResetCursor
Resets the Cursor property to its default value.
(Inherited from Control.)
Public methodResetFont
Resets the Font property to its default value.
(Inherited from Control.)
Public methodResetForeColor
Resets the ForeColor property to its default value.
(Inherited from Control.)
Public methodResetImeMode
Resets the ImeMode property to its default value.
(Inherited from Control.)
Protected methodResetMouseEventArgs
Resets the control to handle the MouseLeave event.
(Inherited from Control.)
Public methodResetRightToLeft
Resets the RightToLeft property to its default value.
(Inherited from Control.)
Public methodResetText
Resets the Text property to its default value.
(Inherited from Control.)
Public methodResumeLayout
Resumes usual layout logic.
(Inherited from Control.)
Public methodResumeLayout(Boolean)
Resumes usual layout logic, optionally forcing an immediate layout of pending layout requests.
(Inherited from Control.)
Protected methodRtlTranslateAlignment(HorizontalAlignment)
Converts the specified HorizontalAlignment to the appropriate HorizontalAlignment to support right-to-left text.
(Inherited from Control.)
Protected methodRtlTranslateAlignment(LeftRightAlignment)
Converts the specified LeftRightAlignment to the appropriate LeftRightAlignment to support right-to-left text.
(Inherited from Control.)
Protected methodRtlTranslateAlignment(ContentAlignment)
Converts the specified ContentAlignment to the appropriate ContentAlignment to support right-to-left text.
(Inherited from Control.)
Protected methodRtlTranslateContent
Converts the specified ContentAlignment to the appropriate ContentAlignment to support right-to-left text.
(Inherited from Control.)
Protected methodRtlTranslateHorizontal
Converts the specified HorizontalAlignment to the appropriate HorizontalAlignment to support right-to-left text.
(Inherited from Control.)
Protected methodRtlTranslateLeftRight
Converts the specified LeftRightAlignment to the appropriate LeftRightAlignment to support right-to-left text.
(Inherited from Control.)
Public methodSave(Stream, ImageEncoder)
Saves the image(s) to a stream using the supplied encoder.
Public methodSave(String, ImageEncoder)
Saves the image(s) to a file using the supplied encoder.
Public methodScale(Single) Obsolete.
Scales the control and any child controls.
(Inherited from Control.)
Public methodScale(SizeF)
Scales the control and all child controls by the specified scaling factor.
(Inherited from Control.)
Public methodScale(Single, Single) Obsolete.
Scales the entire control and any child controls.
(Inherited from Control.)
Protected methodScaleControl
Scales a control's location, size, padding and margin.
(Inherited from Control.)
Protected methodScaleCore
This method is not relevant for this class.
(Inherited from Control.)
Public methodSelect
Activates the control.
(Inherited from Control.)
Protected methodSelect(Boolean, Boolean)
Activates a child control. Optionally specifies the direction in the tab order to select the control from.
(Inherited from Control.)
Public methodSelectAll
Public methodSelectNextControl
Activates the next control.
(Inherited from Control.)
Public methodSelectThumbnail
Public methodSendToBack
Sends the control to the back of the z-order.
(Inherited from Control.)
Protected methodSetAutoSizeMode
Sets a value indicating how a control will behave when its AutoSize property is enabled.
(Inherited from Control.)
Public methodSetBounds(Int32, Int32, Int32, Int32)
Sets the bounds of the control to the specified location and size.
(Inherited from Control.)
Public methodSetBounds(Int32, Int32, Int32, Int32, BoundsSpecified)
Sets the specified bounds of the control to the specified location and size.
(Inherited from Control.)
Protected methodSetBoundsCore
Performs the work of setting the specified bounds of this control.
(Inherited from Control.)
Protected methodSetClientSizeCore
Sets the size of the client area of the control.
(Inherited from Control.)
Protected methodSetImageViewer
Use this method to replace the standard ImageViewer with another control deriving from ImageViewer.
Protected methodSetStyle
Sets a specified ControlStyles flag to either true or false.
(Inherited from Control.)
Protected methodSetTopLevel
Sets the control as the top-level control.
(Inherited from Control.)
Protected methodSetUndoManager
Call this method to replace the default CachedImageUndoManager with a custom version.
Protected methodSetVisibleCore
Sets the control to the specified visible state.
(Inherited from Control.)
Public methodSetZoomMode
Public methodShow
Displays the control to the user.
(Inherited from Control.)
Protected methodSizeFromClientSize
Determines the size of the entire control from the height and width of its client area.
(Inherited from Control.)
Public methodSuspendLayout
Temporarily suspends the layout logic for the control.
(Inherited from Control.)
Public methodToString
Returns a String containing the name of the Component, if any. This method should not be overridden.
(Inherited from Component.)
Public methodUndo
Performs an undo operation on the viewer.
Public methodUpdate
Causes the control to redraw the invalidated regions within its client area.
(Inherited from Control.)
Protected methodUpdateBounds
Updates the bounds of the control with the current size and location.
(Inherited from Control.)
Protected methodUpdateBounds(Int32, Int32, Int32, Int32)
Updates the bounds of the control with the specified size and location.
(Inherited from Control.)
Protected methodUpdateBounds(Int32, Int32, Int32, Int32, Int32, Int32)
Updates the bounds of the control with the specified size, location, and client size.
(Inherited from Control.)
Protected methodUpdateStyles
Forces the assigned styles to be reapplied to the control.
(Inherited from Control.)
Protected methodUpdateZOrder
Updates the control in its parent's z-order.
(Inherited from Control.)
Protected methodWndProc
Processes Windows messages.
(Inherited from Control.)
Top
Events
  NameDescription
Public eventAfterLabelEdit
Public eventAutoSizeChanged
This event is not relevant for this class.
(Inherited from Control.)
Public eventBackColorChanged
Occurs when the value of the BackColor property changes.
(Inherited from Control.)
Public eventBackgroundImageChanged
Occurs when the value of the BackgroundImage property changes.
(Inherited from Control.)
Public eventBackgroundImageLayoutChanged
Occurs when the BackgroundImageLayout property changes.
(Inherited from Control.)
Public eventBeforeLabelEdit
Public eventBindingContextChanged
Occurs when the value of the BindingContext property changes.
(Inherited from Control.)
Public eventCausesValidationChanged
Occurs when the value of the CausesValidation property changes.
(Inherited from Control.)
Public eventChangeUICues
Occurs when the focus or keyboard user interface (UI) cues change.
(Inherited from Control.)
Public eventClick
Occurs when the control is clicked.
(Inherited from Control.)
Public eventClientSizeChanged
Occurs when the value of the ClientSize property changes.
(Inherited from Control.)
Public eventContextMenuChanged
Occurs when the value of the ContextMenu property changes.
(Inherited from Control.)
Public eventContextMenuStripChanged
Occurs when the value of the ContextMenuStrip property changes.
(Inherited from Control.)
Public eventControlAdded (Inherited from Control.)
Public eventControlRemoved (Inherited from Control.)
Public eventCursorChanged
Occurs when the value of the Cursor property changes.
(Inherited from Control.)
Public eventDisposed
Occurs when the component is disposed by a call to the Dispose method.
(Inherited from Component.)
Public eventDockChanged
Occurs when the value of the Dock property changes.
(Inherited from Control.)
Public eventDoubleClick
Occurs when the control is double-clicked.
(Inherited from Control.)
Public eventDragDrop
Occurs when a drag-and-drop operation is completed.
(Inherited from Control.)
Public eventDragEnter
Occurs when an object is dragged into the control's bounds.
(Inherited from Control.)
Public eventDragLeave
Occurs when an object is dragged out of the control's bounds.
(Inherited from Control.)
Public eventDragOver
Occurs when an object is dragged over the control's bounds.
(Inherited from Control.)
Public eventEnabledChanged
Occurs when the Enabled property value has changed.
(Inherited from Control.)
Public eventEnter
Occurs when the control is entered.
(Inherited from Control.)
Public eventFontChanged
Occurs when the Font property value changes.
(Inherited from Control.)
Public eventForeColorChanged
Occurs when the ForeColor property value changes.
(Inherited from Control.)
Public eventGiveFeedback
Occurs during a drag operation.
(Inherited from Control.)
Public eventGotFocus
Occurs when the control receives focus.
(Inherited from Control.)
Public eventHandleCreated
Occurs when a handle is created for the control.
(Inherited from Control.)
Public eventHandleDestroyed
Occurs when the control's handle is in the process of being destroyed.
(Inherited from Control.)
Public eventHelpRequested
Occurs when the user requests help for a control.
(Inherited from Control.)
Public eventImeModeChanged
Occurs when the ImeMode property has changed.
(Inherited from Control.)
Public eventInvalidated
Occurs when a control's display requires redrawing.
(Inherited from Control.)
Public eventKeyDown
Occurs when a key is pressed while the control has focus.
(Inherited from Control.)
Public eventKeyPress
Occurs when a key is pressed while the control has focus.
(Inherited from Control.)
Public eventKeyUp
Occurs when a key is released while the control has focus.
(Inherited from Control.)
Public eventLayout
Occurs when a control should reposition its child controls.
(Inherited from Control.)
Public eventLeave
Occurs when the input focus leaves the control.
(Inherited from Control.)
Public eventLocationChanged
Occurs when the Location property value has changed.
(Inherited from Control.)
Public eventLostFocus
Occurs when the control loses focus.
(Inherited from Control.)
Public eventMarginChanged
Occurs when the control's margin changes.
(Inherited from Control.)
Public eventMouseCaptureChanged
Occurs when the control loses mouse capture.
(Inherited from Control.)
Public eventMouseClick
Occurs when the control is clicked by the mouse.
(Inherited from Control.)
Public eventMouseDoubleClick
Occurs when the control is double clicked by the mouse.
(Inherited from Control.)
Public eventMouseDown
Occurs when the mouse pointer is over the control and a mouse button is pressed.
(Inherited from Control.)
Public eventMouseEnter
Occurs when the mouse pointer enters the control.
(Inherited from Control.)
Public eventMouseHover
Occurs when the mouse pointer rests on the control.
(Inherited from Control.)
Public eventMouseLeave
Occurs when the mouse pointer leaves the control.
(Inherited from Control.)
Public eventMouseMove
Occurs when the mouse pointer is moved over the control.
(Inherited from Control.)
Public eventMouseUp
Occurs when the mouse pointer is over the control and a mouse button is released.
(Inherited from Control.)
Public eventMouseWheel
Occurs when the mouse wheel moves while the control has focus.
(Inherited from Control.)
Public eventMove
Occurs when the control is moved.
(Inherited from Control.)
Public eventPaddingChanged
Occurs when the control's padding changes.
(Inherited from Control.)
Public eventPaint
Occurs when the control is redrawn.
(Inherited from Control.)
Public eventParentChanged
Occurs when the Parent property value changes.
(Inherited from Control.)
Public eventPreviewKeyDown
Occurs before the KeyDown event when a key is pressed while focus is on this control.
(Inherited from Control.)
Public eventPrintingPage
Raised as each page is about to be printed.
Public eventQueryAccessibilityHelp
Occurs when AccessibleObject is providing help to accessibility applications.
(Inherited from Control.)
Public eventQueryContinueDrag
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.)
Public eventRedoPerformed
Raised when a redo operation has been performed.
Public eventRegionChanged
Occurs when the value of the Region property changes.
(Inherited from Control.)
Public eventResize
Occurs when the control is resized.
(Inherited from Control.)
Public eventRightToLeftChanged
Occurs when the RightToLeft property value changes.
(Inherited from Control.)
Public eventSelectedIndexChanged
Public eventSizeChanged
Occurs when the Size property value changes.
(Inherited from Control.)
Public eventStyleChanged
Occurs when the control style changes.
(Inherited from Control.)
Public eventSystemColorsChanged
Occurs when the system colors change.
(Inherited from Control.)
Public eventTabIndexChanged
Occurs when the TabIndex property value changes.
(Inherited from Control.)
Public eventTabStopChanged
Occurs when the TabStop property value changes.
(Inherited from Control.)
Public eventTextChanged
Occurs when the Text property value changes.
(Inherited from Control.)
Public eventUndoListChanged
Raised when there has been a change in the undo/redo lists.
Public eventUndoPerformed
Raised when an undo operation has been performed.
Public eventValidated
Occurs when the control is finished validating.
(Inherited from Control.)
Public eventValidating
Occurs when the control is validating.
(Inherited from Control.)
Public eventVisibleChanged
Occurs when the Visible property value changes.
(Inherited from Control.)
Top
Remarks

Advantages to using the DocumentViewer control:

There is less code to write: All synchronization between the ThumbnailView and ImageViewer controls is handled for you.Images can be added from an AtalaImage, file, Stream or RandomAccessImageSource and are managed internally so there is no need to keep track of where an image is loaded from.When images are modified they are saved to a temporary file, keeping the original image untouched. These temporary files are automatically deleted when the control is disposed.Only one full size image is kept in memory at a time, resulting in lower memory overhead.
See Also