WebViewerControl Class |
Namespace: Atalasoft.Imaging.WebControls
The WebViewerControl type exposes the following members.
Name | Description | |
---|---|---|
WebViewerControl | base WebViewerControl constructor. Set Visible:true, BorderStyle:None. |
Name | Description | |
---|---|---|
AccessKey | Gets or sets the access key that allows you to quickly navigate to the Web server control. (Inherited from WebControl.) | |
Adapter | Gets the browser-specific adapter for the control. (Inherited from Control.) | |
AllowedPaths |
Gets a paths collection from where the control can retrieve data for annotations, images, etc.
It can include absolute or relatives paths, and URLs.
| |
AppRelativeTemplateSourceDirectory | Gets or sets the application-relative virtual directory of the Page or UserControl object that contains this control. (Inherited from Control.) | |
Attributes | Gets the collection of arbitrary attributes (for rendering only) that do not correspond to properties on the control. (Inherited from WebControl.) | |
BackColor | Gets or sets the background color of the Web server control. (Inherited from WebControl.) | |
BindingContainer | Gets the control that contains this control's data binding. (Inherited from Control.) | |
BorderColor | Gets or sets the border color of the Web control. (Inherited from WebControl.) | |
BorderStyle | Gets the border style used for this control. (Overrides WebControlBorderStyle.) | |
BorderWidth | Gets or sets the border width of the Web server control. (Inherited from WebControl.) | |
BrowserExtension |
Gets the file extension.
| |
BrowserFormat |
Gets or sets the format of the images created for browser output.
| |
CacheDisabled |
Gets a value indicating if the cache is disabled.
| |
CacheLevels | The number of images to cache on the server, per control, per session. Default value is 2. | |
CachePath | The path where images and tiles are cached. This is set in the web.config with the appSetting
AtalasoftWebControls_Cache. | |
Caption |
Gets or sets the text to be included below the control.
| |
Centered |
Gets or sets a value indicating if the content is centered in the control.
| |
ChildContent |
Gets or sets the child content.
| |
ChildControlsCreated | Gets a value that indicates whether the server control's child controls have been created. (Inherited from Control.) | |
ClientID |
Gets the server control identifier generated by ASP.NET.
(Overrides ControlClientID.) | |
ClientIDMode | Gets or sets the algorithm that is used to generate the value of the ClientID property. (Inherited from Control.) | |
ClientIDSeparator | Gets a character value representing the separator character used in the ClientID property. (Inherited from Control.) | |
ClientScripts |
Gets a collection od client scripts.
| |
Context | Gets the HttpContext object associated with the server control for the current Web request. (Inherited from Control.) | |
Controls |
Gets a ControlCollection object that represents the child controls for a specified server control in the UI hierarchy.
(Overrides ControlControls.) | |
ControlStyle | Gets the style of the Web server control. This property is used primarily by control developers. (Inherited from WebControl.) | |
ControlStyleCreated | 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.) | |
ControlTable |
Gets the table of controls.
| |
CssClass | Gets or sets the Cascading Style Sheet (CSS) class rendered by the Web server control on the client. (Inherited from WebControl.) | |
CurrentExecutionPath |
Gets the current execution path.
| |
DataItemContainer | Gets a reference to the naming container if the naming container implements IDataItemContainer. (Inherited from Control.) | |
DataKeysContainer | Gets a reference to the naming container if the naming container implements IDataKeysControl. (Inherited from Control.) | |
DesignMode | Gets a value indicating whether a control is being used on a design surface. (Inherited from Control.) | |
DesignTimeViewPort |
Gets the design-time viewport.
| |
Domain |
Allows cross domain scripting for the specified domain.
| |
Enabled | Gets or sets a value indicating whether the Web server control is enabled. (Inherited from WebControl.) | |
EnableTheming | Gets or sets a value indicating whether themes apply to this control. (Inherited from WebControl.) | |
EnableViewState | 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.) | |
Events | Gets a list of event handler delegates for the control. This property is read-only. (Inherited from Control.) | |
Font | Gets the font properties associated with the Web server control. (Inherited from WebControl.) | |
ForeColor | Gets or sets the foreground color (typically the color of the text) of the Web server control. (Inherited from WebControl.) | |
FullClientIFrame |
Gets the client IFrame element.
| |
HasAttributes | Gets a value indicating whether the control has attributes set. (Inherited from WebControl.) | |
HasChildViewState | Gets a value indicating whether the current server control's child controls have any saved view-state settings. (Inherited from Control.) | |
HasResponded |
Gets a value indicating that a response has been sent.
| |
Height | Gets or sets the height of the Web server control. (Inherited from WebControl.) | |
ID | Gets or sets the programmatic identifier assigned to the server control. (Inherited from Control.) | |
IdSeparator | Gets the character used to separate control identifiers. (Inherited from Control.) | |
IsChildControlStateCleared | Gets a value indicating whether controls contained within this control have control state. (Inherited from Control.) | |
IsDesignTime |
Gets or sets a value indicating the control is in design time.
| |
IsDisposed |
Gets a value indicating the object has been disposed.
| |
IsEnabled | Gets a value indicating whether the control is enabled. (Inherited from WebControl.) | |
IsPartialPost |
Gets a value indicating it is a partial post.
| |
IsQueryStringLoaded |
Gets a value indicating the query string was loaded.
| |
IsTrackingViewState | Gets a value that indicates whether the server control is saving changes to its view state. (Inherited from Control.) | |
IsViewStateEnabled | Gets a value indicating whether view state is enabled for this control. (Inherited from Control.) | |
LoadViewStateByID | Gets a value indicating whether the control participates in loading its view state by ID instead of index. (Inherited from Control.) | |
Logging |
Gets a value indicating that logging is performed.
| |
NamingContainer | 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.) | |
OuterTable |
Gets the outer table.
| |
Page | Gets a reference to the Page instance that contains the server control. (Inherited from Control.) | |
Parent | Gets a reference to the server control's parent control in the page control hierarchy. (Inherited from Control.) | |
PathToResources | Obsolete. Gets or sets the virtual path to where the image, script, and cursor files are located. (Obsolete.) | |
PixelFormat |
Gets or sets the pixel format.
| |
RenderingCompatibility | Gets a value that specifies the ASP.NET version that rendered HTML will be compatible with. (Inherited from Control.) | |
ResourcePath | The path to the javascript and image resources needed by this control. It is set with the web.config
property AtalasoftWebControls_ResourcePath. | |
ScrollBarVisibility | Gets or sets the visibility of the scrollbars. | |
SessionId |
Gets the session ID.
| |
Site | Gets information about the container that hosts the current control when rendered on a design surface. (Inherited from Control.) | |
SkinID | Gets or sets the skin to apply to the control. (Inherited from WebControl.) | |
Style | 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.) | |
SupportsDisabledAttribute | 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.) | |
TabIndex | Gets or sets the tab index of the Web server control. (Inherited from WebControl.) | |
TagKey | Gets the HtmlTextWriterTag value that corresponds to this Web server control. This property is used primarily by control developers. (Inherited from WebControl.) | |
TagName | Gets the name of the control tag. This property is used primarily by control developers. (Inherited from WebControl.) | |
TemplateControl | Gets or sets a reference to the template that contains this control. (Inherited from Control.) | |
TemplateSourceDirectory | Gets the virtual directory of the Page or UserControl that contains the current server control. (Inherited from Control.) | |
TitleBar |
Gets or sets the text to be included above the control.
| |
ToolTip | Gets or sets the text displayed when the mouse pointer hovers over the Web server control. (Inherited from WebControl.) | |
UniqueID |
Gets the server control identifier generated by ASP.NET MVC.
(Overrides ControlUniqueID.) | |
ValidateRequestMode | Gets or sets a value that indicates whether the control checks client input from the browser for potentially dangerous values. (Inherited from Control.) | |
ViewState | 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.) | |
ViewStateIgnoresCase | Gets a value that indicates whether the StateBag object is case-insensitive. (Inherited from Control.) | |
ViewStateMode | Gets or sets the view-state mode of this control. (Inherited from Control.) | |
Visibility | Indicates whether the control is visible when rendered. | |
Visible |
Gets or sets a value that indicates whether a server control is rendered as UI on the page.
(Overrides ControlVisible.) | |
Width | Gets or sets the width of the Web server control. (Inherited from WebControl.) |
Name | Description | |
---|---|---|
AddAttributesToRender | 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.) | |
AddedControl | Called after a child control is added to the Controls collection of the Control object. (Inherited from Control.) | |
AddHiddenTag |
Writes a hidden tag.
| |
AddParsedSubObject | 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.) | |
AddStartupScript |
Adds a startup script.
| |
ApplyStyle | 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.) | |
ApplyStyleSheetSkin | Applies the style properties defined in the page style sheet to the control. (Inherited from Control.) | |
BeginRenderTracing | Begins design-time tracing of rendering data. (Inherited from Control.) | |
BuildProfileTree | 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.) | |
BuildRemoteQuery |
Builds the default querystring for the iframe used for RemoteInvoke, PartialPost, and Async WebThumbnailViewer calls
| |
BuildScriptVersionChecker |
Builds a version checker function for the scripts.
| |
CalculateBestFitZoom |
Calculates the best fit zoom level.
| |
ClearCachedClientID | Sets the cached ClientID value to null. (Inherited from Control.) | |
ClearChildControlState | Deletes the control-state information for the server control's child controls. (Inherited from Control.) | |
ClearChildState | Deletes the view-state and control-state information for all the server control's child controls. (Inherited from Control.) | |
ClearChildViewState | Deletes the view-state information for all the server control's child controls. (Inherited from Control.) | |
ClearEffectiveClientIDMode | Sets the ClientIDMode property of the current control instance and of any child controls to Inherit. (Inherited from Control.) | |
CopyBaseAttributes | 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.) | |
CreateChildControls |
Add the child controls to the container, sizing it to the User's specifications.
(Overrides ControlCreateChildControls.) | |
CreateControlCollection | Creates a new ControlCollection object to hold the child controls (both literal and server) of the server control. (Inherited from Control.) | |
CreateControlStyle | 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.) | |
DataBind | Binds a data source to the invoked server control and all its child controls. (Inherited from Control.) | |
DataBind(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.) | |
DataBindChildren | Binds a data source to the server control's child controls. (Inherited from Control.) | |
DesignTime |
Enters design-time mode.
| |
DesignTime(String) |
Enters design-time mode.
| |
Dispose |
Enables a server control to perform final clean up before it is released from memory.
(Overrides ControlDispose.) | |
Dispose(Boolean) |
Enables a server control to perform final clean up before it is released from memory.
| |
DisposeManagedResources |
Enables a server control to perform final clean up before it is released from memory.
| |
DisposeUnmanagedResources |
Enables a server control to perform final clean up before it is released from memory.
| |
EndRenderTracing | Ends design-time tracing of rendering data. (Inherited from Control.) | |
EndResponse |
Ends the response.
| |
EnsureChildControls | Determines whether the server control contains child controls. If it does not, it creates child controls. (Inherited from Control.) | |
EnsureID | Creates an identifier for controls that do not have an identifier assigned. (Inherited from Control.) | |
EnsureValidPixelFormat |
Ensures a correct pixel format.
| |
Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) | |
EscapeString |
Escapes a string.
| |
Finalize |
Enables a server control to perform final clean up before it is released from memory.
(Overrides ObjectFinalize.) | |
FindControl(String) | Searches the current naming container for a server control with the specified id parameter. (Inherited from Control.) | |
FindControl(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.) | |
FindControlRecursive |
Searches for a control recursively.
| |
FixNumericalID |
Fixes the numerical ID.
| |
Focus | Sets input focus to a control. (Inherited from Control.) | |
GetConfigAttributes | Load this control's configuration from AppSettings | |
GetDesignModeState | Gets design-time data for a control. (Inherited from Control.) | |
GetEncoder |
Gets the proper encoder based on the BrowserExtension.
| |
GetEncoder(String) |
Gets the proper encoder based on the file extension.
| |
GetFormClientID |
Gets the form client ID.
| |
GetHashCode | Serves as the default hash function. (Inherited from Object.) | |
GetHiddenValues |
Reads hidden values.
| |
GetIdForSession |
Gets the session ID.
| |
GetMimeType |
Gets the MIME content type of a file name.
| |
GetObjectType |
Gets the type of object.
| |
GetResourcePrefix |
Gets the prefix associated with a specific resource type.
| |
GetRouteUrl(Object) | Gets the URL that corresponds to a set of route parameters. (Inherited from Control.) | |
GetRouteUrl(RouteValueDictionary) | Gets the URL that corresponds to a set of route parameters. (Inherited from Control.) | |
GetRouteUrl(String, Object) | Gets the URL that corresponds to a set of route parameters and a route name. (Inherited from Control.) | |
GetRouteUrl(String, RouteValueDictionary) | Gets the URL that corresponds to a set of route parameters and a route name. (Inherited from Control.) | |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
GetUniqueIDRelativeTo | Returns the prefixed portion of the UniqueID property of the specified control. (Inherited from Control.) | |
HandleQueryString |
Handles the query string.
| |
HasControls | Determines if the server control contains any child controls. (Inherited from Control.) | |
HasEvents | Returns a value indicating whether events are registered for the control or any child controls. (Inherited from Control.) | |
IsLiteralContent | Determines if the server control holds only literal content. (Inherited from Control.) | |
LoadControlState | Restores control-state information from a previous page request that was saved by the SaveControlState method. (Inherited from Control.) | |
LoadQueryStringValues |
Loads the values from the query string.
| |
LoadViewState | Restores view-state information from a previous request that was saved with the SaveViewState method. (Inherited from WebControl.) | |
LogMessageToCache | Write a diagnostic log message into a .txt file | |
MapPathSecure | Retrieves the physical path that a virtual path, either absolute or relative, maps to. (Inherited from Control.) | |
MapUrlPath |
Maps the URL to a path.
| |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
MergeStyle | 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.) | |
OnBubbleEvent | Determines whether the event for the server control is passed up the page's UI server control hierarchy. (Inherited from Control.) | |
OnCenteredChanged | Fires when the Centered property changes. | |
OnCreateSessionId | Used to override the session id used by the control to generate cache file names. The default is the
Session.Id of the page | |
OnDataBinding | Raises the DataBinding event. (Inherited from Control.) | |
OnInit |
Raises the Init event.
(Overrides ControlOnInit(EventArgs).) | |
OnLoad |
Raises the Load event.
(Overrides ControlOnLoad(EventArgs).) | |
OnPartialPost |
Fires when the control receives post data from the client, without a full PostBack. Returns a string containing the posted data.
| |
OnPreRender | Raises the PreRender event. (Inherited from Control.) | |
OnRemoteInvoke | Fires when the control is told to RemoteInvoke. Returns a string containing the remote method's return
value. | |
OnScrollBarVisibilityChanged | Fires when the ScrollPort.ScrollBarVisibility property has changed. | |
OnScrollPositionChanged | Fires when the position of the scroll bars have changed. | |
OnUnload | Raises the Unload event. (Inherited from Control.) | |
OpenFile | Gets a Stream used to read a file. (Inherited from Control.) | |
OutputHiddenValues |
Writes the hidden values.
| |
RaiseBubbleEvent | Assigns any sources of the event and its information to the control's parent. (Inherited from Control.) | |
RegisterScriptInclude |
Includes a script.
| |
RegisterScripts |
Registers scripts.
| |
ReleaseImage |
Releases the image.
| |
Remote |
Performs a remote invocation.
| |
RemovedControl | Called after a child control is removed from the Controls collection of the Control object. (Inherited from Control.) | |
Render |
Renders the control to the specified HTML writer.
(Overrides WebControlRender(HtmlTextWriter).) | |
RenderBeginTag | Renders the HTML opening tag of the control to the specified writer. This method is used primarily by control developers. (Inherited from WebControl.) | |
RenderChildren | 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.) | |
RenderContents | Renders the contents of the control to the specified writer. This method is used primarily by control developers. (Inherited from WebControl.) | |
RenderControl(HtmlTextWriter) | Outputs server control content to a provided HtmlTextWriter object and stores tracing information about the control if tracing is enabled. (Inherited from Control.) | |
RenderControl(HtmlTextWriter, ControlAdapter) | Outputs server control content to a provided HtmlTextWriter object using a provided ControlAdapter object. (Inherited from Control.) | |
RenderEndTag | Renders the HTML closing tag of the control into the specified writer. This method is used primarily by control developers. (Inherited from WebControl.) | |
ReplaceInvalidFileNameChars |
Fixes an invalid file name.
| |
ResolveAdapter | Gets the control adapter responsible for rendering the specified control. (Inherited from Control.) | |
ResolveClientUrl | Gets a URL that can be used by the browser. (Inherited from Control.) | |
ResolveUrl | Converts a URL into one that is usable on the requesting client. (Inherited from Control.) | |
SaveControlState | Saves any server control state changes that have occurred since the time the page was posted back to the server. (Inherited from Control.) | |
SaveViewState | Saves any state that was modified after the TrackViewState method was invoked. (Inherited from WebControl.) | |
SetDesignModeState | Sets design-time data for a control. (Inherited from Control.) | |
SetRenderMethodDelegate | Assigns an event handler delegate to render the server control and its content into its parent control. (Inherited from Control.) | |
SetTraceData(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.) | |
SetTraceData(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.) | |
ToString | Returns a string that represents the current object. (Inherited from Object.) | |
TrackViewState | Causes the control to track changes to its view state so they can be stored in the object's ViewState property. (Inherited from WebControl.) | |
UrlIsWebRequest |
Determines if a URL is for a web request.
| |
WatermarkImage |
Applies a watermark to the image.
|
Name | Description | |
---|---|---|
CenteredChanged | Fires when the Centered property changes. | |
CreateSessionId | Used to override the session id used by the control to generate cache file names. The default is the
Session.Id of the page | |
CreateUniquePageName | 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. | |
DataBinding | Occurs when the server control binds to a data source. (Inherited from Control.) | |
Disposed | 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.) | |
Init | Occurs when the server control is initialized, which is the first step in its lifecycle. (Inherited from Control.) | |
Load | Occurs when the server control is loaded into the Page object. (Inherited from Control.) | |
PartialPost |
Fires when the control receives post data from the client, without a full PostBack. Returns a string containing the posted data.
| |
PreRender | Occurs after the Control object is loaded but prior to rendering. (Inherited from Control.) | |
RemoteInvoke | Fires when the control is told to RemoteInvoke. Returns a string containing the remote method's return
value. | |
ScrollBarVisibilityChanged | Fires when the ScrollPort.ScrollBarVisibility property has changed. | |
ScrollPositionChanged | Fires when the position of the scroll bars have changed. | |
Unload | Occurs when the server control is unloaded from memory. (Inherited from Control.) |
Caution |
---|
WebViewerControl control is available with .NET Framework 3.5 and 4.5.2 only. |