Click or drag to resize

WebImageViewer Class

A scrollable, zoomable viewport for displaying and processing images server-side.

Inheritance Hierarchy

Namespace:  Atalasoft.Imaging.WebControls
Assembly:  Atalasoft.dotImage.WebControls (in Atalasoft.dotImage.WebControls.dll) Version: 11.0.0.0.0.297 (.NET 4.5.2, x86)
Syntax
public class WebImageViewer : WebViewerControl

The WebImageViewer type exposes the following members.

Constructors
  NameDescription
Public methodWebImageViewer
Initializes a new instance of the WebImageViewer control.
Top
Properties
  NameDescription
Public propertyAccessKey
Gets or sets the access key that allows you to quickly navigate to the Web server control.
(Inherited from WebControl.)
Protected propertyAdapter
Gets the browser-specific adapter for the control.
(Inherited from Control.)
Public propertyCode exampleAntialiasDisplay
Gets or sets the quality of the scaled image.
Public propertyAppRelativeTemplateSourceDirectory
Gets or sets the application-relative virtual directory of the Page or UserControl object that contains this control.
(Inherited from Control.)
Public propertyAttributes
Gets the collection of arbitrary attributes (for rendering only) that do not correspond to properties on the control.
(Inherited from WebControl.)
Public propertyCode exampleAutoZoom
Gets or sets a value indicating how the image should be zoomed as the control is resized or the image size changes.
Public propertyBackColor
Gets or sets the background color of the Web server control.
(Inherited from WebControl.)
Public propertyBindingContainer
Gets the control that contains this control's data binding.
(Inherited from Control.)
Public propertyBorderColor
Gets or sets the border color of the Web control.
(Inherited from WebControl.)
Public propertyBorderStyle
Gets the border style used for this control.
(Inherited from WebViewerControl.)
Public propertyBorderWidth
Gets or sets the border width of the Web server control.
(Inherited from WebControl.)
Protected propertyBrowserExtension
Gets the file extension.
(Inherited from WebViewerControl.)
Public propertyBrowserFormat
Gets or sets the format of the images created for browser output.
(Inherited from WebViewerControl.)
Protected propertyCacheDisabled
Gets a value indicating if the cache is disabled.
(Inherited from WebViewerControl.)
Protected propertyCacheImageUrl
Gets or sets a URL used to represent the lossless version of the ImageUrl.
Public propertyCacheLevels
The number of images to cache on the server, per control, per session. Default value is 2.
(Inherited from WebViewerControl.)
Public propertyCachePath
The path where images and tiles are cached. This is set in the web.config with the appSetting AtalasoftWebControls_Cache.
(Inherited from WebViewerControl.)
Public propertyCaption
Gets or sets the text to be included below the control.
(Inherited from WebViewerControl.)
Public propertyCentered
Gets or sets a value indicating if the content is centered in the control.
(Inherited from WebViewerControl.)
Protected propertyChildContent
Gets or sets the child content.
(Inherited from WebViewerControl.)
Protected propertyChildControlsCreated
Gets a value that indicates whether the server control's child controls have been created.
(Inherited from Control.)
Public propertyClientID
Gets the server control identifier generated by ASP.NET.
(Inherited from WebViewerControl.)
Public propertyClientIDMode
Gets or sets the algorithm that is used to generate the value of the ClientID property.
(Inherited from Control.)
Protected propertyClientIDSeparator
Gets a character value representing the separator character used in the ClientID property.
(Inherited from Control.)
Protected propertyClientScripts
Gets a collection od client scripts.
(Inherited from WebViewerControl.)
Protected propertyContext
Gets the HttpContext object associated with the server control for the current Web request.
(Inherited from Control.)
Public propertyControls
Gets a ControlCollection object that represents the child controls for a specified server control in the UI hierarchy.
(Inherited from WebViewerControl.)
Public propertyControlStyle
Gets the style of the Web server control. This property is used primarily by control developers.
(Inherited from WebControl.)
Public propertyControlStyleCreated
Gets a value indicating whether a Style object has been created for the ControlStyle property. This property is primarily used by control developers.
(Inherited from WebControl.)
Protected propertyControlTable
Gets the table of controls.
(Inherited from WebViewerControl.)
Public propertyCssClass
Gets or sets the Cascading Style Sheet (CSS) class rendered by the Web server control on the client.
(Inherited from WebControl.)
Protected propertyCurrentExecutionPath
Gets the current execution path.
(Inherited from WebViewerControl.)
Public propertyCurrentPage
Gets a value indicating the current page of a multi-page image being viewed in this control.
Public propertyDataItemContainer
Gets a reference to the naming container if the naming container implements IDataItemContainer.
(Inherited from Control.)
Public propertyDataKeysContainer
Gets a reference to the naming container if the naming container implements IDataKeysControl.
(Inherited from Control.)
Protected propertyDesignMode
Gets a value indicating whether a control is being used on a design surface.
(Inherited from Control.)
Protected propertyDesignTimeViewPort
Gets the design-time viewport.
(Inherited from WebViewerControl.)
Public propertyDomain
Allows cross domain scripting for the specified domain.
(Inherited from WebViewerControl.)
Public propertyEnableClientEvents Obsolete.
Enables the usage of events coming from the client without postbacks. (Obsolete.)
Public propertyEnabled
Gets or sets a value indicating whether the Web server control is enabled.
(Inherited from WebControl.)
Public propertyEnableServerAntialias Obsolete.
Enables server antialiasing for the FullClient ScrollbarType. (Obsolete.)
Public propertyEnableTheming
Gets or sets a value indicating whether themes apply to this control.
(Inherited from WebControl.)
Public propertyEnableViewState
Gets or sets a value indicating whether the server control persists its view state, and the view state of any child controls it contains, to the requesting client.
(Inherited from Control.)
Protected propertyEvents
Gets a list of event handler delegates for the control. This property is read-only.
(Inherited from Control.)
Public propertyFont
Gets the font properties associated with the Web server control.
(Inherited from WebControl.)
Public propertyForeColor
Gets or sets the foreground color (typically the color of the text) of the Web server control.
(Inherited from WebControl.)
Protected propertyFullClientIFrame
Gets the client IFrame element.
(Inherited from WebViewerControl.)
Public propertyHasAttributes
Gets a value indicating whether the control has attributes set.
(Inherited from WebControl.)
Protected propertyHasChildViewState
Gets a value indicating whether the current server control's child controls have any saved view-state settings.
(Inherited from Control.)
Protected propertyHasResponded
Gets a value indicating that a response has been sent.
(Inherited from WebViewerControl.)
Public propertyHeight
Gets or sets the height of the Web server control.
(Inherited from WebControl.)
Public propertyID
Gets or sets the programmatic identifier assigned to the server control.
(Inherited from Control.)
Protected propertyIdSeparator
Gets the character used to separate control identifiers.
(Inherited from Control.)
Public propertyCode exampleImage
Gets or sets the current AtalaImage displayed in this control
Public propertyImageDisplayOrder
Defines the way tiles are loaded in the viewport. Using ImageDisplayOrder.Sequential will reduce performance, OnDemand is the most efficient.
Protected propertyImageInfo
Gets the image info
Public propertyImagePosition
A value indicating the position of the image relative to the top left position of the scrollport.
Protected propertyImageSource
Gets or sets the image source.
Protected propertyImageSourceDataUrl
Gets the image source URL.
Public propertyImageUrl
Gets or sets the location of an image to display in the WebImageViewer control.
Protected propertyIsChildControlStateCleared
Gets a value indicating whether controls contained within this control have control state.
(Inherited from Control.)
Public propertyIsDesignTime
Gets or sets a value indicating the control is in design time.
(Inherited from WebViewerControl.)
Protected propertyIsDirty
Gets or sets a value indicating that modifications have been made since the last save.
Protected propertyIsDisposed
Gets a value indicating the object has been disposed.
(Inherited from WebViewerControl.)
Protected propertyIsEnabled
Gets a value indicating whether the control is enabled.
(Inherited from WebControl.)
Protected propertyIsPartialPost
Gets a value indicating it is a partial post.
(Inherited from WebViewerControl.)
Protected propertyIsQueryStringLoaded
Gets a value indicating the query string was loaded.
(Inherited from WebViewerControl.)
Protected propertyIsTrackingViewState
Gets a value that indicates whether the server control is saving changes to its view state.
(Inherited from Control.)
Protected propertyIsViewStateEnabled
Gets a value indicating whether view state is enabled for this control.
(Inherited from Control.)
Protected propertyLoadViewStateByID
Gets a value indicating whether the control participates in loading its view state by ID instead of index.
(Inherited from Control.)
Protected propertyLogging
Gets a value indicating that logging is performed.
(Inherited from WebViewerControl.)
Public propertyMouseTool
Gets a value indicating the behavior of the mouse when interacting with the viewport.
Public propertyNamingContainer
Gets a reference to the server control's naming container, which creates a unique namespace for differentiating between server controls with the same ID property value.
(Inherited from Control.)
Protected propertyOuterTable
Gets the outer table.
(Inherited from WebViewerControl.)
Public propertyPage
Gets a reference to the Page instance that contains the server control.
(Inherited from Control.)
Public propertyParent
Gets a reference to the server control's parent control in the page control hierarchy.
(Inherited from Control.)
Public propertyCode examplePathToResources Obsolete.
Gets or sets the virtual path to where the image, script, and cursor files are located. (Obsolete.)
(Inherited from WebViewerControl.)
Protected propertyPixelFormat
Gets the pixel format.
(Overrides WebViewerControlPixelFormat.)
Public propertyPreCacheTiles
A value from the PreCacheMode to set whether this control creates tiles in the cache or on demand. When set to Always, it creates tiles in the image cache, and when set to Never, it creates the tiles on demand. The value Always greatly increases panning speed and makes better use of memory, but can cause an initial delay.
Public propertyCode exampleRedosAvailable
Returns the number of Redos available from the cache.
Public propertyRenderingCompatibility
Gets a value that specifies the ASP.NET version that rendered HTML will be compatible with.
(Inherited from Control.)
Public propertyResourcePath
The path to the javascript and image resources needed by this control. It is set with the web.config property AtalasoftWebControls_ResourcePath.
(Inherited from WebViewerControl.)
Public propertyCode exampleScrollBarVisibility
Gets or sets the visibility of the scrollbars.
(Inherited from WebViewerControl.)
Protected propertyScrollImageUrl
Url used for holding the location to the image behind the scrollport
Public propertyScrollPosition
Gets or sets the scroll position.
Protected propertyScrollSize
Gets the scroll size.
Public propertySelection
Gets or sets the current RubberBand selection.
Public propertySessionId
Gets the session ID.
(Inherited from WebViewerControl.)
Public propertySite
Gets information about the container that hosts the current control when rendered on a design surface.
(Inherited from Control.)
Public propertySkinID
Gets or sets the skin to apply to the control.
(Inherited from WebControl.)
Public propertyStyle
Gets a collection of text attributes that will be rendered as a style attribute on the outer tag of the Web server control.
(Inherited from WebControl.)
Public propertySupportsDisabledAttribute
Gets a value that indicates whether the control should set the disabled attribute of the rendered HTML element to "disabled" when the control's IsEnabled property is false.
(Inherited from WebControl.)
Public propertyTabIndex
Gets or sets the tab index of the Web server control.
(Inherited from WebControl.)
Protected propertyTagKey
Gets the HtmlTextWriterTag value that corresponds to this Web server control. This property is used primarily by control developers.
(Inherited from WebControl.)
Protected propertyTagName
Gets the name of the control tag. This property is used primarily by control developers.
(Inherited from WebControl.)
Public propertyTemplateControl
Gets or sets a reference to the template that contains this control.
(Inherited from Control.)
Public propertyTemplateSourceDirectory
Gets the virtual directory of the Page or UserControl that contains the current server control.
(Inherited from Control.)
Public propertyTileSize
Gets or sets the size tiles. Smaller tiles on large images can create heavy server load. Minimum tile size is 256x256.
Public propertyTitleBar
Gets or sets the text to be included above the control.
(Inherited from WebViewerControl.)
Public propertyToolTip
Gets or sets the text displayed when the mouse pointer hovers over the Web server control.
(Inherited from WebControl.)
Public propertyCode exampleUndosAvailable
Returns the number of Undos available from the cache.
Public propertyUniqueID
Gets the server control identifier generated by ASP.NET MVC.
(Inherited from WebViewerControl.)
Public propertyValidateRequestMode
Gets or sets a value that indicates whether the control checks client input from the browser for potentially dangerous values.
(Inherited from Control.)
Protected propertyViewState
Gets a dictionary of state information that allows you to save and restore the view state of a server control across multiple requests for the same page.
(Inherited from Control.)
Protected propertyViewStateIgnoresCase
Gets a value that indicates whether the StateBag object is case-insensitive.
(Inherited from Control.)
Public propertyViewStateMode
Gets or sets the view-state mode of this control.
(Inherited from Control.)
Public propertyVisibility
Indicates whether the control is visible when rendered.
(Inherited from WebViewerControl.)
Public propertyVisible
Gets or sets a value that indicates whether a server control is rendered as UI on the page.
(Inherited from WebViewerControl.)
Public propertyWidth
Gets or sets the width of the Web server control.
(Inherited from WebControl.)
Public propertyCode exampleZoom
Gets or sets the zoom level of the image in this WebImageViewer control.
Public propertyCode exampleZoomInOutPercentage
Gets or sets the percentage used to increase or decrease the zoom level when the zoom methods are used.
Top
Methods
  NameDescription
Protected methodAddAttributesToRender
Adds HTML attributes and styles that need to be rendered to the specified HtmlTextWriterTag. This method is used primarily by control developers.
(Inherited from WebControl.)
Protected methodAddedControl
Called after a child control is added to the Controls collection of the Control object.
(Inherited from Control.)
Protected methodAddHiddenTag
Writes a hidden tag.
(Inherited from WebViewerControl.)
Protected methodAddParsedSubObject
Notifies the server control that an element, either XML or HTML, was parsed, and adds the element to the server control's ControlCollection object.
(Inherited from Control.)
Protected methodAddStartupScript
Adds a startup script.
(Inherited from WebViewerControl.)
Public methodCode exampleApplyCommand
Applies an ImageCommand to the current image in order to process it.
Public methodApplyStyle
Copies any nonblank elements of the specified style to the Web control, overwriting any existing style elements of the control. This method is primarily used by control developers.
(Inherited from WebControl.)
Public methodApplyStyleSheetSkin
Applies the style properties defined in the page style sheet to the control.
(Inherited from Control.)
Protected methodBeginRenderTracing
Begins design-time tracing of rendering data.
(Inherited from Control.)
Protected methodBuildCallbackPage
Builds a callback page.
Protected methodBuildProfileTree
Gathers information about the server control and delivers it to the Trace property to be displayed when tracing is enabled for the page.
(Inherited from Control.)
Protected methodBuildRemoteQuery
Gets the initial querystring for the iframe used for RemoteInvoke and PartialPost.
(Overrides WebViewerControlBuildRemoteQuery.)
Protected methodBuildScriptVersionChecker
Builds a version checker function for the scripts.
(Inherited from WebViewerControl.)
Protected methodCacheImage
Saves the image to the file cache, and updates the expiration time
Protected methodCacheImage(ImageEncoder, String)
Saves the image to the file cache so the browser can view it
Protected methodCacheTiles
Saves tiles for the current image to the cache.
Protected methodCalculateBestFitZoom
Calculates the best fit zoom level.
(Inherited from WebViewerControl.)
Protected methodClearCachedClientID
Sets the cached ClientID value to null.
(Inherited from Control.)
Protected methodClearChildControlState
Deletes the control-state information for the server control's child controls.
(Inherited from Control.)
Protected methodClearChildState
Deletes the view-state and control-state information for all the server control's child controls.
(Inherited from Control.)
Protected methodClearChildViewState
Deletes the view-state information for all the server control's child controls.
(Inherited from Control.)
Protected methodClearEffectiveClientIDMode
Sets the ClientIDMode property of the current control instance and of any child controls to Inherit.
(Inherited from Control.)
Protected methodClearSerializedState
Clears the serialized state.
Public methodCopyBaseAttributes
Copies the properties not encapsulated by the Style object from the specified Web server control to the Web server control that this method is called from. This method is used primarily by control developers.
(Inherited from WebControl.)
Protected methodCreateChildControls
Add the child controls to the container, sizing it to the User's specifications.
(Overrides WebViewerControlCreateChildControls.)
Protected methodCreateControlCollection
Creates a new ControlCollection object to hold the child controls (both literal and server) of the server control.
(Inherited from Control.)
Protected methodCreateControlStyle
Creates the style object that is used internally by the WebControl class to implement all style related properties. This method is used primarily by control developers.
(Inherited from WebControl.)
Public methodDataBind
Binds a data source to the invoked server control and all its child controls.
(Inherited from Control.)
Protected methodDataBind(Boolean)
Binds a data source to the invoked server control and all its child controls with an option to raise the DataBinding event.
(Inherited from Control.)
Protected methodDataBindChildren
Binds a data source to the server control's child controls.
(Inherited from Control.)
Protected methodDeserializeState
Deserializes the state.
Public methodDesignTime
Enters design-time mode.
(Overrides WebViewerControlDesignTime.)
Protected methodDesignTime(String)
Enters design-time mode.
(Inherited from WebViewerControl.)
Public methodDispose
Enables a server control to perform final clean up before it is released from memory.
(Inherited from WebViewerControl.)
Protected methodDispose(Boolean)
Enables a server control to perform final clean up before it is released from memory.
(Inherited from WebViewerControl.)
Protected methodDisposeManagedResources
Disposes the managed resources.
(Overrides WebViewerControlDisposeManagedResources.)
Protected methodDisposeUnmanagedResources
Enables a server control to perform final clean up before it is released from memory.
(Inherited from WebViewerControl.)
Protected methodEndRenderTracing
Ends design-time tracing of rendering data.
(Inherited from Control.)
Protected methodEndResponse
Ends the response.
(Inherited from WebViewerControl.)
Protected methodEnsureChildControls
Determines whether the server control contains child controls. If it does not, it creates child controls.
(Inherited from Control.)
Protected methodEnsureID
Creates an identifier for controls that do not have an identifier assigned.
(Inherited from Control.)
Protected methodEnsureValidPixelFormat
Ensures a correct pixel format.
(Inherited from WebViewerControl.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodEscapeString
Escapes a string.
(Inherited from WebViewerControl.)
Protected methodFinalize
Enables a server control to perform final clean up before it is released from memory.
(Inherited from WebViewerControl.)
Public methodFindControl(String)
Searches the current naming container for a server control with the specified id parameter.
(Inherited from Control.)
Protected methodFindControl(String, Int32)
Searches the current naming container for a server control with the specified id and an integer, specified in the pathOffset parameter, which aids in the search. You should not override this version of the FindControl method.
(Inherited from Control.)
Protected methodFindControlRecursive
Searches for a control recursively.
(Inherited from WebViewerControl.)
Protected methodFixNumericalID
Fixes the numerical ID.
(Inherited from WebViewerControl.)
Public methodFocus
Sets input focus to a control.
(Inherited from Control.)
Protected methodGetConfigAttributes
Load this control's configuration from AppSettings
(Inherited from WebViewerControl.)
Protected methodGetDesignModeState
Gets design-time data for a control.
(Inherited from Control.)
Protected methodGetEncoder
Gets the proper encoder based on the BrowserExtension.
(Inherited from WebViewerControl.)
Protected methodGetEncoder(String)
Gets the proper encoder based on the file extension.
(Inherited from WebViewerControl.)
Protected methodGetFormClientID
Gets the form client ID.
(Inherited from WebViewerControl.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Protected methodGetHiddenValues
Reads hidden values.
(Overrides WebViewerControlGetHiddenValues.)
Protected methodGetIdForSession
Gets the session ID.
(Inherited from WebViewerControl.)
Protected methodGetMimeType
Gets the MIME content type of a file name.
(Inherited from WebViewerControl.)
Protected methodGetObjectType
Gets the type of object.
(Overrides WebViewerControlGetObjectType.)
Protected methodGetResourcePrefix
Get the prefix used for a specific kind of resource.
(Overrides WebViewerControlGetResourcePrefix(ResourceType).)
Public methodGetRouteUrl(Object)
Gets the URL that corresponds to a set of route parameters.
(Inherited from Control.)
Public methodGetRouteUrl(RouteValueDictionary)
Gets the URL that corresponds to a set of route parameters.
(Inherited from Control.)
Public methodGetRouteUrl(String, Object)
Gets the URL that corresponds to a set of route parameters and a route name.
(Inherited from Control.)
Public methodGetRouteUrl(String, RouteValueDictionary)
Gets the URL that corresponds to a set of route parameters and a route name.
(Inherited from Control.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetUniqueIDRelativeTo
Returns the prefixed portion of the UniqueID property of the specified control.
(Inherited from Control.)
Protected methodHandleNonPageRequests
Handles non-page requests.
Protected methodHandleQueryString
Handles the query string.
(Overrides WebViewerControlHandleQueryString.)
Public methodHasControls
Determines if the server control contains any child controls.
(Inherited from Control.)
Protected methodHasEvents
Returns a value indicating whether events are registered for the control or any child controls.
(Inherited from Control.)
Protected methodIsLiteralContent
Determines if the server control holds only literal content.
(Inherited from Control.)
Protected methodLoadControlState
Restores control-state information from a previous page request that was saved by the SaveControlState method.
(Inherited from Control.)
Protected methodLoadQueryStringValues
Loads quesry string variables.
(Overrides WebViewerControlLoadQueryStringValues(NameValueCollection).)
Protected methodLoadViewState
Restores view-state information from a previous request that was saved with the SaveViewState method.
(Inherited from WebControl.)
Protected methodLogMessageToCache
Write a diagnostic log message into a .txt file
(Inherited from WebViewerControl.)
Protected methodLogMessageToTile
Logs a message.
Protected methodMapPathSecure
Retrieves the physical path that a virtual path, either absolute or relative, maps to.
(Inherited from Control.)
Protected methodMapUrlPath
Maps the URL to a path.
(Inherited from WebViewerControl.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodMergeStyle
Copies any nonblank elements of the specified style to the Web control, but will not overwrite any existing style elements of the control. This method is used primarily by control developers.
(Inherited from WebControl.)
Protected methodOnBubbleEvent
Determines whether the event for the server control is passed up the page's UI server control hierarchy.
(Inherited from Control.)
Protected methodOnCenteredChanged
Fires when the Centered property changes.
(Inherited from WebViewerControl.)
Protected methodOnChangedImage
Fires when pixel data in the current image changes without setting a new image.
Protected methodOnCreateSessionId
Used to override the session id used by the control to generate cache file names. The default is the Session.Id of the page
(Inherited from WebViewerControl.)
Protected methodOnDataBinding
Raises the DataBinding event.
(Inherited from Control.)
Protected methodOnImageChanged
Fires when the Image has changed.
Protected methodOnInit
Raises the Init event.
(Overrides WebViewerControlOnInit(EventArgs).)
Protected methodOnLoad
Raises the Load event.
(Overrides WebViewerControlOnLoad(EventArgs).)
Protected methodOnNewImage Obsolete.
Fires when this Workspace is set to a new current image. (Obsolete.)
Protected methodOnPageInit
Occurs on page initialization.
Protected methodOnPartialPost
Fires when the control receives post data from the client, without a full PostBack. Returns a string containing the posted data.
(Inherited from WebViewerControl.)
Protected methodOnPreRender
Raises the PreRender event.
(Overrides ControlOnPreRender(EventArgs).)
Protected methodOnProgress
Fires while an image is being processed, loaded, or saved.
Protected methodOnRemoteInvoke
Fires when the control is told to RemoteInvoke. Returns a string containing the remote method's return value.
(Inherited from WebViewerControl.)
Protected methodOnResizeImageForZoom
Fires when the control is going to resize an image to give the user a chance to resize.
Protected methodOnScrollBarVisibilityChanged
Fires when the ScrollPort.ScrollBarVisibility property has changed.
(Inherited from WebViewerControl.)
Protected methodOnScrollPositionChanged
Fires when the position of the scroll bars have changed.
(Inherited from WebViewerControl.)
Protected methodOnSelectionChanged
Fires when the selection has been moved or changed. (After PostBack)
Protected methodOnStreamTile
Fires when a tile is requested and allows the handler to provide it.
Protected methodOnStreamViewImage
Fires only when the viewable portion of the image is streamed to the RichClient. In order for this event to fire properly, the EnableClientEvents property must be set to true.
Protected methodOnTileStreamed
Fires when a tile has been streamed to the response and allows the handler to cache it.
Protected methodOnUnload
Raises the Unload event.
(Inherited from Control.)
Public methodOpen(Stream)
Opens an image into the WebImageViewer control from an image file stream.
Public methodOpen(String)
Opens an image into the WebImageViewer control from an image file.
Public methodCode exampleOpen(RandomAccessImageSource)
Opens a given image and sets it to the display.
Public methodOpen(Stream, Int32)
Opens an image into the WebImageViewer control from an image file stream, specifying the frame index of a multi-page image.
Public methodOpen(String, Int32)
Opens an image into the WebImageViewer control from an image file, specifying the frame index of a multi-page image.
Public methodCode exampleOpen(RandomAccessImageSource, Int32)
Opens a given image at a specified frame index and sets it to the display.
Protected methodOpenFile
Gets a Stream used to read a file.
(Inherited from Control.)
Protected methodOpenScrollImageUrl
Opens the scroll image URL.
Public methodCode exampleOpenUrl(String)
Opens an image into the WebImageViewer control from a URL or virtual path.
Public methodOpenUrl(String, Int32)
Opens an image into the WebImageViewer control from a URL or virtual path.
Protected methodOutputHiddenValues
Writes hidden values.
(Overrides WebViewerControlOutputHiddenValues(HtmlTextWriter).)
Public methodPrint
Prints the current image using JavaScript client code.
Protected methodRaiseBubbleEvent
Assigns any sources of the event and its information to the control's parent.
(Inherited from Control.)
Public methodRedo
Reverts the image inside the control back to the previously cached image, if an Undos have been done.
Public methodRedo(Int32)
Redoes the specified number of times.
Protected methodRegisterScriptInclude
Includes a script.
(Inherited from WebViewerControl.)
Protected methodRegisterScripts
Registers the scripts.
(Overrides WebViewerControlRegisterScripts.)
Protected methodReleaseImage
Releases the image.
(Overrides WebViewerControlReleaseImage(AtalaImage).)
Protected methodRemote
Performs a remote invocation.
(Inherited from WebViewerControl.)
Protected methodRemovedControl
Called after a child control is removed from the Controls collection of the Control object.
(Inherited from Control.)
Protected methodRender
Renders the control to the specified HTML writer.
(Inherited from WebViewerControl.)
Public methodRenderBeginTag
Renders the HTML opening tag of the control to the specified writer. This method is used primarily by control developers.
(Inherited from WebControl.)
Protected methodRenderChildren
Outputs the content of a server control's children to a provided HtmlTextWriter object, which writes the content to be rendered on the client.
(Inherited from Control.)
Protected methodRenderContents
Renders the contents of the control to the specified writer. This method is used primarily by control developers.
(Inherited from WebControl.)
Public methodRenderControl(HtmlTextWriter)
Outputs server control content to a provided HtmlTextWriter object and stores tracing information about the control if tracing is enabled.
(Inherited from Control.)
Protected methodRenderControl(HtmlTextWriter, ControlAdapter)
Outputs server control content to a provided HtmlTextWriter object using a provided ControlAdapter object.
(Inherited from Control.)
Public methodRenderEndTag
Renders the HTML closing tag of the control into the specified writer. This method is used primarily by control developers.
(Inherited from WebControl.)
Protected methodReplaceInvalidFileNameChars
Fixes an invalid file name.
(Inherited from WebViewerControl.)
Protected methodResolveAdapter
Gets the control adapter responsible for rendering the specified control.
(Inherited from Control.)
Public methodResolveClientUrl
Gets a URL that can be used by the browser.
(Inherited from Control.)
Public methodResolveUrl
Converts a URL into one that is usable on the requesting client.
(Inherited from Control.)
Public methodCode exampleSave(Stream, ImageEncoder)
Saves the current image to a stream, with a specified ImageEncoder.
Public methodSave(String, ImageEncoder)
Saves the current image file, with a specified ImageEncoder.
Protected methodSaveControlState
Saves any server control state changes that have occurred since the time the page was posted back to the server.
(Inherited from Control.)
Protected methodSaveViewState
Saves any state that was modified after the TrackViewState method was invoked.
(Inherited from WebControl.)
Protected methodSerializeState
Serializes teh current state.
Protected methodSetDesignModeState
Sets design-time data for a control.
(Inherited from Control.)
Public methodSetRenderMethodDelegate
Assigns an event handler delegate to render the server control and its content into its parent control.
(Inherited from Control.)
Public methodSetTraceData(Object, Object)
Sets trace data for design-time tracing of rendering data, using the trace data key and the trace data value.
(Inherited from Control.)
Public methodSetTraceData(Object, Object, Object)
Sets trace data for design-time tracing of rendering data, using the traced object, the trace data key, and the trace data value.
(Inherited from Control.)
Public methodCode exampleSetZoomMode
Zooms the image based on the given AutoZoomMode.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Protected methodTrackViewState
Causes the control to track changes to its view state so they can be stored in the object's ViewState property.
(Inherited from WebControl.)
Public methodUndo
Reverts the image inside the control back to the previously cached image.
Public methodUndo(Int32)
Undoes the specified number of times.
Public methodUpdate
Forces the current image to be cached.
Public methodUpdateClient
Forces the client side JavaScript to update
Protected methodUrlIsWebRequest
Determines if a URL is for a web request.
(Inherited from WebViewerControl.)
Protected methodWatermarkImage
Applies a watermark to the image.
(Inherited from WebViewerControl.)
Top
Events
  NameDescription
Public eventCenteredChanged
Fires when the Centered property changes.
(Inherited from WebViewerControl.)
Public eventChangedImage
Fires when pixel data in the current image changes without setting a new image.
Public eventCreateSessionId
Used to override the session id used by the control to generate cache file names. The default is the Session.Id of the page
(Inherited from WebViewerControl.)
Public eventCode exampleCreateUniquePageName
Used to override the default page name used by the control to generate file names in the cache. The default is the full pathname to the page hosting the control.
(Inherited from WebViewerControl.)
Public eventDataBinding
Occurs when the server control binds to a data source.
(Inherited from Control.)
Public eventDisposed
Occurs when a server control is released from memory, which is the last stage of the server control lifecycle when an ASP.NET page is requested.
(Inherited from Control.)
Public eventImageChanged
Fires when the Image has changed.
Public eventInit
Occurs when the server control is initialized, which is the first step in its lifecycle.
(Inherited from Control.)
Public eventLoad
Occurs when the server control is loaded into the Page object.
(Inherited from Control.)
Public eventNewImage Obsolete.
Fires when this Workspace is set to a new current image. (Obsolete.)
Public eventPartialPost
Fires when the control receives post data from the client, without a full PostBack. Returns a string containing the posted data.
(Inherited from WebViewerControl.)
Public eventPreRender
Occurs after the Control object is loaded but prior to rendering.
(Inherited from Control.)
Public eventProgress
Fires while an image is being processed, loaded, or saved.
Public eventRemoteInvoke
Fires when the control is told to RemoteInvoke. Returns a string containing the remote method's return value.
(Inherited from WebViewerControl.)
Public eventResizeImageForZoom
Fires when the control is going to resize an image to give the user a chance to resize.
Public eventScrollBarVisibilityChanged
Fires when the ScrollPort.ScrollBarVisibility property has changed.
(Inherited from WebViewerControl.)
Public eventScrollPositionChanged
Fires when the position of the scroll bars have changed.
(Inherited from WebViewerControl.)
Public eventSelectionChanged
Fires when the selection has been moved or changed. (After PostBack)
Public eventStreamTile
Fires when a tile is requested and allows the handler to provide it.
Public eventStreamViewImage
Fires only when the viewable portion of the image is streamed to the RichClient. In order for this event to fire properly, the EnableClientEvents property must be set to true.
Public eventTileStreamed
Fires when a tile has been streamed to the response and allows the handler to cache it.
Public eventUnload
Occurs when the server control is unloaded from memory.
(Inherited from Control.)
Top
Remarks
The WebImageViewer control is intended to be the primary control used for displaying images using DotImage in ASP.NET.
Examples

This example code demonstrates how to use the HtmlInputFile control to enable the client to select an image from the browser and load it into the WebImageViewer

Upload a file into the control C#
namespace WebControlsExamples
{
    public class UploadExample : System.Web.UI.Page
    {
        protected Atalasoft.Imaging.WebControls.WebImageViewer WebImageViewer1;
        protected System.Web.UI.WebControls.Button Button1;
        protected System.Web.UI.WebControls.Label Label1;
        protected System.Web.UI.HtmlControls.HtmlInputFile File1;

        private void Page_Load(object sender, System.EventArgs e)
        {
            // Put user code to initialize the page here
        }

        #region Web Form Designer generated code
        override protected void OnInit(EventArgs e)
        {
            // 
            // CODEGEN: This call is required by the ASP.NET Web Form Designer.
            // 
            InitializeComponent();
            base.OnInit(e);
        }

        /// <summary>
        /// Required method for Designer support - do not modify
        /// the contents of this method with the code editor.
        /// </summary>
        private void InitializeComponent()
        {    
            this.Button1.Click += new System.EventHandler(this.Button1_Click);
            this.Load += new System.EventHandler(this.Page_Load);
        }
        #endregion

        private void Button1_Click(object sender, System.EventArgs e)
        {
            if (File1.PostedFile.FileName.Length != 0) 
            {    // Get the relative server path to the Cache
                string pathToCache = Page.MapPath(System.Configuration.ConfigurationSettings.AppSettings["AtalasoftWebControls_Cache"]);

                // We prefix the file name with the Page.Session.SessionID so
                // that the CacheManager will delete it when the session expires
                string pathToFile = pathToCache + Page.Session.SessionID + "_" + System.IO.Path.GetFileName(File1.PostedFile.FileName);

                try
                {    // Save uploaded file to server cache.
                    File1.PostedFile.SaveAs(pathToFile);
                }
                catch (Exception exc) 
                {    // Sends errors to a label
                    Label1.Text = "Error saving file <b>" + pathToFile + "</b><br>" + exc.Message;
                }

                try
                {    // Load the image in the WebImageViewer
                    WebImageViewer1.Open(pathToFile);
                }
                catch (Exception exc) 
                {    // Sends errors to a label
                    Label1.Text = "Error opening file <b>" + pathToFile + "</b><br>" + exc.Message;
                }
            }
            else
                Label1.Text = "Error: You must specify a file name.";
        }
    }
}
Upload a file into the control Visual Basic
Public Class UploadExample
    Inherits System.Web.UI.Page
    Protected WithEvents WebImageViewer1 As Atalasoft.Imaging.WebControls.WebImageViewer
    Protected WithEvents Button1 As System.Web.UI.WebControls.Button
    Protected WithEvents Label1 As System.Web.UI.WebControls.Label
    Protected WithEvents File1 As System.Web.UI.HtmlControls.HtmlInputFile

#Region " Web Form Designer Generated Code "

    'This call is required by the Web Form Designer.
    <System.Diagnostics.DebuggerStepThrough()> Private Sub InitializeComponent()

    End Sub

    Private Sub Page_Init(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles MyBase.Init
        'CODEGEN: This method call is required by the Web Form Designer
        'Do not modify it using the code editor.
        InitializeComponent()
    End Sub

#End Region

    Private Sub Page_Load(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles MyBase.Load
        'Put user code to initialize the page here
    End Sub

    Private Sub Button1_Click(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles Button1.Click
        If File1.PostedFile.FileName.Length <> 0 Then
            ' Get the relative server path to the Cache
            Dim pathToCache As String = Page.MapPath(System.Configuration.ConfigurationSettings.AppSettings("AtalasoftWebControls_Cache"))

            ' We prefix the file name with the Page.Session.SessionID so
            ' that the CacheManager will delete it when the session expires
            Dim pathToFile As String = pathToCache + Page.Session.SessionID + "_" + System.IO.Path.GetFileName(File1.PostedFile.FileName)

            Try
                ' Save uploaded file to server cache.
                File1.PostedFile.SaveAs(pathToFile)
            Catch exc As Exception
                ' Sends errors to a label
                Label1.Text = "Error saving file <b>" + pathToFile + "</b><br>" + exc.Message
            End Try

            Try
                ' Load the image in the WebImageViewer
                WebImageViewer1.Open(pathToFile)
            Catch exc As Exception
                ' Sends errors to a label
                Label1.Text = "Error opening file <b>" + pathToFile + "</b><br>" + exc.Message
            End Try
        Else
            Label1.Text = "Error: You must specify a file name."
        End If
    End Sub

End Class
See Also