←Select platform

ImageViewer Class Members

Summary

The following tables list the members exposed by ImageViewer.

Public Constructors

Name Description
ImageViewer Initializes a new ImageViewer with the specified layout

Public Methods

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

Protected Methods

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

Public Properties

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

Protected Properties

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

Public Events

Name Description
ActiveItemChanged Occurs when the value of ActiveItem changes.
ItemChanged Occurs when any of the items inside this ImageViewer changes
ItemDragDrop Occurs when data is being dragged or dropped from/to this ImageViewer.
ItemError Occurs when an error happens when the viewer tries to update the item image data.
PostRender Occurs after the view is rendered.
PostRenderItem Occurs after an item is rendered.
PreRender Occurs before the view is rendered.
PreRenderItem Occurs before an item is rendered.
PropertyChanged Occurs when a property value in this ImageViewerchanges.
RedirectRender Occurs when the viewer content has changed and any external controls performing live capture need to be updated.
Render Render the view.
RenderBackground Renders view or item background.
RenderBorder Renders view or item border.
RenderError Occurs when an error happens during rendering.
RenderImage Renders the item image.
RenderItem Occurs when an item is rendered.
RenderItemFloater Renders the item floater.
RenderItemFloaterRegion Renders the item floater region.
RenderItemRegion Renders the item region.
RenderShadow Renders view or item or drop shadow.
RenderText Renders the item text.
ScrollOffsetChanged Occurs when the value of ScrollOffset changes.
SelectedItemsChanged Occurs when any of the items inside this viewer selection state changes.
TransformChanged Occurs when the transformation matrix of the view or any of the item changes.
VirtualizeItemReady Occurs when the virtualizer has an item ready to be rendered.
Help Version 19.0.2017.10.27
Products | Support | Contact Us | Copyright Notices
© 1991-2017 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Controls.WinForms Assembly
Introduction
Getting Started
Namespaces
Leadtools.Controls Namespace
Assemblies