Documentation for: ASP.NET Ajax Version 1.0

This documentation is for a previous version. For the current released version, see the ASP.NET Ajax documentation on MSDN.

 

 

 

 

 

 

 

ScriptControl Class

Provides an abstract base class for a script control.

Syntax

CSharp

[AspNetHostingPermissionAttribute(SecurityAction.LinkDemand, Level = AspNetHostingPermissionLevel.Minimal)]
[AspNetHostingPermissionAttribute(SecurityAction.InheritanceDemand, Level = AspNetHostingPermissionLevel.Minimal)]
public abstract class ScriptControl : WebControl, IScriptControl

VisualBasic

<AspNetHostingPermissionAttribute(SecurityAction.LinkDemand, Level := AspNetHostingPermissionLevel.Minimal)> _
<AspNetHostingPermissionAttribute(SecurityAction.InheritanceDemand, Level := AspNetHostingPermissionLevel.Minimal)> _
Public MustInherit Class ScriptControl _
	Inherits WebControl _
	Implements IScriptControl

ManagedCPlusPlus

[AspNetHostingPermissionAttribute(SecurityAction::LinkDemand, Level = AspNetHostingPermissionLevel::Minimal)]
[AspNetHostingPermissionAttribute(SecurityAction::InheritanceDemand, Level = AspNetHostingPermissionLevel::Minimal)]
public ref class ScriptControl abstract : public WebControl, IScriptControl

JSharp

/** @attribute AspNetHostingPermissionAttribute(SecurityAction.LinkDemand, Level = AspNetHostingPermissionLevel.Minimal) */
/** @attribute AspNetHostingPermissionAttribute(SecurityAction.InheritanceDemand, Level = AspNetHostingPermissionLevel.Minimal) */
public abstract class ScriptControl extends WebControl implements IScriptControl

Members

IconMemberDescription
ScriptControlNew()Initializes a new instance of the ScriptControl class in a derived class.
AccessKeyGets or sets the access key that allows you to quickly navigate to the Web server control. (Inherited from WebControl.)
AdapterGets the browser-specific adapter for the control. (Inherited from Control.)
AddAttributesToRender(HtmlTextWriter)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(Control, Int32)Called after a child control is added to the Controls collection of the Control object. (Inherited from Control.)
AddParsedSubObject(Object)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.)
ApplyStyle(Style)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(Page)Applies the style properties defined in the page style sheet to the control. (Inherited from Control.)
AppRelativeTemplateSourceDirectoryGets or sets the application-relative virtual directory of the Page or UserControl object that contains this control. (Inherited from Control.)
AttributesGets the collection of arbitrary attributes (for rendering only) that do not correspond to properties on the control. (Inherited from WebControl.)
BackColorGets or sets the background color of the Web server control. (Inherited from WebControl.)
BindingContainerGets the control that contains this control's data binding. (Inherited from Control.)
BorderColorGets or sets the border color of the Web control. (Inherited from WebControl.)
BorderStyleGets or sets the border style of the Web server control. (Inherited from WebControl.)
BorderWidthGets or sets the border width of the Web server control. (Inherited from WebControl.)
BuildProfileTree(String, Boolean)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.)
ChildControlsCreatedGets a value that indicates whether the server control's child controls have been created. (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.)
ClientIDGets the server control identifier generated by ASP.NET. (Inherited from Control.)
ClientIDSeparatorGets a character value representing the separator character used in the ClientID property. (Inherited from Control.)
ContextGets the HttpContext object associated with the server control for the current Web request. (Inherited from Control.)
ControlsGets a ControlCollection object that represents the child controls for a specified server control in the UI hierarchy. (Inherited from Control.)
ControlStyleGets the style of the Web server control. This property is used primarily by control developers. (Inherited from WebControl.)
ControlStyleCreatedGets 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.)
CopyBaseAttributes(WebControl)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()Called by the ASP.NET page framework to notify server controls that use composition-based implementation to create any child controls they contain in preparation for posting back or rendering. (Inherited from Control.)
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.)
CssClassGets or sets the Cascading Style Sheet (CSS) class rendered by the Web server control on the client. (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.)
DataBindingOccurs when the server control binds to a data source. (Inherited from Control.)
DesignModeGets a value indicating whether a control is being used on a design surface. (Inherited from Control.)
Dispose()Enables a server control to perform final clean up before it is released from memory. (Inherited from Control.)
DisposedOccurs 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.)
EnabledGets or sets a value indicating whether the Web server control is enabled. (Inherited from WebControl.)
EnableThemingGets or sets a value indicating whether themes apply to this control. (Inherited from WebControl.)
EnableViewStateGets 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.)
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.)
Equals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
EventsGets a list of event handler delegates for the control. This property is read-only. (Inherited from Control.)
Finalize()Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
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 method. (Inherited from Control.)
Focus()Sets input focus to a control. (Inherited from Control.)
FontGets the font properties associated with the Web server control. (Inherited from WebControl.)
ForeColorGets or sets the foreground color (typically the color of the text) of the Web server control. (Inherited from WebControl.)
GetDesignModeState()Gets design-time data for a control. (Inherited from Control.)
GetHashCode()Serves as a hash function for a particular type. (Inherited from Object.)
GetScriptDescriptors()When overridden in a derived class, returns the ScriptDescriptor objects for the control.
GetScriptReferences()When overridden in a derived class, returns the script files for the control.
GetType()Gets the Type of the current instance. (Inherited from Object.)
HasAttributesGets a value indicating whether the control has attributes set. (Inherited from WebControl.)
HasChildViewStateGets a value indicating whether the current server control's child controls have any saved view-state settings. (Inherited from Control.)
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.)
HeightGets or sets the height of the Web server control. (Inherited from WebControl.)
IDGets or sets the programmatic identifier assigned to the server control. (Inherited from Control.)
IdSeparatorGets the character used to separate control identifiers. (Inherited from Control.)
InitOccurs when the server control is initialized, which is the first step in its lifecycle. (Inherited from Control.)
IsChildControlStateClearedGets a value indicating whether controls contained within this control have control state. (Inherited from Control.)
IsEnabledGets a value indicating whether the control is enabled. (Inherited from WebControl.)
IsLiteralContent()Determines if the server control holds only literal content. (Inherited from Control.)
IsTrackingViewStateGets a value that indicates whether the server control is saving changes to its view state. (Inherited from Control.)
IsViewStateEnabledGets a value indicating whether view state is enabled for this control. (Inherited from Control.)
LoadOccurs when the server control is loaded into the Page object. (Inherited from Control.)
LoadControlState(Object)Restores control-state information from a previous page request that was saved by the SaveControlState() method. (Inherited from Control.)
LoadViewState(Object)Restores view-state information from a previous request that was saved with the SaveViewState() method. (Inherited from WebControl.)
LoadViewStateByIDGets a value indicating whether the control participates in loading its view state by ID instead of index. (Inherited from Control.)
MapPathSecure(String)Retrieves the physical path that a virtual path, either absolute or relative, maps to. (Inherited from Control.)
MemberwiseClone()Creates a shallow copy of the current Object. (Inherited from Object.)
MergeStyle(Style)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.)
NamingContainerGets 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.)
OnBubbleEvent(Object, EventArgs)Determines whether the event for the server control is passed up the page's UI server control hierarchy. (Inherited from Control.)
OnDataBinding(EventArgs)Raises the DataBinding event. (Inherited from Control.)
OnInit(EventArgs)Raises the Init event. (Inherited from Control.)
OnLoad(EventArgs)Raises the Load event. (Inherited from Control.)
OnPreRender(EventArgs)Raises the OnPreRender(EventArgs) event and registers the script control with the ScriptManager control. (Overrides Control.OnPreRender(EventArgs).)
OnUnload(EventArgs)Raises the Unload event. (Inherited from Control.)
OpenFile(String)Gets a Stream used to read a file. (Inherited from Control.)
PageGets a reference to the Page instance that contains the server control. (Inherited from Control.)
ParentGets a reference to the server control's parent control in the page control hierarchy. (Inherited from Control.)
PreRenderOccurs after the Control object is loaded but prior to rendering. (Inherited from Control.)
RaiseBubbleEvent(Object, EventArgs)Assigns any sources of the event and its information to the control's parent. (Inherited from Control.)
RemovedControl(Control)Called after a child control is removed from the Controls collection of the Control object. (Inherited from Control.)
Render(HtmlTextWriter)Raises the Render(EventArgs) event and sends server control content to a provided HtmlTextWriter object, which writes the content to be rendered to the browser. (Overrides WebControl.Render(HtmlTextWriter).)
RenderBeginTag(HtmlTextWriter)Renders the HTML opening tag of the control to the specified writer. This method is used primarily by control developers. (Inherited from WebControl.)
RenderChildren(HtmlTextWriter)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(HtmlTextWriter)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(HtmlTextWriter)Renders the HTML closing tag of the control into the specified writer. This method is used primarily by control developers. (Inherited from WebControl.)
ResolveAdapter()Gets the control adapter responsible for rendering the specified control. (Inherited from Control.)
ResolveClientUrl(String)Gets a URL that can be used by the browser. (Inherited from Control.)
ResolveUrl(String)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(IDictionary)Sets design-time data for a control. (Inherited from Control.)
SetRenderMethodDelegate(RenderMethod)Assigns an event handler delegate to render the server control and its content into its parent control. (Inherited from Control.)
SiteGets information about the container that hosts the current control when rendered on a design surface. (Inherited from Control.)
SkinIDGets or sets the skin to apply to the control. (Inherited from WebControl.)
StyleGets 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.)
TabIndexGets or sets the tab index of the Web server control. (Inherited from WebControl.)
TagKeyGets the HtmlTextWriterTag value that corresponds to this Web server control. This property is used primarily by control developers. (Inherited from WebControl.)
TagNameGets the name of the control tag. This property is used primarily by control developers. (Inherited from WebControl.)
TemplateControlGets or sets a reference to the template that contains this control. (Inherited from Control.)
TemplateSourceDirectoryGets the virtual directory of the Page or UserControl that contains the current server control. (Inherited from Control.)
ToolTipGets or sets the text displayed when the mouse pointer hovers over the Web server control. (Inherited from WebControl.)
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.)
UniqueIDGets the unique, hierarchically qualified identifier for the server control. (Inherited from Control.)
UnloadOccurs when the server control is unloaded from memory. (Inherited from Control.)
ViewStateGets 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.)
ViewStateIgnoresCaseGets a value that indicates whether the StateBag object is case-insensitive. (Inherited from Control.)
VisibleGets or sets a value that indicates whether a server control is rendered as UI on the page. (Inherited from Control.)
WidthGets or sets the width of the Web server control. (Inherited from WebControl.)

Remarks

ScriptControl inherits from the WebControl class and implements the IScriptControl interface. The WebControl class is a base class for ASP.NET Web server controls. The ScriptControl is an abstract class, which you cannot instantiate directly. Instead, you derive a class based on this abstract class.

The ScriptControl base class tests the page for a ScriptManager control during the PreRender stage of the derived control. The ScriptControl base class also makes sure that the derived control calls methods of the ScriptManager control to register script during the Render event. This includes registering ScriptDescriptor objects for the ScriptControl when the Render(HtmlTextWriter) method is called. The Render(HtmlTextWriter) method makes sure that ScriptDescriptor objects are not rendered unless the ScriptControl itself is rendered. This enables a ScriptControl to work inside a closed WebPart control.

You can add as many descriptors and types as necessary to any class that you derive from ScriptControl.

Permissions

  • AspNetHostingPermission

    for operating in a hosted environment. Demand value: LinkDemand. Permission value: Minimal.

  • AspNetHostingPermission

    for operating in a hosted environment. Demand value: InheritanceDemand. Permission value: Minimal.

Inheritance Hierarchy

Assembly: System.Web.Extensions (Module: System.Web.Extensions)