WebAnnotationViewer Class

Creates a new instance of WebAnnotationViewer.

Gets or sets the access key that allows you to quickly navigate to the Web server control.

Gets the browser-specific adapter for the control.

Gets a paths collection from where the control can retrieve data for annotations, images, etc. It can include absolute or relatives paths, and URLs.

Gets or sets the AnnotationDataFormat to use while loading.

Gets the url path where the annotation data will be cached.

Gets the WebAnnotationController used by this viewer.

Gets or sets the quality of the scaled image.

Gets or sets the application-relative virtual directory of the Page or UserControl object that contains this control.

Gets the collection of arbitrary attributes (for rendering only) that do not correspond to properties on the control.

Gets or sets a value that determines how many annotations are created in InteractMode.Author, AuthorMode.Single will change InteractMode back to the previous value after annotation creation.

Gets or sets a value that determines whether this control will automatically handle annotations and layers on a WebThumbnailViewer that points to this control.

Gets or sets a value indicating how the image should be zoomed as the control is resized or the image size changes.

Gets or sets the background color of the Web server control.

Gets the control that contains this control's data binding.

Gets or sets the border color of the Web control.

Gets the border style used for this control.

Gets or sets the border width of the Web server control.

Gets the file extension.

Gets or sets the format of the images created for browser output.

Gets a value indicating if the cache is disabled.

Gets or sets a URL used to represent the lossless version of the ImageUrl.

The number of images to cache on the server, per control, per session. Default value is 2.

The path where images and tiles are cached. This is set in the web.config with the appSetting AtalasoftWebControls_Cache.

Gets or sets the text to be included below the control.

Gets or sets a value indicating if the content is centered in the control.

Gets or sets the child content.

Gets a value that indicates whether the server control's child controls have been created.

Gets the server control identifier generated by ASP.NET.

Gets or sets the algorithm that is used to generate the value of the ClientID property.

Gets a character value representing the separator character used in the ClientID property.

Gets a collection od client scripts.

Gets the HttpContext object associated with the server control for the current Web request.

Gets a ControlCollection object that represents the child controls for a specified server control in the UI hierarchy.

Gets the style of the Web server control. This property is used primarily by control developers.

Gets a value indicating whether a Style object has been created for the ControlStyle property. This property is primarily used by control developers.

Gets the table of controls.

Gets or sets the Cascading Style Sheet (CSS) class rendered by the Web server control on the client.

Gets the current execution path.

Gets a value indicating the current page of a multi-page image being viewed in this control.

Gets or sets the user name associated with all newly created annotations.

Gets a reference to the naming container if the naming container implements IDataItemContainer.

Gets a reference to the naming container if the naming container implements IDataKeysControl.

Gets the default annotation data URL.

Gets a value indicating whether a control is being used on a design surface.

Gets the design-time viewport.

Allows cross domain scripting for the specified domain.

Enables the usage of events coming from the client without postbacks. (Obsolete.)

Gets or sets a value indicating whether the Web server control is enabled.

Enables server antialiasing for the FullClient ScrollbarType. (Obsolete.)

Gets or sets a value indicating whether themes apply to this control.

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.

Gets a list of event handler delegates for the control. This property is read-only.

Gets the font properties associated with the Web server control.

Gets or sets the foreground color (typically the color of the text) of the Web server control.

Gets the client IFrame element.

Gets a value indicating whether the control has attributes set.

Gets a value indicating whether the current server control's child controls have any saved view-state settings.

Gets a value indicating that a response has been sent.

Gets or sets the height of the Web server control.

Gets or sets the programmatic identifier assigned to the server control.

Gets the character used to separate control identifiers.

Gets or sets the current AtalaImage displayed in this control

Defines the way tiles are loaded in the viewport. Using ImageDisplayOrder.Sequential will reduce performance, OnDemand is the most efficient.

Gets the image info

A value indicating the position of the image relative to the top left position of the scrollport.

Gets or sets the image source.

Gets the image source URL.

Gets or sets the location of an image to display in the WebImageViewer control.

Gets or sets a value specifying the user interactive mode of the WebAnnotationViewer

Gets a value indicating whether controls contained within this control have control state.

Gets or sets a value indicating the control is in design time.

Gets or sets a value indicating that modifications have been made since the last save.

Gets a value indicating the object has been disposed.

Gets a value indicating whether the control is enabled.

Gets a value indicating it is a partial post.

Gets a value indicating the query string was loaded.

Gets a value that indicates whether the server control is saving changes to its view state.

Gets a value indicating whether view state is enabled for this control.

Gets a value indicating whether the control participates in loading its view state by ID instead of index.

Gets a value indicating that logging is performed.

Gets a value indicating the behavior of the mouse when interacting with the viewport.

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.

Gets the outer table.

Gets a reference to the Page instance that contains the server control.

Gets a reference to the server control's parent control in the page control hierarchy.

Gets or sets the virtual path to where the image, script, and cursor files are located. (Obsolete.)

Gets the pixel format.

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.

Returns the number of Redos available from the cache.

Gets or sets a mappable application relative url path used for ReferencedImageAnnotation file paths, allows browser caching for images of the same file name.

Gets a value that specifies the ASP.NET version that rendered HTML will be compatible with.

The path to the javascript and image resources needed by this control. It is set with the web.config property AtalasoftWebControls_ResourcePath.

Gets or sets the visibility of the scrollbars.

Url used for holding the location to the image behind the scrollport

Gets or sets the scroll position.

Gets the scroll size.

Gets or sets the current RubberBand selection.

Gets the session ID.

Gets information about the container that hosts the current control when rendered on a design surface.

Gets or sets the skin to apply to the control.

Gets a collection of text attributes that will be rendered as a style attribute on the outer tag of the Web server control.

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.

Gets or sets the tab index of the Web server control.

Gets the HtmlTextWriterTag value that corresponds to this Web server control. This property is used primarily by control developers.

Gets the name of the control tag. This property is used primarily by control developers.

Gets or sets a reference to the template that contains this control.

Gets the virtual directory of the Page or UserControl that contains the current server control.

Gets or sets the size tiles. Smaller tiles on large images can create heavy server load. Minimum tile size is 256x256.

Gets or sets the text to be included above the control.

Gets or sets the text displayed when the mouse pointer hovers over the Web server control.

Returns the number of Undos available from the cache.

Gets the server control identifier generated by ASP.NET MVC.

Gets or sets a value that indicates whether the control checks client input from the browser for potentially dangerous values.

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.

Gets a value that indicates whether the StateBag object is case-insensitive.

Gets or sets the view-state mode of this control.

Indicates whether the control is visible when rendered.

Gets or sets a value that indicates whether a server control is rendered as UI on the page.

Gets or sets the width of the Web server control.

Gets or sets the zoom level of the image in this WebImageViewer control.

Gets or sets the percentage used to increase or decrease the zoom level when the zoom methods are used.

Adds HTML attributes and styles that need to be rendered to the specified HtmlTextWriterTag. This method is used primarily by control developers.

Called after a child control is added to the Controls collection of the Control object.

Writes a hidden tag.

Notifies the server control that an element, either XML or HTML, was parsed, and adds the element to the server control's ControlCollection object.

Adds a startup script.

Applies an ImageCommand to the current image in order to process it.

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.

Applies the style properties defined in the page style sheet to the control.

Begins design-time tracing of rendering data.

Builds a callback page.

Gathers information about the server control and delivers it to the Trace property to be displayed when tracing is enabled for the page.

Builds the remote query string.

Builds a version checker function for the scripts.

Caches the annotation data.

Saves the image to the file cache, and updates the expiration time

Saves the image to the file cache so the browser can view it

Saves tiles for the current image to the cache.

Calculates the best fit zoom level.

Clears the annoation data in the cache.

Clears all annotations.

Sets the cached ClientID value to null.

Deletes the control-state information for the server control's child controls.

Deletes the view-state and control-state information for all the server control's child controls.

Deletes the view-state information for all the server control's child controls.

Sets the ClientIDMode property of the current control instance and of any child controls to Inherit.

Clears the serialized state.

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.

Creates an annotation data object from a class name.

Add the child controls to the container, sizing it to the User's specifications.

Creates a new ControlCollection object to hold the child controls (both literal and server) of the server control.

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.

Binds a data source to the invoked server control and all its child controls.

Binds a data source to the invoked server control and all its child controls with an option to raise the DataBinding event.

Binds a data source to the server control's child controls.

Deserializes the default annotations.

Deserializes the state.

Enters design-time mode.

Enters design-time mode.

Enables a server control to perform final clean up before it is released from memory.

Enables a server control to perform final clean up before it is released from memory.

Disposes the managed resources.

Enables a server control to perform final clean up before it is released from memory.

Ends design-time tracing of rendering data.

Ends the response.

Determines whether the server control contains child controls. If it does not, it creates child controls.

Creates an identifier for controls that do not have an identifier assigned.

Ensures a correct pixel format.

Determines whether the specified object is equal to the current object.

Escapes a JSON string.

Escapes a string.

Enables a server control to perform final clean up before it is released from memory.

Searches the current naming container for a server control with the specified id parameter.

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.

Searches for a control recursively.

Fixes the numerical ID.

Sets input focus to a control.

Gets an annotation data type from a class name.

Load this control's configuration from AppSettings

Gets design-time data for a control.

Gets the proper encoder based on the BrowserExtension.

Gets the proper encoder based on the file extension.

Gets the form client ID.

Serves as the default hash function.

Gets the hidden values.

Gets the session ID.

Gets the MIME content type of a file name.

Gets the type of object.

Gets the prefix used for a particular resource type.

Gets the URL that corresponds to a set of route parameters.

Gets the URL that corresponds to a set of route parameters.

Gets the URL that corresponds to a set of route parameters and a route name.

Gets the URL that corresponds to a set of route parameters and a route name.

Gets the Type of the current instance.

Returns the prefixed portion of the UniqueID property of the specified control.

Handles non page requests.

Handles the query string.

Determines if the server control contains any child controls.

Returns a value indicating whether events are registered for the control or any child controls.

Determines if the server control holds only literal content.

Loads annotation data from a stream using the AnnotationDataFormat property and adds annotations to the underlying WebAnnotationController.

Loads annotation data from a file using the AnnotationDataFormat property and adds annotations to the underlying WebAnnotationController.

Loads annotation data from a file located at the given relative or absolute url using the AnnotationDataFormat property, and adds the annotations to the underlying WebAnnotationController.

Loads cached annotations.

Restores control-state information from a previous page request that was saved by the SaveControlState() method.

Loads WebAnnotationViewer specific QueryString values

Restores view-state information from a previous request that was saved with the SaveViewState() method.

Write a diagnostic log message into a .txt file

Logs a message.

Retrieves the physical path that a virtual path, either absolute or relative, maps to.

Maps the URL to a path.

Creates a shallow copy of the current Object.

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.

Called when a new annotation has been created by the user.

Called when annotations have been modified by client side code/interaction.

Determines whether the event for the server control is passed up the page's UI server control hierarchy.

Fires when the Centered property changes.

Fires when pixel data in the current image changes without setting a new image.

Used to override the session id used by the control to generate cache file names. The default is the Session.Id of the page

Raises the DataBinding event.

Fires when the DefaultAnnotationsCollection has changed, but only after the control has been initially rendered

Fires when the Image has changed.

Raises the Init event.

Raises the Load event.

Fires when this Workspace is set to a new current image. (Obsolete.)

Occurs on page initialization.

Fires when the control receives post data from the client, without a full PostBack. Returns a string containing the posted data.

Raises the PreRender event.

Fires while an image is being processed, loaded, or saved.

Fires when the control is told to RemoteInvoke. Returns a string containing the remote method's return value.

Fires when the control is going to resize an image to give the user a chance to resize.

Fires when the ScrollPort.ScrollBarVisibility property has changed.

Fires when the position of the scroll bars have changed.

Fires when the selection has been moved or changed. (After PostBack)

Fires when a tile is requested and allows the handler to provide it.

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.

Fires when a tile has been streamed to the response and allows the handler to cache it.

Raises the Unload event.

Opens an image into the WebImageViewer control from an image file stream.

Opens an image into the WebImageViewer control from an image file.

Opens a given image and sets it to the display.

Opens an image into the WebImageViewer control from an image file stream, specifying the frame index of a multi-page image.

Opens an image into the WebImageViewer control from an image file, specifying the frame index of a multi-page image.

Opens a given image at a specified frame index and sets it to the display.

Gets a Stream used to read a file.

Opens the scroll image URL.

Opens an image into the WebImageViewer control from a URL or virtual path.

Opens an image into the WebImageViewer control from a URL or virtual path.

Writes hidden values.

Parses the query string.

Assigns any sources of the event and its information to the control's parent.

Reverts the image inside the control back to the previously cached image, if an Undos have been done.

Redoes the specified number of times.

Includes a script.

Registers the scripts.

Releases the image.

Performs a remote invocation.

Called after a child control is removed from the Controls collection of the Control object.

Renders the control to the specified HTML writer.

Renders the HTML opening tag of the control to the specified writer. This method is used primarily by control developers.

Outputs the content of a server control's children to a provided HtmlTextWriter object, which writes the content to be rendered on the client.

Renders the contents of the control to the specified writer. This method is used primarily by control developers.

Outputs server control content to a provided HtmlTextWriter object and stores tracing information about the control if tracing is enabled.

Outputs server control content to a provided HtmlTextWriter object using a provided ControlAdapter object.

Renders the HTML closing tag of the control into the specified writer. This method is used primarily by control developers.

Fixes an invalid file name.

Gets the control adapter responsible for rendering the specified control.

Gets a URL that can be used by the browser.

Converts a URL into one that is usable on the requesting client.

Saves the current image to a stream, with a specified ImageEncoder.

Saves the current image file, with a specified ImageEncoder.

Saves any server control state changes that have occurred since the time the page was posted back to the server.

Saves any state that was modified after the TrackViewState() method was invoked.

Serializes the current state.

Sets design-time data for a control.

Assigns an event handler delegate to render the server control and its content into its parent control.

Sets trace data for design-time tracing of rendering data, using the trace data key and the trace data value.

Sets trace data for design-time tracing of rendering data, using the traced object, the trace data key, and the trace data value.

Zooms the image based on the given AutoZoomMode.

Returns a string that represents the current object.

Causes the control to track changes to its view state so they can be stored in the object's ViewState property.

Reverts the image inside the control back to the previously cached image.

Undoes the specified number of times.

Forces the current image to be cached.

Forces the control to cache the annotation data for retrieval on the client side.

Forces the client side JavaScript to update

Determines if a URL is for a web request.

Applies a watermark to the image.

Raised when an annotation is created by the user.

Fires when annotations are modified from the browser.

Fires when the Centered property changes.

Fires when pixel data in the current image changes without setting a new image.

Used to override the session id used by the control to generate cache file names. The default is the Session.Id of the page

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.

Occurs when the server control binds to a data source.

Fires when the DefaultAnnotationsCollection has changed, but only after the control has been initially rendered.

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.

Fires when the Image has changed.

Occurs when the server control is initialized, which is the first step in its lifecycle.

Occurs when the server control is loaded into the Page object.

Fires when this Workspace is set to a new current image. (Obsolete.)

Fires when the control receives post data from the client, without a full PostBack. Returns a string containing the posted data.

Occurs after the Control object is loaded but prior to rendering.

Fires while an image is being processed, loaded, or saved.

Fires when the control is told to RemoteInvoke. Returns a string containing the remote method's return value.

Fires when the control is going to resize an image to give the user a chance to resize.

Fires when the ScrollPort.ScrollBarVisibility property has changed.

Fires when the position of the scroll bars have changed.

Fires when the selection has been moved or changed. (After PostBack)

Fires when a tile is requested and allows the handler to provide it.

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.

Fires when a tile has been streamed to the response and allows the handler to cache it.

Occurs when the server control is unloaded from memory.