Export (0) Print
Expand All

Control Class

Defines the properties, methods, and events that are shared by all ASP.NET server controls.

System.Object
  System.Web.UI.Control
    More...

Namespace:  System.Web.UI
Assembly:  System.Web (in System.Web.dll)

[BindableAttribute(true)]
[ThemeableAttribute(false)]
public class Control : IComponent, IDisposable, 
	IParserAccessor, IUrlResolutionService, IDataBindingsAccessor, IControlBuilderAccessor, IControlDesignerAccessor, 
	IExpressionsAccessor

The Control type exposes the following members.

  NameDescription
Public methodControlInitializes a new instance of the Control class.
Top

  NameDescription
Protected propertyAdapterGets the browser-specific adapter for the control.
Public propertyAppRelativeTemplateSourceDirectoryGets or sets the application-relative virtual directory of the Page or UserControl object that contains this control.
Public propertyBindingContainerInfrastructure. Gets the control that contains this control's data binding.
Protected propertyChildControlsCreatedGets a value that indicates whether the server control's child controls have been created.
Public propertyClientIDGets the control ID for HTML markup that is generated by ASP.NET.
Public propertyClientIDModeGets or sets the algorithm that is used to generate the value of the ClientID property.
Protected propertyClientIDSeparatorGets a character value representing the separator character used in the ClientID property.
Protected propertyContextGets the HttpContext object associated with the server control for the current Web request.
Public propertyControlsGets a ControlCollection object that represents the child controls for a specified server control in the UI hierarchy.
Public propertyDataItemContainerGets a reference to the naming container if the naming container implements IDataItemContainer.
Public propertyDataKeysContainerGets a reference to the naming container if the naming container implements IDataKeysControl.
Protected propertyDesignModeGets a value indicating whether a control is being used on a design surface.
Public propertyEnableThemingGets or sets a value indicating whether themes apply to this control.
Public propertyEnableViewStateGets 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.
Protected propertyEventsGets a list of event handler delegates for the control. This property is read-only.
Protected propertyHasChildViewStateGets a value indicating whether the current server control's child controls have any saved view-state settings.
Public propertyIDGets or sets the programmatic identifier assigned to the server control.
Protected propertyIdSeparatorInfrastructure. Gets the character used to separate control identifiers.
Protected propertyIsChildControlStateClearedGets a value indicating whether controls contained within this control have control state.
Protected propertyIsTrackingViewStateGets a value that indicates whether the server control is saving changes to its view state.
Protected propertyIsViewStateEnabledGets a value indicating whether view state is enabled for this control.
Protected propertyLoadViewStateByIDGets a value indicating whether the control participates in loading its view state by ID instead of index.
Public propertyNamingContainerGets a reference to the server control's naming container, which creates a unique namespace for differentiating between server controls with the same Control.ID property value.
Public propertyPageGets a reference to the Page instance that contains the server control.
Public propertyParentGets a reference to the server control's parent control in the page control hierarchy.
Public propertyRenderingCompatibilityGets a value that specifies the ASP.NET version that rendered HTML will be compatible with.
Public propertySiteGets information about the container that hosts the current control when rendered on a design surface.
Public propertySkinIDGets or sets the skin to apply to the control.
Public propertyTemplateControlGets or sets a reference to the template that contains this control.
Public propertyTemplateSourceDirectoryGets the virtual directory of the Page or UserControl that contains the current server control.
Public propertyUniqueIDGets the unique, hierarchically qualified identifier for the server control.
Public propertyValidateRequestModeGets or sets a value that indicates whether the control checks client input from the browser for potentially dangerous values.
Protected propertyViewStateGets 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.
Protected propertyViewStateIgnoresCaseGets a value that indicates whether the StateBag object is case-insensitive.
Public propertyViewStateModeGets or sets the view-state mode of this control.
Public propertyVisibleGets or sets a value that indicates whether a server control is rendered as UI on the page.
Top

  NameDescription
Protected methodAddedControlCalled after a child control is added to the Controls collection of the Control object.
Protected methodAddParsedSubObjectNotifies the server control that an element, either XML or HTML, was parsed, and adds the element to the server control's ControlCollection object.
Public methodApplyStyleSheetSkinApplies the style properties defined in the page style sheet to the control.
Protected methodBeginRenderTracingBegins design-time tracing of rendering data.
Protected methodBuildProfileTreeInfrastructure. Gathers information about the server control and delivers it to the Trace property to be displayed when tracing is enabled for the page.
Protected methodClearCachedClientIDInfrastructure. Sets the cached ClientID value to null.
Protected methodClearChildControlStateDeletes the control-state information for the server control's child controls.
Protected methodClearChildStateDeletes the view-state and control-state information for all the server control's child controls.
Protected methodClearChildViewStateDeletes the view-state information for all the server control's child controls.
Protected methodClearEffectiveClientIDModeInfrastructure. Sets the ClientIDMode property of the current control instance and of any child controls to Inherit.
Protected methodCreateChildControlsCalled 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.
Protected methodCreateControlCollectionCreates a new ControlCollection object to hold the child controls (both literal and server) of the server control.
Public methodDataBind()Binds a data source to the invoked server control and all its child controls.
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.
Protected methodDataBindChildrenBinds a data source to the server control's child controls.
Public methodDisposeEnables a server control to perform final clean up before it is released from memory.
Protected methodEndRenderTracingEnds design-time tracing of rendering data.
Protected methodEnsureChildControlsDetermines whether the server control contains child controls. If it does not, it creates child controls.
Protected methodEnsureIDCreates an identifier for controls that do not have an identifier assigned.
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodFindControl(String)Searches the current naming container for a server control with the specified id parameter.
Protected methodFindControl(String, Int32)Infrastructure. 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.
Public methodFocusSets input focus to a control.
Protected methodGetDesignModeStateInfrastructure. Gets design-time data for a control.
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetRouteUrl(Object)Gets the URL that corresponds to a set of route parameters.
Public methodGetRouteUrl(RouteValueDictionary)Gets the URL that corresponds to a set of route parameters.
Public methodGetRouteUrl(String, Object)Gets the URL that corresponds to a set of route parameters and a route name.
Public methodGetRouteUrl(String, RouteValueDictionary)Gets the URL that corresponds to a set of route parameters and a route name.
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodGetUniqueIDRelativeToReturns the prefixed portion of the UniqueID property of the specified control.
Public methodHasControlsDetermines if the server control contains any child controls.
Protected methodHasEventsReturns a value indicating whether events are registered for the control or any child controls.
Protected methodIsLiteralContentInfrastructure. Determines if the server control holds only literal content.
Protected methodLoadControlStateRestores control-state information from a previous page request that was saved by the SaveControlState method.
Protected methodLoadViewStateRestores view-state information from a previous page request that was saved by the SaveViewState method.
Protected methodMapPathSecureRetrieves the physical path that a virtual path, either absolute or relative, maps to.
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Protected methodOnBubbleEventDetermines whether the event for the server control is passed up the page's UI server control hierarchy.
Protected methodOnDataBindingRaises the DataBinding event.
Protected methodOnInitRaises the Init event.
Protected methodOnLoadRaises the Load event.
Protected methodOnPreRenderRaises the PreRender event.
Protected methodOnUnloadRaises the Unload event.
Protected methodOpenFileGets a Stream used to read a file.
Protected methodRaiseBubbleEventAssigns any sources of the event and its information to the control's parent.
Protected methodRemovedControlCalled after a child control is removed from the Controls collection of the Control object.
Protected methodRenderSends server control content to a provided HtmlTextWriter object, which writes the content to be rendered on the client.
Protected methodRenderChildrenOutputs the content of a server control's children to a provided HtmlTextWriter object, which writes the content to be rendered on the client.
Public methodRenderControl(HtmlTextWriter)Outputs server control content to a provided HtmlTextWriter object and stores tracing information about the control if tracing is enabled.
Protected methodRenderControl(HtmlTextWriter, ControlAdapter)Outputs server control content to a provided HtmlTextWriter object using a provided ControlAdapter object.
Protected methodResolveAdapterGets the control adapter responsible for rendering the specified control.
Public methodResolveClientUrlGets a URL that can be used by the browser.
Public methodResolveUrlConverts a URL into one that is usable on the requesting client.
Protected methodSaveControlStateSaves any server control state changes that have occurred since the time the page was posted back to the server.
Protected methodSaveViewStateSaves any server control view-state changes that have occurred since the time the page was posted back to the server.
Protected methodSetDesignModeStateSets design-time data for a control.
Public methodSetRenderMethodDelegateInfrastructure. Assigns an event handler delegate to render the server control and its content into its parent 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.
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.
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Protected methodTrackViewStateCauses tracking of view-state changes to the server control so they can be stored in the server control's StateBag object. This object is accessible through the Control.ViewState property.
Top

  NameDescription
Public eventDataBindingOccurs when the server control binds to a data source.
Public eventDisposedOccurs 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.
Public eventInitOccurs when the server control is initialized, which is the first step in its lifecycle.
Public eventLoadOccurs when the server control is loaded into the Page object.
Public eventPreRenderOccurs after the Control object is loaded but prior to rendering.
Public eventUnloadOccurs when the server control is unloaded from memory.
Top

  NameDescription
Public Extension MethodFindDataSourceControlReturns the data source that is associated with the data control for the specified control. (Defined by DynamicDataExtensions.)
Public Extension MethodFindFieldTemplateReturns the field template for the specified column in the specified control's naming container. (Defined by DynamicDataExtensions.)
Public Extension MethodFindMetaTableReturns the metatable object for the containing data control. (Defined by DynamicDataExtensions.)
Top

This is the primary class that you derive from when you develop custom ASP.NET server controls. Control does not have any user interface (UI) specific features. If you are authoring a control that does not have a UI, or combines other controls that render their own UI, derive from Control. If you are authoring a control that does have a UI, derive from WebControl or any control in the System.Web.UI.WebControls namespace that provides an appropriate starting point for your custom control.

The Control class is the base class for all ASP.NET server controls, including custom controls, user controls, and pages. ASP.NET pages are instances of the Page class, which inherits from the Control class, and that handle requests for files that have an .aspx extension.

The Control class can directly or indirectly be used as part of the user interface for your Web application, and as such should be scrutinized to make sure best practices for writing secure code and securing applications are followed.

For general information on these topics, see Overview of Web Application Security Threats, Security Policy Best Practices, and Key Security Concepts. For more specific information, see Securing Standard Controls, How to: Display Safe Error Messages, How to: Protect Against Script Exploits in a Web Application by Applying HTML Encoding to Strings, and Introduction to the Validation Controls.

TopicLocation
How to: Locate Child Controls by ID in an ASP.NET Web PageBuilding ASP .NET Web Applications
Developing Custom Data-Bound Web Server Controls for ASP.NET 1.1Authoring ASP.NET Controls
Walkthrough: Developing and Using a Custom Server ControlAuthoring ASP.NET Controls
Developing Custom Data-Bound Web Server Controls for ASP.NET 2.0Authoring ASP.NET Controls
How to: Locate the Web Forms Controls on a Page by Walking the Controls CollectionBuilding ASP .NET Web Applications
Walkthrough: Creating a Custom Data-Bound ASP.NET Web Control for ASP.NET 2.0Authoring ASP.NET Controls
Walkthrough: Creating a Custom Data-Bound ASP.NET Web Control for ASP.NET 1.1Authoring ASP.NET Controls
Walkthrough: Developing and Using a Custom Server ControlAuthoring ASP.NET Controls
Developing Custom Data-Bound Web Server Controls for ASP.NET 1.1Authoring ASP.NET Controls
Developing Custom Data-Bound Web Server Controls for ASP.NET 2.0Authoring ASP.NET Controls
Walkthrough: Creating a Custom Data-Bound ASP.NET Web Control for ASP.NET 2.0Authoring ASP.NET Controls
Walkthrough: Creating a Custom Data-Bound ASP.NET Web Control for ASP.NET 1.1Authoring ASP.NET Controls
How to: Locate Child Controls by ID in an ASP.NET Web PageBuilding ASP .NET Web Applications
How to: Locate the Web Forms Controls on a Page by Walking the Controls CollectionBuilding ASP .NET Web Applications
Developing Custom Data-Bound Web Server Controls for ASP.NET 1.1Building ASP .NET Web Applications in Visual Studio
Walkthrough: Creating a Custom Data-Bound ASP.NET Web Control for ASP.NET 1.1Building ASP .NET Web Applications in Visual Studio

The following example demonstrates a custom server control that derives from the Control class. The InnerContent class overrides the Control.Render method, checks to see if the class has any child controls on the page and determines whether the first child of the control is a literal control. If both of these conditions are met, the overridden method writes the HTML string <H2>Your Message:, the contents of the literal control, and a closing </H2> tag to the Web Forms page.

Security noteSecurity Note

This example has a text box that accepts user input, which is a potential security threat. By default, ASP.NET Web pages validate that user input does not include script or HTML elements. For more information, see Script Exploits Overview.

using System;
using System.Web;
using System.Web.UI;

namespace SimpleControlSamples {

    public class InnerContent : Control {
	[System.Security.Permissions.PermissionSet(System.Security.Permissions.SecurityAction.Demand, Name="Execution")] 
       protected override void Render(HtmlTextWriter output) {

           if ( (HasControls()) && (Controls[0] is LiteralControl) ) {
               output.Write("<H2>Your message : ");
               Controls[0].RenderControl(output);
               output.Write("</H2>");
           }
       }
    }    
}
   

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

System.Object
  System.Web.UI.Control
    System.Web.DynamicData.DynamicControl
    System.Web.DynamicData.DynamicDataManager
    System.Web.DynamicData.DynamicEntity
    System.Web.DynamicData.DynamicFilter
    System.Web.DynamicData.EntityTemplate
    System.Web.DynamicData.QueryableFilterRepeater
    System.Web.UI.BasePartialCachingControl
    System.Web.UI.DataBoundLiteralControl
    System.Web.UI.DataSourceControl
    System.Web.UI.DesignerDataBoundLiteralControl
    System.Web.UI.ExtenderControl
    System.Web.UI.HierarchicalDataSourceControl
    System.Web.UI.HtmlControls.HtmlControl
    System.Web.UI.LiteralControl
    System.Web.UI.MobileControls.DeviceSpecific
    System.Web.UI.MobileControls.MobileControl
    System.Web.UI.ScriptManager
    System.Web.UI.ScriptManagerProxy
    System.Web.UI.TemplateControl
    System.Web.UI.Timer
    System.Web.UI.UpdatePanel
    System.Web.UI.UpdateProgress
    System.Web.UI.WebControls.Content
    System.Web.UI.WebControls.ContentPlaceHolder
    System.Web.UI.WebControls.DataPager
    System.Web.UI.WebControls.DataPagerFieldItem
    System.Web.UI.WebControls.HiddenField
    System.Web.UI.WebControls.ListViewItem
    System.Web.UI.WebControls.Literal
    System.Web.UI.WebControls.LoginView
    System.Web.UI.WebControls.MenuItemTemplateContainer
    System.Web.UI.WebControls.MultiView
    System.Web.UI.WebControls.PlaceHolder
    System.Web.UI.WebControls.QueryExtender
    System.Web.UI.WebControls.Repeater
    System.Web.UI.WebControls.RepeaterItem
    System.Web.UI.WebControls.Substitution
    System.Web.UI.WebControls.View
    System.Web.UI.WebControls.WebControl
    System.Web.UI.WebControls.WebParts.ProxyWebPartManager
    System.Web.UI.WebControls.WebParts.WebPartManager
    System.Web.UI.WebControls.Xml
Show:
© 2014 Microsoft