←Select platform

RasterImageViewer Class Members

Summary

The following tables list the members exposed by RasterImageViewer.

Public Constructors

Name Description
Public Constructor RasterImageViewer Initializes a new instance of the RasterImageViewer class.

Public Methods

Name Description
Public Method BeginUpdate Prevents the control from drawing until the EndUpdate method is called.
Public Method CenterAtPoint Centers the image display at the specified point.
Public Method CombineFloater Combines the FloaterImage with the Image currently inside this RasterImageViewer.
Public Method EndUpdate Resumes drawing which was disabled by a call to BeginUpdate.
Public Method GetTransformWithDpi Return the transform of the viewer taking into account the DPI of the image.
Public Method ImageToViewerPoint Converts a point in image coordinates to viewer coordinates.
Public Method ImageToViewerRectangle Converts a rectangle in image coordinates to viewer coordinates.
Public Method RedirectPaint Displays the contents of the RasterImageViewer in the given Graphics object.
Public Method RegionToFloater Converts the image region to a floater.
Public Method SetInteractiveModeCursor Sets the mouse cursors associated with an interactive mode
Public Method ViewerToImagePoint Converts a point in viewer coordinates to image coordinates.
Public Method ViewerToImageRectangle Converts a rectangle in viewer coordinates to image coordinates.
Public Method ZoomAtPoint Zooms the image display at the specified point with the specified scale factor.
Public Method ZoomToRectangle Zooms the image to the specified rectangle.

Protected Methods

Name Description
Protected Method Dispose(Boolean) Clean up any resources being used.
Protected Method IsInputKey This member overrides Control.IsInputKey.
Protected Method OnAnimateFloaterChanged Raises the AnimateFloaterChanged event.
Protected Method OnAnimateRegionChanged Raises the AnimateRegionChanged event.
Protected Method OnAutoDisposeImagesChanged Raises the AutoDisposeImagesChanged event.
Protected Method OnAutoInteractiveMagnifyGlassChanged Raises the AutoInteractiveMagnifyGlassChanged event.
Protected Method OnAutoResetScaleFactorChanged Raises the AutoResetScaleFactorChanged event.
Protected Method OnAutoResetScrollPositionChanged Raises the AutoResetScrollPositionChanged event.
Protected Method OnAutoScrollChanged Raises the AutoScrollChanged event.
Protected Method OnBorderStyleChanged Raises the BorderStyleChanged event.
Protected Method OnCenterZoomAtPointScaleFactorChanged Raises the CenterZoomAtPointScaleFactorChanged event.
Protected Method OnDoubleBufferChanged Raises the DoubleBufferChanged event.
Protected Method OnEnableScrollingInterfaceChanged Raises the EnableScrollingInterfaceChanged event.
Protected Method OnEnableTimerChanged Raises the EnableTimerChanged event.
Protected Method OnFloaterImageChanged Raises the FloaterImageChanged event.
Protected Method OnFloaterPositionChanged Raises the FloaterPositionChanged event.
Protected Method OnFloaterVisibleChanged Raises the FloaterVisibleChanged event.
Protected Method OnFrameColorChanged Raises the FrameColorChanged event.
Protected Method OnFrameShadowColorChanged Raises the FrameShadowColorChanged event.
Protected Method OnFrameShadowSizeChanged Raises the FrameShadowSizeChanged event.
Protected Method OnFramesIsPartOfImageChanged Raises the FramesIsPartOfImageChanged event.
Protected Method OnFrameSizeChanged Raises the FrameSizeChanged event.
Protected Method OnHorizontalAlignModeChanged Raises the HorizontalAlignModeChanged event.
Protected Method OnImageChanged Raises the ImageChanged event.
Protected Method OnInteractiveCenterAt Raises the InteractiveCenterAt event.
Protected Method OnInteractiveFloater Raises the InteractiveMode event.
Protected Method OnInteractiveMagnifyGlass Raises the InteractiveMagnifyGlass event.
Protected Method OnInteractiveModeChanged Raises the InteractiveModeChanged event.
Protected Method OnInteractiveModeEnded Raises the InteractiveModeEnded event.
Protected Method OnInteractiveModeMouseButtonChanged Raises the InteractiveModeMouseButtonChanged event.
Protected Method OnInteractivePage Raises the InteractivePage event.
Protected Method OnInteractivePan Raises the InteractivePan event.
Protected Method OnInteractiveRegionCombineModeChanged Raises the InteractiveRegionCombineModeChanged event.
Protected Method OnInteractiveRegionEllipse Raises the InteractiveRegionEllipse event.
Protected Method OnInteractiveRegionFreehand Raises the InteractiveRegionFreehand event.
Protected Method OnInteractiveRegionRectangle Raises the InteractiveRegionRectangle event.
Protected Method OnInteractiveRegionTypeChanged Raises the InteractiveRegionTypeChanged event.
Protected Method OnInteractiveScale Raises the InteractiveScale event.
Protected Method OnInteractiveUserRectangle Raises the InteractiveUserRectangle event.
Protected Method OnInteractiveZoomAt Raises the InteractiveZoomAt event.
Protected Method OnInteractiveZoomTo Raises the InteractiveZoomTo event.
Protected Method OnKeyDown This member overrides Control.OnKeyDown.
Protected Method OnLostFocus Occurs when the control loses focus.
Protected Method OnMagnifyGlassChanged Raises the MagnifyGlassChanged event.
Protected Method OnMouseDown Occurs when the user presses a mouse button.
Protected Method OnMouseMove Occurs when the user moves the mouse over the control.
Protected Method OnMouseUp Occurs when the user releases a mouse button.
Protected Method OnPaint Overrides Control.OnPaint.
Protected Method OnPaintPropertiesChanged Raises the PaintPropertiesChanged event.
Protected Method OnPostImagePaint Raises the PostImagePaint event.
Protected Method OnPreImagePaint Raises the PreImagePaint event.
Protected Method OnReadBindingData Raises the ReadBindingData event.
Protected Method OnRedirectImagePaint Raises the RedirectImagePaint event.
Protected Method OnScaleFactorChanged Raises the ScaleFactorChanged event.
Protected Method OnScrollPositionChanged Raises the ScrollPositionChanged event.
Protected Method OnScrollViewer Raises the ScrollViewer event.
Protected Method OnSizeChanged Occurs when the size of the control has changed.
Protected Method OnSizeModeChanged Raises the SizeModeChanged event.
Protected Method OnSourceRectangleChanged Raises the SourceRectangleChanged event.
Protected Method OnTransformChanged Raises the TransformChanged event.
Protected Method OnUseDpiChanged Raises the UseDpiChanged event.
Protected Method OnVerticalAlignModeChanged Raises the VerticalAlignModeChanged event.
Protected Method OnWriteBindingData Raises the WriteBindingData event.
Protected Method WndProc Overrides Control.WndProc.

Public Properties

Name Description
Public Property AnimateFloater Gets or sets a value indicating whether to animate the FloaterImage.
Public Property AnimateRegion Enables or disables animation of the image's region frame.
Public Property AutoDisposeImages Gets or sets a value indicating whether to auto dispose the old image when a new image is set into this RasterImageViewer.
Public Property AutoInteractiveMagnifyGlass Gets or sets a value that indicate whether to always show the magnify glass when the interactive mode is set to magnify glass.
Public Property AutoResetScaleFactor Enables or disables the automatic reset of the ScaleFactor property.
Public Property AutoResetScrollPosition Enables or disables the automatic reset of the ScrollPosition property.
Public Property AutoScroll Enables or disables scroll bars automatically appearing when the control contents are larger than its visible area
Public Property AutoScrollLargeChange Gets or sets the amount that the scroll bar is incremented or decremented for a large scroll.
Public Property AutoScrollMinSize Gets or sets the minimum size for the auto-scroll region.
Public Property AutoScrollSmallChange Gets or sets the amount that the scroll bar is incremented or decremented for a small scroll.
Public Property BindingData Gets or sets the extra data used when saving image to a data binding object.
Public Property BindingLoadBitsPerPixel Gets or sets the image bits per pixel used when loading images from a data binding object.
Public Property BindingRasterCodecs Gets or sets the Leadtools.Codecs.RasterCodecs object used with data binding.
Public Property BindingSaveBitsPerPixel Gets or sets the image bits per pixel used when saving images to a data binding object.
Public Property BindingSaveImageFormat Gets or sets the Leadtools.RasterImageFormat used when saving images to a data binding object.
Public Property BorderPadding Gets the viewer border padding.
Public Property BorderStyle Sets the border style of the control.
Public Property CenterZoomAtPointScaleFactor Gets or sets the scale factor used to zoom the image in the viewer around the center when CenterAtPoint is called.
Public Property CurrentXScaleFactor Gets or sets the current horizontal scale factor for the image display.
Public Property CurrentYScaleFactor Gets or sets the current vertical scale factor for the image display.
Public Property Cursor Gets or sets the cursor that is displayed when the mouse pointer is over the control.
Public Property DoubleBuffer Enables or disables double buffer painting, which eliminates flicker.
Public Property EnableScrollingInterface Gets or sets a value indicating whether the control automatically processes the keyboard and mousewheel.
Public Property EnableTimer Gets or sets a value indicating whether to enable the timer used when animating regions and floaters.
Public Property FloaterImage Gets or sets the floater image.
Public Property FloaterPosition Gets or sets the position of the floater.
Public Property FloaterVisible Gets or sets a value indicating whether to paint the FloaterImage
Public Property FrameColor Specifies the border color of the frame that you add to the control.
Public Property FrameShadowColor Specifies the shadow color of the frame that you add to the control.
Public Property FrameShadowSize Specifies the thickness of the shadow for the frame that you add to the control.
Public Property FramesIsPartOfImage Determines whether or not the frame is treated as part of the images's view.
Public Property FrameSize Specifies the thickness of the frame that you add to the Raster View Control.
Public Property HorizontalAlignMode Gets or sets a value to determine how to center the image in the control's client area horizontally, when the width of the destination rectangle is smaller than the width of the client area.
Public Property HScroll Gets a value indicating whether the horizontal scroll bar is visible.
Public Property Image Gets or sets the image currently assigned for display by the control.
Public Property ImageDpiX Gets the horizontal resolution of the of the current image in the viewer.
Public Property ImageDpiY Gets the vertical resolution of the of the current image in the viewer.
Public Property ImageSize Gets the size of the current image in the viewer.
Public Property InteractiveMode Gets or sets the value that controls user interaction with the control's display.
Public Property InteractiveModeMouseButton Gets or sets the current mouse button associated with the viewer interactive.
Public Property InteractiveRegionCombineMode Gets or sets the region Leadtools.RasterRegionCombineMode to be used when the user creates regions interactively.
Public Property InteractiveRegionType Gets or sets the value that determines the type of region to create when InteractiveMode is set to RasterViewerInteractiveMode.Region
Public Property IsImageAvailable Determines if the control currently has an Leadtools.RasterImage object available for display.
Public Property IsInteractiveModeBusy Determines if the control is currently performing an interactive operation.
Public Property LogicalViewRectangle Gets the logical view rectangle.
Public Property MagnifyGlass Gets or sets the RasterMagnifyGlass object used to perform Magnifying Glass operations for this RasterImageViewer.
Public Property PaintProperties Gets or sets the Leadtools.Drawing.RasterPaintProperties which control the display.
Public Property PhysicalViewRectangle Gets the physical view rectangle.
Public Property ScaleFactor The zoom factor used to display the image.
Public Property ScrollPosition Gets or sets the location of the auto-scroll position.
Public Property SizeMode Determines how the control displays the image and the automatic adjustments of the display rectangles.
Public Property SmallScrollChangeRatio Gets or sets the ratio of the AutoScrollSmallChange to the AutoScrollLargeChange.
Public Property SourceRectangle Represents the part of the image to use as the display source.
Public Property Transform Gets the display matrix for the viewer.
Public Property UseDpi Gets or sets a value that indicates whether LEAD's automated scaling properties are used to account for the physical resolution of the bitmap.
Public Property VerticalAlignMode Gets or sets a value to determine how to center the image in the control's client area vertically, when the height of the destination rectangle is smaller than the height of the client area.
Public Property VScroll Gets a value indicating whether the vertical scroll bar is visible.

Protected Properties

Name Description
Protected Property CreateParams Overrides Control.CreateParams.

Public Events

Name Description
Public Event AnimateFloaterChanged Occurs when the value of the AnimateFloater property changes.
Public Event AnimateRegionChanged Occurs when the value of the AnimateRegion property changes.
Public Event AutoDisposeImagesChanged Occurs when the value of the AutoDisposeImages property changes.
Public Event AutoInteractiveMagnifyGlassChanged Occurs when the value of the AutoInteractiveMagnifyGlass property changes.
Public Event AutoResetScaleFactorChanged Occurs when the value of the AutoResetScaleFactor property changes.
Public Event AutoResetScrollPositionChanged Occurs when the value of the AutoResetScrollPosition property changes.
Public Event AutoScrollChanged Occurs when the value of the AutoScroll property changes.
Public Event BorderStyleChanged Occurs when the value of the BorderStyle property changes.
Public Event CenterZoomAtPointScaleFactorChanged Occurs when the value of the CenterZoomAtPointScaleFactor property changes.
Public Event DoubleBufferChanged Occurs when the value of the DoubleBuffer property changes.
Public Event EnableScrollingInterfaceChanged Occurs when the value of the EnableScrollingInterface property changes.
Public Event EnableTimerChanged Occurs when the value of the EnableTimer property changes.
Public Event FloaterImageChanged Occurs when the value of the FloaterImage property changes.
Public Event FloaterPositionChanged Occurs when the value of the FloaterPosition property changes.
Public Event FloaterVisibleChanged Occurs when the value of the FloaterVisible property changes.
Public Event FrameColorChanged Occurs when the value of the FrameColor property changes.
Public Event FrameShadowColorChanged Occurs when the value of the FrameShadowColor property changes.
Public Event FrameShadowSizeChanged Occurs when the value of the FrameShadowSize property changes.
Public Event FramesIsPartOfImageChanged Occurs when the value of the FramesIsPartOfImage property changes.
Public Event FrameSizeChanged Occurs when the value of the FrameSize property changes.
Public Event HorizontalAlignModeChanged Occurs when the value of the HorizontalAlignMode property changes.
Public Event ImageChanged Occurs when the value of the Image property changes.
Public Event InteractiveCenterAt Occurs when the user performs interactive center of the image display.
Public Event InteractiveFloater Occurs when the user is using the InteractiveMode to move the FloaterImage.
Public Event InteractiveMagnifyGlass Occurs when the user is using the MagnifyGlass.
Public Event InteractiveModeChanged Occurs when the value of the InteractiveMode property changes.
Public Event InteractiveModeEnded Occurs when the operation of the current InteractiveMode ended successfully.
Public Event InteractiveModeMouseButtonChanged Occurs when the value of the InteractiveModeMouseButton property changes.
Public Event InteractivePage Occurs when the user performs interactive change of the current page using the mouse.
Public Event InteractivePan Occurs when the user performs interactive panning of the image display.
Public Event InteractiveRegionCombineModeChanged Occurs when the value of the InteractiveRegionCombineMode property changes.
Public Event InteractiveRegionEllipse Occurs when the user performs interactive creation of an elliptical region for the image.
Public Event InteractiveRegionFreehand Occurs when the user performs interactive creation of a freehand region for the image.
Public Event InteractiveRegionRectangle Occurs when the user performs interactive creation of a rectangular region for the image.
Public Event InteractiveRegionTypeChanged Occurs when the value of the InteractiveRegionType property changes.
Public Event InteractiveScale Occurs when the user performs interactive change of the current scale factor using the mouse.
Public Event InteractiveUserRectangle Occurs when the user performs user-defined interactive drawing of a rectangle.
Public Event InteractiveZoomAt Occurs when the user performs interactive center of the image display.
Public Event InteractiveZoomTo Occurs when the user performs interactive center of the image display.
Public Event MagnifyGlassChanged Occurs when the value of the MagnifyGlass property changes.
Public Event PaintPropertiesChanged Occurs when the value of the PaintProperties property changes.
Public Event PostImagePaint Occurs after painting the Image and the FloaterImage. Any additional painting should be done in this event.
Public Event PreImagePaint Occurs before immediately before the RasterImageViewer does any painting.
Public Event ReadBindingData Occurs before reading BindingData from a data binding object.
Public Event RedirectImagePaint Occurs after this RasterImageViewer calls RedirectPaint internally as of a paint event.
Public Event ScaleFactorChanged Occurs when the value of the ScaleFactor property changes.
Public Event ScrollPositionChanged Occurs when the value of the ScrollPosition property changes.
Public Event ScrollViewer Occurs when either the horizontal or vertical scroll bar of the RasterImageViewer changes.
Public Event SizeModeChanged Occurs when the value of the SizeMode property changes.
Public Event SourceRectangleChanged Occurs when the value of the SourceRectangle property changes.
Public Event TransformChanged Occurs when the value of the Transform property changes.
Public Event UseDpiChanged Occurs when the value of the UseDpi property changes.
Public Event VerticalAlignModeChanged Occurs when the value of the VerticalAlignMode property changes.
Public Event WriteBindingData Occurs before writing BindingData to a data binding object.

See Also

RasterImageViewer Class

Leadtools.WinForms Namespace

Help Version 22.0.2023.2.9
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.WinForms Assembly
Introduction
Getting Started
Namespaces
Leadtools.WinForms Namespace
Assemblies
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.