←Select platform
In This Topic ▼

ImageViewer Class Members

Summary

The following tables list the members exposed by ImageViewer.

Public Constructors

Name Description
Public Constructor ImageViewer Initializes a new ImageViewer with the specified layout

Public Methods

Name Description
Public Method BeginRender Stops the viewer from rendering the content if any change is applied. This is useful to increase the control's speed efficiency.
Public Method BeginTransform Stops the viewer from updating the transformation matrices and updating the view layout. This is useful to increase the control's speed efficiency.
Public Method BeginUpdate Stops the viewer from updating the transformation matrices, view layout and rendering the content if any change is applied. This is useful to increase the control's speed efficiency.
Public Method CenterAtPoint Centers the view display at the specified point.
Public Method CombineFloater Combines the floaters with the images for all items inside this ImageViewer.
Public Method ConvertBoundsToView Converts a rectangle value from logical (excluding the current transformation) to physical (in control pixel coordinates).
Public Method ConvertPoint Converts a LeadPointD from one coordinates to the other.
Public Method ConvertPoints Converts an array of LeadPoint from one coordinates to the other.
Public Method ConvertRect Converts a LeadRectD from one coordinates to the other.
Public Method ConvertTransform Converts a transformation matrix relative to one item to another.
Public Method static | Shared in VB DisableSync Temporarily disable syncing for a group while keeping the group itself intact.
Public Method static | Shared in VB EnableSync Re-enable syncing for a group.
Public Method EndRender Instructs the viewer that updates are completed and rendering of content can be resumed.
Public Method EndTransform Instructs the viewer that updates are completed and updating transformations and view layout can be resumed.
Public Method EndUpdate Instructs the viewer that updates are completed and updating the transformation matrices, view layout and rendering of content can be resumed.
Public Method EnsureBoundsVisible Ensures that the specified rectangle area is visible in the viewer.
Public Method EnsureItemVisible Ensures that an item is visible in the viewer.
Public Method EnsureItemVisibleByIndex Ensures that the item at the specified index is visible in the viewer.
Public Method FindNearestItem Gets the item nearest to the specified physical (in viewer pixel) coordinates.
Public Method GetAllVisibleItems Gets an array of all the visible ImageViewerItems for the specified ImageViewerItemPart.
Public Method static | Shared in VB GetDestinationRectangle Utility method to adjust the given LeadRectD based on source size, size mode and alignment
Public Method GetFirstVisibleItem First visible item or part of it in the viewer.
Public Method GetFirstVisibleItemIndex Index for the first visible item or part of it in the viewer.
Public Method GetImageTransformWithDpi Transformation matrix of the image with or without DPI scaling (single item mode).
Public Method GetItemBounds Current logical (excluding the current transformation) bounds of any part of an item.
Public Method GetItemContentTransform Transformation matrix of the content of an item.
Public Method GetItemFloaterSize Floater image size of an item.
Public Method GetItemFloaterTransform Transformation matrix of the floater of an item.
Public Method GetItemImageFloatingPointTransform Transformation matrix of the image of an item without rounded values.
Public Method GetItemImageSize Image size of an item.
Public Method GetItemImageTransform Transformation matrix of the image of an item.
Public Method GetItemImageTransformWithDpi Transformation matrix of the image of an item with or without DPI scaling.
Public Method GetItemTransform Transformation matrix of the whole item.
Public Method GetItemViewBounds Current physical (in control pixel coordinates) bounds of any part of an item.
Public Method GetLargestVisibleItem Largest visible item or part of it in the viewer.
Public Method GetLargestVisibleItemIndex Index for the largest visible item or part of it in the viewer.
Public Method GetLastVisibleItem Last visible item or part of it in the viewer.
Public Method GetLastVisibleItemIndex Index for the last visible item or part of it in the viewer.
Public Method static | Shared in VB GetScaleFactors Utility method to calculate the scale factor needed to perform the specified size mode using a source and destination size.
Public Method static | Shared in VB GetSynced Returns a list of all ImageViewer instances that match the given sync.
Public Method GetViewBounds Current bounds of the view in physical (in control pixel) coordinates.
Public Method GotoItem Scroll to the top-left of an item.
Public Method GotoItemByIndex Scroll to the top-left of an item giving its index.
Public Method HitTestFloater First item that has its floater under a physical (in viewer pixel) coordinates.
Public Method HitTestItem First item that is under a physical (in viewer pixel) coordinates.
Public Method HitTestItemPart Specific part of the item under a physical (in viewer pixel) coordinates.
Public Method HitTestItems Items that intersect with a rectangle in physical (in viewer pixel) coordinates.
Public Method Invalidate Invalidates a portion of the entire surface of the control and causes the control to be redrawn.
Public Method InvalidateItem Invalidate an item.
Public Method InvalidateItemByIndex Invalidate the item at the specified index.
Public Method IsItemVisible Gets a value that indicates whether the specified item or part is currently visible in the viewer.
Public Method static | Shared in VB IsSyncDisabled Determines if syncing for a group has been disabled.
Public Method OnTransformChanged Raises the TransformChanged event.
Public Method OnVirtualizeItemReady Raises the VirtualizeItemReady event.
Public Method RenderRedirect Render the content of the viewer to an external context.
Public Method Reset Resets the display properties to their default values (single item mode).
Public Method RestrictScrollOffset Ensures a scroll position is inside the minimum and maximum scroll value currently allowed.
Public Method ScrollBy Scrolls the viewer by the specified amount in pixels.
Public Method ScrollByRestrict Scrolls the viewer by the specified amount in pixels while always restricting the value to the current minimum and maximum allowed.
Public Method StopInertiaScroll Stops any inertia scrolling.
Public Method static | Shared in VB Sync Establishes sync groups.
Public Method TranslateItemScaleFactor Translates an item horizontally or vertically a given amount of pixels regardless of the current zoom value.
Public Method static | Shared in VB Unsync Removes a single viewer from the sync group.
Public Method static | Shared in VB UnsyncGroup Un-syncs all members of the sync group of the given sync ID.
Public Method UpdateTransform Re-calculates the transformation matrices and update the view layout.
Public Method Zoom Zooms or changes the size mode of the view.
Public Method ZoomToRect Zooms the view to the specified rectangle.

Protected Methods

Name Description
Protected Method Dispose(bool) Clean up any resources being used.
Protected Method GetItemImageTransformScaleOnly Transformation matrix of the image of an item without translation and rotation.
Protected Method IsInputKey Overrides System.Windows.Forms.Control.IsInputKey(System.Windows.Forms.Keys).
Protected Method OnActiveItemChanged Raises the ActiveItemChanged event.
Protected Method OnDragDrop Overrides System.Windows.Forms.Control.OnDragDrop(System.Windows.Forms.DragEventArgs).
Protected Method OnDragEnter Overrides System.Windows.Forms.Control.OnDragEnter(System.Windows.Forms.DragEventArgs).
Protected Method OnDragLeave Overrides System.Windows.Forms.Control.OnDragLeave(System.EventArgs).
Protected Method OnDragOver Overrides System.Windows.Forms.Control.OnDragOver(System.Windows.Forms.DragEventArgs).
Protected Method OnItemChanged Raises the ItemChanged event.
Protected Method OnItemDragDrop Raises the ItemDragDrop event.
Protected Method OnItemError Raises the ItemError event.
Protected Method OnMouseDown Overrides System.Windows.Forms.Control.OnMouseDown(System.Windows.Forms.MouseEventArgs).
Protected Method OnPaint Overrides System.Windows.Forms.Control.OnPaint(System.Windows.Forms.PaintEventArgs).
Protected Method OnPaintBackground Overrides System.Windows.Forms.Control.OnPaintBackground(System.Windows.Forms.PaintEventArgs).
Protected Method OnPostRender Raises the PostRender event.
Protected Method OnPostRenderItem Raises the PostRenderItem event.
Protected Method OnPreRender Raises the PreRender event.
Protected Method OnPreRenderItem Raises the PreRenderItem event.
Protected Method OnPropertyChanged Raises the PropertyChanged event.
Protected Method OnRedirectRender Raises the RedirectRender event.
Protected Method OnRender Raises the Render event.
Protected Method OnRenderBackground Raises the RenderBackground event.
Protected Method OnRenderBorder Raises the RenderBorder event.
Protected Method OnRenderError Raises the RenderError event.
Protected Method OnRenderImage Raises the RenderImage event.
Protected Method OnRenderItem Raises the RenderItem event.
Protected Method OnRenderItemFloater Raises the RenderItemFloater event.
Protected Method OnRenderItemFloaterRegion Raises the RenderItemFloaterRegion event.
Protected Method OnRenderItemRegion Raises the RenderItemRegion event.
Protected Method OnRenderShadow Raises the RenderShadow event.
Protected Method OnRenderText Raises the RenderText event.
Protected Method OnScrollOffsetChanged Raises the ScrollOffsetChanged event.
Protected Method OnSelectedItemsChanged Raises the SelectedItemsChanged event.
Protected Method OnSizeChanged Overrides System.Windows.Forms.Control.OnSizeChanged(System.EventArgs).
Protected Method ProcessDropImage Processes the image dropped on this ImageViewer during a drag/drop operation.
Protected Method WndProc Overrides System.Windows.Forms.Control.WndProc(System.Windows.Forms.Message@).

Public Properties

Name Description
Public Property ActiveItem Active item of this image viewer.
Public Property ActiveItemBackgroundColor Active item background color.
Public Property ActiveItemBorderColor Active item border color.
Public Property AspectRatioCorrection Manual aspect ratio correction value
Public Property AutoDisposeImages Indicates whether to automatically dispose item images, SVG documents and floaters.
Public Property AutoResetOptions Determines which display properties to reset when a new image is set into the viewer (single item mode).
Public Property AutoScroll Indicates whether the viewer will automatically show the standard scrollbars when the view size is larger than the client size.
Public Property BackImage Optional background image to be displayed in the viewer (single item mode).
Public Property BackImageUrl URL to the optional background image to be displayed in the viewer (single item mode).
Public Property BorderStyle Border style of the control.
Public Property ClipImageToContent Indicates whether to clip the image outside the content area if ResizeOnTransform was set to false.
Public Property DefaultInteractiveMode Default interactive mode.
Public Property DefaultZoomOrigin Origin of the default zoom point for current horizontal and vertical alignment, in control pixel coordinates.
Public Property DropCopyKeyState Modifier key used to initiate a copy drop operation.
Public Property DropLinkKeyState Modifier key used to initiate a link drop operation.
Public Property DropMoveKeyState Modifier key used to initiate a move drop operation.
Public Property Flip Flip the view vertically.
Public Property Floater Floater image (single item mode).
Public Property FloaterOpacity Opacity used when rendering the floaters in this ImageViewer.
Public Property FloaterRegionRenderMode Indicates how floater regions are rendered.
Public Property FloaterTransform Transformation matrix used by the floater image (single item mode).
Public Property HasImage Gets a value that indicates if the viewer currently has an image (single item mode).
Public Property HasItems Gets a value that indicates whether this viewer has any items.
Public Property HasSize Whether or not this control has a valid size.
Public Property HitTestStateInteractiveMode The ImageViewerInteractiveMode that is currently in a hit-test state.
Public Property HoveredItemBackgroundColor Hovered item's background color.
Public Property HoveredItemBorderColor Hovered item's border color.
Public Property IdleInteractiveMode The ImageViewerInteractiveMode that is currently acting as the first idle mode.
Public Property Image Image to be displayed in the viewer (single item mode).
Public Property ImageBackgroundColor Image's background color.
Public Property ImageBorderColor Image's border color.
Public Property ImageBorderThickness Image's border thickness.
Public Property ImageBounds Physical position and size of the image in the viewer (single item mode).
Public Property ImageDropShadow Image's drop shadow properties.
Public Property ImageHorizontalAlignment Specifies how to align the images inside their items horizontally.
Public Property ImageRegionRenderMode Indicates how image regions are rendered.
Public Property ImageResolution Resolution in dots/inch (or DPI) of the image (single item mode).
Public Property ImageScale Optional scale value to use when rendering the images (single item mode).
Public Property ImageSize Size of the image in the viewer (single item mode).
Public Property ImageTransform Current transformation matrix used for displaying the image (single item mode).
Public Property ImageUrl URL to the image to be displayed in the viewer (single item mode).
Public Property ImageVerticalAlignment Specifies how to align the images inside their items vertically.
Public Property InteractiveModes The list of interactive modes in this ImageViewer.
Public Property InteractiveService The InteractiveService for this viewer control.
Public Property Invert Indicates whether to invert the item's images.
Public Property IsRenderRedirected Gets a value that indicates whether the current rendering operation is targeting an external device rather than the control itself.
Public Property IsSyncSource Indicates that this image viewer can act as a sync source.
Public Property IsSyncTarget Indicates that this image viewer can act as a sync target.
Public Property ItemBackgroundColor Default item's background color.
Public Property ItemBorderColor Default item's border color.
Public Property ItemBorderThickness Item's border thickness.
Public Property ItemHorizontalAlignment Specifies how to align the items inside the view horizontally.
Public Property ItemMargin Margins to use between the view and the items.
Public Property ItemPadding Padding to use between the item's border and the content.
Public Property Items The collection of items in this ImageViewer
Public Property ItemSize Default item size.
Public Property ItemSizeMode Indicates how the images are displayed inside their items.
Public Property ItemSpacing Spacing to use between neighboring items.
Public Property ItemTextColor Default item's text color.
Public Property ItemTextFont Item's text font.
Public Property ItemTextTrimming Item's text trimming options.
Public Property ItemTextWrap Indicates whether the item's text should automatically wrap to the next line if needed.
Public Property ItemVerticalAlignment Specifies how to align the items inside the view vertically.
Public Property LoadImageUrlAsSvg Indicates whether to load the image URL as SVG.
Public Property MaximumScaleFactor Maximum scale factor allowed.
Public Property MaximumScrollSize Current maximum scroll size allowed.
Public Property MinimumScaleFactor Minimum scale factor allowed.
Public Property OwnerDraw Indicates whether the control automatically renders the view and items.
Public Property PageRasterizer IPageRasterizer to be displayed in the viewer (single item mode).
Public Property PaintProperties Options used by this viewer when rendering RasterImage objects.
Public Property RasterCodecsInstance The RasterCodecs instance used to load raster images and SVG documents.
Public Property ResizeOnTransform Indicates whether the viewer should change the size of the scrolling area when an item is transformed.
Public Property RestrictScroll Indicates whether scrolling or panning the view outside the maximum range is allowed.
Public Property Reverse Reverse the view horizontally.
Public Property RotateAngle Value of the rotation angle to use when displaying the view.
Public Property ScaleFactor Value of the scale factor for the view display.
Public Property ScreenDpi Current screen resolution in dots per inch (or DPI).
Public Property ScrollMode Determines how the control handles scrollbars when the current transformation results in a view area that is larger than the control's size.
Public Property ScrollOffset Scroll offset value.
Public Property SelectedItemBackgroundColor Selected item's background color.
Public Property SelectedItemBorderColor Selected item's border color.
Public Property SelectedItemTextColor Selected item's text color.
Public Property SizeMode Gets a value that determines how the control displays the view and adjusts the display automatically.
Public Property SvgDocument SVG document to be displayed in the viewer (single item mode).
Public Property SyncId Gets the sync ID of this image viewer.
Public Property Text Overrides System.Windows.Forms.Control.Text.
Public Property TextHorizontalAlignment Specifies how to align the text inside their items horizontally.
Public Property TextVerticalAlignment Specifies how to align the text inside their items vertically.
Public Property Transition Gets or sets the Leadtools.Windows.Media.Transitions.TransitionBase that specifies the type of transition or animation to be applied on this control.
Public Property UseDpi Indicates whether the control must account for the physical resolution of the images when calculating the display properties.
Public Property ViewBorderColor View border color.
Public Property ViewBorderThickness View border thickness.
Public Property ViewBounds Current view bounds.
Public Property ViewDropShadow View drop shadow properties.
Public Property ViewHorizontalAlignment Specifies how to align the view inside the control horizontally.
Public Property ViewLayout View layout used by this ImageViewer.
Public Property ViewMargin Margins to use between the control boundary and the view.
Public Property ViewPadding Padding to use between the view border and the items.
Public Property ViewSize Current view size in pixels.
Public Property ViewTransform Current transformation matrix of the view.
Public Property ViewVerticalAlignment Specifies how to align the view inside the control vertically.
Public Property Virtualizer Optional virtualizer object that can be used to load a large amount of image data in this ImageViewer.
Public Property WorkingInteractiveMode The ImageViewerInteractiveMode that is currently processing the input events (working).
Public Property XScaleFactor Value of the horizontal scale factor for the view display.
Public Property YScaleFactor Value of the vertical scale factor for the view display.

Protected Properties

Name Description
Protected Property CanRender Gets a value that indicates if the ImageViewer will render the content when changes are made to the control's properties or to the items.
Protected Property CanTransform Gets a value that indicates if the ImageViewer will update the transformation matrices and view layout when changes are made to the control's properties or to the items.
Protected Property CreateParams Overrides System.Windows.Forms.Control.CreateParams.

Public Events

Name Description
Public Event ActiveItemChanged Occurs when the value of ActiveItem changes.
Public Event ItemChanged Occurs when any of the items inside this ImageViewer changes.
Public Event ItemDragDrop Occurs when data is being dragged or dropped from/to this ImageViewer.
Public Event ItemError Occurs when an error happens when the viewer tries to update the item image data.
Public Event PostRender Occurs after the view is rendered.
Public Event PostRenderItem Occurs after an item is rendered.
Public Event PreRender Occurs before the view is rendered.
Public Event PreRenderItem Occurs before an item is rendered.
Public Event PropertyChanged Occurs when a property value in this ImageViewer changes.
Public Event RedirectRender Occurs when the viewer content has changed and any external controls performing live capture need to be updated.
Public Event Render Render the view.
Public Event RenderBackground Renders view or item background.
Public Event RenderBorder Renders view or item border.
Public Event RenderError Occurs when an error happens during rendering.
Public Event RenderImage Renders the item image.
Public Event RenderItem Occurs when an item is rendered.
Public Event RenderItemFloater Renders the item floater.
Public Event RenderItemFloaterRegion Renders the item floater region.
Public Event RenderItemRegion Renders the item region.
Public Event RenderShadow Renders view or item or drop shadow.
Public Event RenderText Renders the item text.
Public Event ScrollOffsetChanged Occurs when the value of ScrollOffset changes.
Public Event SelectedItemsChanged Occurs when any of the items inside this viewer selection state changes.
Public Event TransformChanged Occurs when the transformation matrix of the view or any of the item changes.
Public Event VirtualizeItemReady Occurs when the virtualizer has an item ready to be rendered.

See Also

Reference

ImageViewer Class

Leadtools.Controls Namespace

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

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