Click or drag to resize

WebViewerControl Class

Defines a base class that can be used for scrolling an image from the browser.
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 abstract class WebViewerControl : WebControl, 
	INamingContainer

The WebViewerControl type exposes the following members.

Constructors
  NameDescription
Protected methodWebViewerControl
base WebViewerControl constructor. Set Visible:true, BorderStyle:None.
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 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 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.
(Overrides WebControlBorderStyle.)
Public propertyBorderWidth
Gets or sets the border width of the Web server control.
(Inherited from WebControl.)
Protected propertyBrowserExtension
Gets the file extension.
Public propertyBrowserFormat
Gets or sets the format of the images created for browser output.
Protected propertyCacheDisabled
Gets a value indicating if the cache is disabled.
Public propertyCacheLevels
The number of images to cache on the server, per control, per session. Default value is 2.
Public propertyCachePath
The path where images and tiles are cached. This is set in the web.config with the appSetting AtalasoftWebControls_Cache.
Public propertyCaption
Gets or sets the text to be included below the control.
Public propertyCentered
Gets or sets a value indicating if the content is centered in the control.
Protected propertyChildContent
Gets or sets the child content.
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.
(Overrides ControlClientID.)
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.
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.
(Overrides ControlControls.)
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.
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.
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.
Public propertyDomain
Allows cross domain scripting for the specified domain.
Public propertyEnabled
Gets or sets a value indicating whether the Web server control is enabled.
(Inherited from WebControl.)
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.
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.
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.)
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.
Protected propertyIsDisposed
Gets a value indicating the object has been disposed.
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.
Protected propertyIsQueryStringLoaded
Gets a value indicating the query string was loaded.
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.
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.
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.)
Protected propertyPixelFormat
Gets or sets the pixel format.
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.
Public propertyCode exampleScrollBarVisibility
Gets or sets the visibility of the scrollbars.
Public propertySessionId
Gets the session ID.
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 propertyTitleBar
Gets or sets the text to be included above the control.
Public propertyToolTip
Gets or sets the text displayed when the mouse pointer hovers over the Web server control.
(Inherited from WebControl.)
Public propertyUniqueID
Gets the server control identifier generated by ASP.NET MVC.
(Overrides ControlUniqueID.)
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.
Public propertyVisible
Gets or sets a value that indicates whether a server control is rendered as UI on the page.
(Overrides ControlVisible.)
Public propertyWidth
Gets or sets the width of the Web server control.
(Inherited from WebControl.)
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.
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.
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 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
Builds the default querystring for the iframe used for RemoteInvoke, PartialPost, and Async WebThumbnailViewer calls
Protected methodBuildScriptVersionChecker
Builds a version checker function for the scripts.
Protected methodCalculateBestFitZoom
Calculates the best fit zoom level.
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.)
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 ControlCreateChildControls.)
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.)
Public methodDesignTime
Enters design-time mode.
Protected methodDesignTime(String)
Enters design-time mode.
Public methodDispose
Enables a server control to perform final clean up before it is released from memory.
(Overrides ControlDispose.)
Protected methodDispose(Boolean)
Enables a server control to perform final clean up before it is released from memory.
Protected methodDisposeManagedResources
Enables a server control to perform final clean up before it is released from memory.
Protected methodDisposeUnmanagedResources
Enables a server control to perform final clean up before it is released from memory.
Protected methodEndRenderTracing
Ends design-time tracing of rendering data.
(Inherited from Control.)
Protected methodEndResponse
Ends the response.
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.
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodEscapeString
Escapes a string.
Protected methodFinalize
Enables a server control to perform final clean up before it is released from memory.
(Overrides ObjectFinalize.)
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.
Protected methodFixNumericalID
Fixes the numerical ID.
Public methodFocus
Sets input focus to a control.
(Inherited from Control.)
Protected methodGetConfigAttributes
Load this control's configuration from AppSettings
Protected methodGetDesignModeState
Gets design-time data for a control.
(Inherited from Control.)
Protected methodGetEncoder
Gets the proper encoder based on the BrowserExtension.
Protected methodGetEncoder(String)
Gets the proper encoder based on the file extension.
Protected methodGetFormClientID
Gets the form client ID.
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Protected methodGetHiddenValues
Reads hidden values.
Protected methodGetIdForSession
Gets the session ID.
Protected methodGetMimeType
Gets the MIME content type of a file name.
Protected methodGetObjectType
Gets the type of object.
Protected methodGetResourcePrefix
Gets the prefix associated with a specific resource type.
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 methodHandleQueryString
Handles the query string.
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 the values from the query string.
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
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.
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.
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
Protected methodOnDataBinding
Raises the DataBinding event.
(Inherited from Control.)
Protected methodOnInit
Raises the Init event.
(Overrides ControlOnInit(EventArgs).)
Protected methodOnLoad
Raises the Load event.
(Overrides ControlOnLoad(EventArgs).)
Protected methodOnPartialPost
Fires when the control receives post data from the client, without a full PostBack. Returns a string containing the posted data.
Protected methodOnPreRender
Raises the PreRender event.
(Inherited from Control.)
Protected methodOnRemoteInvoke
Fires when the control is told to RemoteInvoke. Returns a string containing the remote method's return value.
Protected methodOnScrollBarVisibilityChanged
Fires when the ScrollPort.ScrollBarVisibility property has changed.
Protected methodOnScrollPositionChanged
Fires when the position of the scroll bars have changed.
Protected methodOnUnload
Raises the Unload event.
(Inherited from Control.)
Protected methodOpenFile
Gets a Stream used to read a file.
(Inherited from Control.)
Protected methodOutputHiddenValues
Writes the hidden values.
Protected methodRaiseBubbleEvent
Assigns any sources of the event and its information to the control's parent.
(Inherited from Control.)
Protected methodRegisterScriptInclude
Includes a script.
Protected methodRegisterScripts
Registers scripts.
Protected methodReleaseImage
Releases the image.
Protected methodRemote
Performs a remote invocation.
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.
(Overrides WebControlRender(HtmlTextWriter).)
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.
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.)
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 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 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.)
Protected methodUrlIsWebRequest
Determines if a URL is for a web request.
Protected methodWatermarkImage
Applies a watermark to the image.
Top
Events
  NameDescription
Public eventCenteredChanged
Fires when the Centered property changes.
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
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.
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 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 eventPartialPost
Fires when the control receives post data from the client, without a full PostBack. Returns a string containing the posted data.
Public eventPreRender
Occurs after the Control object is loaded but prior to rendering.
(Inherited from Control.)
Public eventRemoteInvoke
Fires when the control is told to RemoteInvoke. Returns a string containing the remote method's return value.
Public eventScrollBarVisibilityChanged
Fires when the ScrollPort.ScrollBarVisibility property has changed.
Public eventScrollPositionChanged
Fires when the position of the scroll bars have changed.
Public eventUnload
Occurs when the server control is unloaded from memory.
(Inherited from Control.)
Top
See Also