This documentation is archived and is not being maintained.

UserControl Members

UserControl overview

Public Constructors

public constructorUserControl Constructor Initializes a new instance of the UserControl class.

Public Properties

public propertyApplication Gets the Application object for the current Web request.
public propertyAttributes Gets a collection of all attribute name and value pairs declared in the user control tag within the .aspx file.
public propertyCache Gets the Cache object that is associated with the application that contains the user control.
public propertyClientID (inherited from Control) Gets the server control identifier generated by ASP.NET.
public propertyControls (inherited from Control) Gets a ControlCollection object that represents the child controls for a specified server control in the UI hierarchy.
public propertyEnableViewState (inherited from 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.
public propertyID (inherited from Control) Gets or sets the programmatic identifier assigned to the server control.
public propertyIsPostBack Gets a value indicating whether the user control is being loaded in response to a client postback, or if it is being loaded and accessed for the first time.
public propertyNamingContainer (inherited from Control) Gets 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 propertyPage (inherited from Control) Gets a reference to the Page instance that contains the server control.
public propertyParent (inherited from Control) Gets a reference to the server control's parent control in the page control hierarchy.
public propertyRequest Gets the Request object for the current Web request.
public propertyResponse Gets the Response object for the current Web request.
public propertyServer Gets the Server object for the current Web request.
public propertySession Gets the Session object for the current Web request.
public propertySite (inherited from Control) Gets information about the Web site to which the server control belongs.
public propertyTemplateSourceDirectory (inherited from Control) Gets the virtual directory of the Page or UserControl that contains the current server control.
public propertyTrace Gets the TraceContext object for the current Web request.
public propertyUniqueID (inherited from Control) Gets the unique, hierarchically-qualified identifier for the server control.
public propertyVisible (inherited from Control) Gets or sets a value that indicates whether a server control is rendered as UI on the page.

Public Methods

public methodDataBind (inherited from Control) Binds a data source to the invoked server control and all its child controls.
public methodDesignerInitialize Performs any initialization steps on the user control that are required by RAD designers.
public methodDispose (inherited from Control) Enables a server control to perform final clean up before it is released from memory.
public methodEquals (inherited from Object) Overloaded. Determines whether two Object instances are equal.
public methodFindControl (inherited from Control) Overloaded. Searches the current naming container for the specified server control.
public methodGetHashCode (inherited from Object) Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.
public methodGetType (inherited from Object) Gets the Type of the current instance.
public methodHasControls (inherited from Control) Determines if the server control contains any child controls.
public methodInitializeAsUserControl Initializes the UserControl object that has been created declaratively. Since there are some differences between pages and user controls, this method makes sure that the user control is initialized properly.
public methodLoadControl (inherited from TemplateControl) Obtains a UserControl object from a user control file.
public methodLoadTemplate (inherited from TemplateControl) Obtains an instance of the ITemplate interface from an external file.
public methodMapPath Assigns a virtual file path, either absolute or relative, to a physical file path.
public methodParseControl (inherited from TemplateControl) Parses an input string into a Control on the Web Forms page or user control.
public methodRenderControl (inherited from Control) Outputs server control content to a provided HtmlTextWriter object and stores tracing information about the control if tracing is enabled.
public methodResolveUrl (inherited from Control) Converts a URL into one that is usable on the requesting client.
public methodToString (inherited from Object) Returns a String that represents the current Object.

Public Events

public eventAbortTransaction (inherited from TemplateControl) Occurs when a user aborts a transaction.
public eventCommitTransaction (inherited from TemplateControl) Occurs when a transaction completes.
public eventDataBinding (inherited from Control) Occurs when the server control binds to a data source.
public eventDisposed (inherited from Control) 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.
public eventError (inherited from TemplateControl) Occurs when an unhandled exception is thrown.
public eventInit (inherited from Control) Occurs when the server control is initialized, which is the first step in the its lifecycle.
public eventLoad (inherited from Control) Occurs when the server control is loaded into the Page object.
public eventPreRender (inherited from Control) Occurs when the server control is about to render to its containing Page object.
public eventUnload (inherited from Control) Occurs when the server control is unloaded from memory.

Protected Properties

protected propertyChildControlsCreated (inherited from Control) Gets a value that indicates whether the server control's child controls have been created.
protected propertyContext (inherited from Control) Gets the HttpContext object associated with the server control for the current Web request.
protected propertyEvents (inherited from Control) Gets a list of event handler delegates for the control. This property is read-only.
protected propertyHasChildViewState (inherited from Control) Gets a value indicating whether the current server control's child controls have any saved view-state settings.
protected propertyIsTrackingViewState (inherited from Control) Gets a value that indicates whether the server control is saving changes to its view state.
protected propertyViewState (inherited from Control) 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.
protected propertyViewStateIgnoresCase (inherited from Control) Gets a value that indicates whether the StateBag object is case-insensitive.

Protected Methods

protected methodAddedControl (inherited from Control) Called after a control is added to the Controls collection of another control.
protected methodAddParsedSubObject (inherited from Control) Notifies the server control that an element, either XML or HTML, was parsed, and adds the element to the server control's ControlCollection object.
protected methodClearChildViewState (inherited from Control) Deletes the view-state information for all the server control's child controls.
protected methodConstruct (inherited from TemplateControl) Performs construction time logic.
protected methodCreateChildControls (inherited from Control) Notifies server controls that use composition-based implementation to create any child controls they contain in preparation for posting back or rendering.
protected methodCreateControlCollection (inherited from Control) Creates a new ControlCollection object to hold the child controls (both literal and server) of the server control.
protected methodEnsureChildControls (inherited from Control) Determines whether the server control contains child controls. If it does not, it creates child controls.
protected methodFinalize (inherited from Object) Overridden. Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.

In C# and C++, finalizers are expressed using destructor syntax.

protected methodIsLiteralContent (inherited from Control) Determines if the server control holds only literal content.
protected methodLoadViewState Overridden. Restores the view-state information from a previous user control request that was saved by the SaveViewState method.
protected methodMapPathSecure (inherited from Control) Retrieves the physical path that a virtual path, either absolute or relative, maps to.
protected methodMemberwiseClone (inherited from Object) Creates a shallow copy of the current Object.
protected methodOnAbortTransaction (inherited from TemplateControl) Raises the AbortTransaction event.
protected methodOnBubbleEvent (inherited from Control) Determines whether the event for the server control is passed up the page's UI server control hierarchy.
protected methodOnCommitTransaction (inherited from TemplateControl) Raises the CommitTransaction event.
protected methodOnDataBinding (inherited from Control) Raises the DataBinding event.
protected methodOnError (inherited from TemplateControl) Raises the Error event.
protected methodOnInit Overridden. Raises the Init event.
protected methodOnLoad (inherited from Control) Raises the Load event.
protected methodOnPreRender (inherited from Control) Raises the PreRender event.
protected methodOnUnload (inherited from Control) Raises the Unload event.
Note   Server controls should perform any final cleanup, such as closing files, closing database connections, and discarding objects, during this stage of the server control lifecycle.
protected methodRaiseBubbleEvent (inherited from Control) Assigns any sources of the event and its information to the control's parent.
protected methodRemovedControl (inherited from Control) Called after a control is removed from the Controls collection of another control.
protected methodRender (inherited from Control) Sends server control content to a provided HtmlTextWriter object, which writes the content to be rendered on the client.
protected methodRenderChildren (inherited from Control) Outputs the content of a server control's children to a provided HtmlTextWriter object, which writes the content to be rendered on the client.
protected methodSaveViewState Overridden. Saves any user control view-state changes that have occurred since the last page postback.
protected methodTrackViewState (inherited from Control) Causes 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.

See Also

UserControl Class | System.Web.UI Namespace

Show: