ImageViewer Class Methods

Summary

For a list of all members of this type, see ImageViewer members

Public Methods

Name Description
activeItemChanged.remove Occurs when the value of ActiveItem changes.
autoItemElementsAdded.remove Occurs after an item HTML elements are re-added to the DOM.
autoItemElementsRemoved.remove Occurs before an item HTML elements are re-deleted from the DOM.
beginAutoSizeChanged Disable detecting if the viewer size has changed.
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 LeadPointD 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.
disableTransitions Stops the viewer from updating the transformations matrices and view layout during CSS transitions.
dispose Destroys this ImageViewer and removes it from the page.
elementsUpdated.remove Occurs anytime the viewer changes any DOM or CSS property on an element that is part of view or any item
enableSync Re-enable syncing for a group.
enableTransitions Enable updating the transformations matrices and view layout during CSS transitions.
endAutoSizeChanged Enables detecting if the viewer size has changed.
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.
eraseBackground.remove Occurs when the control's background needs to be erased.
findNearestItem Gets the item nearest to the specified physical (in viewer pixel) coordinates.
foreCanvasSizeChanged.remove Occurs when the size of the foreground canvas changes.
getAllVisibleItems Gets all the visible items in the viewer.
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.
getItemImageTransformScaleOnly Transformation matrix of the image of an item without translation and rotation.
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.
imageLoading.remove Occurs just before an image starts loading as the result of a URL update.
interpolation.remove Occurs when the interpolator state changes.
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.
itemChanged.remove Occurs when any of the items inside this ImageViewer changes
itemDragDrop.remove Occurs when data is being dragged or dropped from/to this ImageViewer.
itemError.remove Occurs when an error happens when the viewer tries to update the item image data.
onActiveItemChanged Raises the ActiveItemChanged event.
onAutoItemElementsAdded Raises the AutoItemElementsAdded event.
onAutoItemElementsRemoved Raises the AutoItemElementsRemoved event.
onElementsUpdated Raises the ElementsUpdated event.
onEraseBackground Raises the EraseBackground event.
onForeCanvasSizeChanged Raises the ForeCanvasSizeChanged event.
onItemChanged Raises the ItemChanged event.
onItemDragDrop Raises the ItemDragDrop event.
onItemError Raises the ItemError event.
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 Inform the control that the size of the container has changed.
onTransformChanged Raises the OnTransformChanged event.
postRender.remove Occurs after the view is rendered.
postRenderItem.remove Occurs after an item is rendered.
preRender.remove Occurs before the view is rendered.
preRenderItem.remove Occurs before an item is rendered.
processDragDropUrl Processes the image dropped on this ImageViewer during a drag/drop operation.
propertyChanged.remove Occurs when a property value in this ImageViewerchanges.
redirectRender.remove Occurs when the viewer content has changed and any external controls performing live capture need to be updated.
render.remove Render the view.
renderBackground.remove Renders view or item background.
renderBorder.remove Renders view or item border.
renderError.remove Occurs when an error happens during rendering.
renderImage.remove Renders the item image.
renderItem.remove Occurs when an item is rendered.
renderItemFloater.remove Renders the item floater.
renderItemFloaterRegion.remove Renders the item floater region.
renderItemRegion.remove Renders the item region.
renderRedirect Render the content of the viewer to an external context.
renderShadow.remove Renders view or item or drop shadow.
renderText.remove Renders the item text.
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.
scrollOffsetChanged.remove Occurs when the value of ScrollOffset changes.
selectedItemsChanged.remove Occurs when any of the items inside this viewer selection state changes.
setItemFloater Sets the floater for an item.
sync Establishes sync groups.
transformChanged.remove Occurs when the transformation matrix of the view or any of the item changes.
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.
updateStyles Inform the viewer that the CSS classes used has been changed.
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.
Help Version 19.0.2017.10.27
Products | Support | Contact Us | Copyright Notices
© 1991-2017 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Controls Assembly