Leadtools.Controls Namespace : ImageViewer Object |
The following tables list the members exposed by ImageViewer.
Name | Description | |
---|---|---|
ImageViewer Constructor | Initializes a new ImageViewer |
Name | Description | |
---|---|---|
ActiveItem | Active item of this image viewer. | |
ActiveItemBackgroundColor | Active item background color. | |
ActiveItemBorderColor | Active item border color. | |
AllowDrop | Indicates whether the viewer can accept data that the user drags onto it. | |
AspectRatioCorrection | Manual aspect ratio correction value | |
AutoCreateCanvas | Indicates whether to automatically create the HTML5 Canvas Element when the image is updated. | |
AutoResetOptions | Determines which display properties to reset when a new image is set into the viewer (single item mode). | |
AutoScrollDiv | Auto Scroll HTML Div Element. | |
BackImage | Optional background element to be displayed in the viewer (single item mode). | |
BackImageLoadImageUrlMode | Specifies how an image should be loaded when this item is provided a URL (single item mode) | |
BackImageUrl | URL to the optional background image to displayed in the viewer (single item mode). | |
Canvas | HTML5 Canvas Element to be displayed in the viewer (single item mode). | |
ClipImageToContent | Indicates whether to clip the image outside the content area if ResizeOnTransform was set to false. | |
ControlSize | Control size. | |
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 | |
Element | The HTML or SVG Element to be displayed in the viewer (single item mode). | |
EnableRequestAnimationFrame | Indicates whether the ImageViewer should use HTML5 requestAnimationFrame when rendering the image. | |
EraseBackgroundOnInvalidate | Indicates whether the ImageViewer will clear the foreground canvas prior to rendering. | |
EventCanvas | The Background HTML5 Canvas Element. | |
Flip | Flip the view vertically. | |
FlipImageElement | Flip the image vertically without the border. | |
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). | |
ForeCanvas | The Foreground HTML5 Canvas Element. | |
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 the ControlSize 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 | The HTML Image Element 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. | |
ImageProcessingLibrariesPath | Path to the image processing library script files. | |
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). | |
ImagesDiv | Internally used for loading SVG documents with embedded images. | |
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. | |
InterpolationMode | Interpolation mode used by this ImageViewer. | |
InterpolationRunMode | Interpolation run mode used by this ImageViewer. | |
Invert | Indicates whether to invert the items images. | |
IsRenderRedirected | Gets a value that indicate whether the current rendering operation is targetting an external device rather the control itself. | |
IsTransitionsEnabled | Detect if the image viewer is in a state where CSS transition detection is enabled. | |
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 colletion 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. | |
LoadImageUrlMode | Specifies how an image should be loaded when this item is provided a URL (single item mode) | |
MainDiv | Main HTML Div Element. | |
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. | |
PassthroughDiv | An HTML Div Element used for assistance with pointer events capture. | |
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. | |
ReverseImageElement | Reverse the image horizontally without the border. | |
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 than the 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. | |
Tag | Object that contains data about the control. | |
TextHorizontalAlignment | Specifies how to align the text inside their items horizontally. | |
TextVerticalAlignment | Specifies how to align the text inside their items vertically. | |
UpdateShadowOnRotation | Indicate whether to update the CSS values for the box-shadow property of each item border element. | |
UseDpi | Indicates whether the control must account for the physical resolution of the images when calculating the display properties. | |
UseElements | Checks if the viewer is using the Elements Mode. | |
ViewBorderColor | View border color. | |
ViewBorderThickness | View border thickness. | |
ViewBounds | Current view bounds. | |
ViewDiv | Holds the item elements and shows the viewer's view margin, view padding, view border, and view box shadow. | |
ViewDivHolder | Parent of the image viewer ImageViewer.ViewDiv. | |
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. | |
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. |
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. |
Name | Description | |
---|---|---|
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. | |
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. | |
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. | |
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. | |
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. | |
OnSizeChanged | Inform the control that the size of the container has changed. | |
OnTransformChanged | Raises the OnTransformChanged 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. | |
TranslateItemScaleFactor | Translates an item horizontally or vertically a given amount of pixels regardless of the current zoom value. | |
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. |
Name | Description | |
---|---|---|
ActiveItemChanged | Occurs when the value of ActiveItem changes. | |
AutoItemElementsAdded | Occurs after an item HTML elements are re-added to the DOM. | |
AutoItemElementsRemoved | Occurs before an item HTML elements are re-deleted from the DOM. | |
ElementsUpdated | Occurs anytime the viewer changes any DOM or CSS property on an element that is part of view or any item | |
EraseBackground | Occurs when the control's background needs to be erased. | |
ForeCanvasSizeChanged | Occurs when the size of the foreground canvas changes. | |
ImageLoading | Occurs just before an image starts loading as the result of a URL update. | |
Interpolation | Occurs when the interpolator state 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. |