MasterPage MasterPage MasterPage MasterPage Class

Definition

Acts as a template and merging container for pages that are composed only of Content controls and their respective child controls.

public ref class MasterPage : System::Web::UI::UserControl
public class MasterPage : System.Web.UI.UserControl
type MasterPage = class
    inherit UserControl
Public Class MasterPage
Inherits UserControl
Inheritance

Examples

This section contains four code examples:

  • The first code example demonstrates how to create a master page declaratively.

  • The second code example represents the content page that is associated with the master page that was created in the first code example.

  • The third code example demonstrates how to add a property to a master page.

  • The fourth code example demonstrates how to use a content page to access a public property on the master page.

The following example demonstrates how to create a master page declaratively and to add some content to it using a content page. The first Web page is the .master page named MasterPageSample_1.master.

<%@ Master Language="C#" %>  
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">  
<html >  
<head runat="server">  
    <title>MasterPage Example</title>  
</head>  
<body>  
    <form id="form1" runat="server">  
    <div>  
        <asp:contentplaceholder id="ContentPlaceHolder1" runat="server" />  
    </div>  
    </form>  
</body>  
</html>  
<%@ Master Language="VB" %>  
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">  
<html >  
<head runat="server">  
    <title>MasterPage Example</title>  
</head>  
<body>  
    <form id="form1" runat="server">  
    <div>  
        <asp:contentplaceholder id="ContentPlaceHolder1" runat="server" />  
    </div>  
    </form>  
</body>  
</html>  

The following example represents the content page that is associated with MasterPageSample_1.master. It contains a Content control and identifies the ContentPlaceHolder control that the content is associated with by using the ContentPlaceHolderID property.

<%@ Page Language="C#" MasterPageFile="~/MasterPageSample_1cs.master" Title="Content Page"%>  

<asp:content   
    runat="server"  
    contentplaceholderid="ContentPlaceHolder1" >Hello, Master Pages!</asp:content>  
<%@ Page Language="VB" MasterPageFile="~/MasterPageSample_1vb.master" Title="Content Page"%>  

<asp:content   
    runat="server"  
    contentplaceholderid="ContentPlaceHolder1" >Hello, Master Pages!</asp:content>  

The following example demonstrates how to add a property to a master page. The ClassName attribute is used to name the master page.

<%@ Master Language="C#" ClassName="MasterExample" %>  

<script runat="server">  
        public string SiteName  
        {  
            get { return "My Site Name"; }  
        }  
</script>  

<html >  
<head runat="server">  
    <title>MasterPage Example</title>  
</head>  
<body>  
    <form id="form1" runat="server">  
    <div>  
        <asp:contentplaceholder id="ContentPlaceHolder1" runat="server">  
        </asp:contentplaceholder>  
    </div>  
    </form>  
</body>  
</html>  
<%@ Master Language="VB" ClassName="MasterExample" %>  

<script runat="server">  
  Public ReadOnly Property SiteName() As String  
    Get  
      Return "My Site Name"  
    End Get  
  End Property  

</script>  

<html >  
<head runat="server">  
    <title>MasterPage Example</title>  
</head>  
<body>  
    <form id="form1" runat="server">  
    <div>  
        <asp:contentplaceholder id="ContentPlaceHolder1" runat="server">  
        </asp:contentplaceholder>  
    </div>  
    </form>  
</body>  
</html>  

The following example shows how to use a content page to access the public property SiteName on the master page in the preceding code example.

<%@ Page Language="C#" MasterPageFile="~/MasterPage.master" Title="MasterPage Example" %>  

<script runat="server">  
  protected void Page_Load(object sender, EventArgs e)  
  {  
    MasterExample m = (MasterExample)Page.Master;  
    mylabel.Text = m.SiteName;  
  }  
</script>  

<asp:Content ID="Content1" ContentPlaceHolderID="ContentPlaceHolder1" runat="Server">  
    Hello, Master Pages!  
    <asp:Label runat="server" Text="Label" ID="mylabel"></asp:Label>  
</asp:Content>  
<%@ Page Language="VB" MasterPageFile="~/MasterPage.master" Title="MasterPage Example" %>  

<script runat="server">  

  Protected Sub Page_Load(ByVal sender As Object, ByVal e As System.EventArgs)  
    Dim m As MasterExample = CType(Page.Master, MasterPage)  
    mylabel.Text = m.SiteName  
  End Sub  
</script>  

<asp:Content ID="Content1" ContentPlaceHolderID="ContentPlaceHolder1" runat="Server">  
    Hello, Master Pages!  
    <asp:Label runat="server" Text="Label" ID="mylabel"></asp:Label>  
</asp:Content>  

Remarks

A master page functions as a template container and merging page for content pages in your ASP.NET Web application. Master pages provide a convenient way to share structure and content across a set of content pages. You use content placeholders to define the sections of the master page to replace with content from the content pages.

When you use a master page and its related content pages, you add the required XHTML document tags (such as html, head, and body) only to the master page and no longer create your other .aspx files (ASP.NET pages) as stand-alone Web pages. The content pages define the content to insert into the placeholders in the master page.

When an HTTP request is made for a page at run time, the master page and content pages are combined into a single class with the same name as the content pages. The resulting compiled, merged class derives from the Page class.

A master page can contain direct markup and server controls, as well as container controls. Every element that is placed in the master page outside of a ContentPlaceHolder control is rendered on all pages that result from merging the master page and content pages.

Each content page that is related to the master page must reference the master page in a MasterPageFile attribute of its directive. Content pages can contain only a @ Page directive and one or more Content controls. All of your page text, markup, and server controls must be placed within Content controls. You identify the ContentPlaceHolder control of a master page that a Content control is associated with by setting the ContentPlaceHolderID property of the Content control.

At run time, the dynamic content from each Content control in the requested page is merged with the master page in the exact location of the related ContentPlaceHolder control. Any other markup and controls in the master page are unaffected. Event handlers can be defined in both the master class and on the content page. For more information, see Events in ASP.NET Master and Content Pages.

The MasterPage class is associated with files that have a .master extension. These files are compiled at run time as MasterPage objects and are cached in server memory.

The master page is made available to the content page through the Master property of the base Page class. The Master property returns the instance of the master page; however, it is typed as the base MasterPage class. To access controls, properties, and functions of the master page, the Master property can be cast to a MasterPage object. The class name of the master page is defined using the ClassName attribute of the directive.

Note

Files with .master extensions are not served to a browser.

The directives that are valid on a master page are the same as those that are available on a UserControl object. They can include the following attributes:

  • AutoEventWireup

  • ClassName

  • CodeFile

  • CompilerMode

  • CompilerOptions

  • Debug

  • Description

  • EnableTheming

  • EnableViewState

  • Explicit

  • Inherits

  • Language

  • LinePragmas

  • MasterPageFile

  • Src

  • Strict

  • WarningLevel

Master page directives do not override the directives on individual content pages.

Master pages are most often created declaratively. If you want to create a master page programmatically, derive directly from the MasterPage class. In addition to extending the MasterPage class, you must create the .master file to visually display the user interface (UI) that is associated with the classes that you have invoked in your source file.

Note

When you create a master page by creating your own class first, you must include all namespaces that are required for the classes that are used by the page.

For more information about master pages, see ASP.NET Master Pages.

Constructors

MasterPage() MasterPage() MasterPage() MasterPage()

Creates a new instance of the MasterPage class.

Properties

Adapter Adapter Adapter Adapter

Gets the browser-specific adapter for the control.

(Inherited from Control)
Application Application Application Application

Gets the Application object for the current Web request.

(Inherited from UserControl)
AppRelativeTemplateSourceDirectory AppRelativeTemplateSourceDirectory AppRelativeTemplateSourceDirectory AppRelativeTemplateSourceDirectory

Gets or sets the application-relative virtual directory of the Page or UserControl object that contains this control.

(Inherited from Control)
AppRelativeVirtualPath AppRelativeVirtualPath AppRelativeVirtualPath AppRelativeVirtualPath

Gets or sets the application-relative, virtual directory path to the file from which the control is parsed and compiled.

(Inherited from TemplateControl)
Attributes Attributes Attributes Attributes

Gets a collection of all attribute name and value pairs declared in the user control tag within the .aspx file.

(Inherited from UserControl)
AutoHandlers AutoHandlers AutoHandlers AutoHandlers

The AutoHandlers property has been deprecated in ASP.NET NET 2.0. It is used by generated classes and is not intended for use within your code.

(Inherited from TemplateControl)
BindingContainer BindingContainer BindingContainer BindingContainer

Gets the control that contains this control's data binding.

(Inherited from Control)
Cache Cache Cache Cache

Gets the Cache object that is associated with the application that contains the user control.

(Inherited from UserControl)
CachePolicy CachePolicy CachePolicy CachePolicy

Gets a reference to a collection of caching parameters for this user control.

(Inherited from UserControl)
ChildControlsCreated ChildControlsCreated ChildControlsCreated ChildControlsCreated

Gets a value that indicates whether the server control's child controls have been created.

(Inherited from Control)
ClientID ClientID ClientID ClientID

Gets the control ID for HTML markup that is generated by ASP.NET.

(Inherited from Control)
ClientIDMode ClientIDMode ClientIDMode ClientIDMode

Gets or sets the algorithm that is used to generate the value of the ClientID property.

(Inherited from Control)
ClientIDSeparator ClientIDSeparator ClientIDSeparator ClientIDSeparator

Gets a character value representing the separator character used in the ClientID property.

(Inherited from Control)
ContentPlaceHolders ContentPlaceHolders ContentPlaceHolders ContentPlaceHolders

Gets a list of ContentPlaceHolder controls that the master page uses to define different content regions.

ContentTemplates ContentTemplates ContentTemplates ContentTemplates

Gets a list of content controls that are associated with the master page.

Context Context Context Context

Gets the HttpContext object associated with the server control for the current Web request.

(Inherited from Control)
Controls Controls Controls Controls

Gets a ControlCollection object that represents the child controls for a specified server control in the UI hierarchy.

(Inherited from Control)
DataItemContainer DataItemContainer DataItemContainer DataItemContainer

Gets a reference to the naming container if the naming container implements IDataItemContainer.

(Inherited from Control)
DataKeysContainer DataKeysContainer DataKeysContainer DataKeysContainer

Gets a reference to the naming container if the naming container implements IDataKeysControl.

(Inherited from Control)
DesignMode DesignMode DesignMode DesignMode

Gets a value indicating whether a control is being used on a design surface.

(Inherited from Control)
EnableTheming EnableTheming EnableTheming EnableTheming

Gets or sets a Boolean value indicating whether themes apply to the control that is derived from the TemplateControl class.

(Inherited from TemplateControl)
EnableViewState EnableViewState EnableViewState 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 Events Events Events

Gets a list of event handler delegates for the control. This property is read-only.

(Inherited from Control)
HasChildViewState HasChildViewState HasChildViewState HasChildViewState

Gets a value indicating whether the current server control's child controls have any saved view-state settings.

(Inherited from Control)
IControlBuilderAccessor.ControlBuilder IControlBuilderAccessor.ControlBuilder IControlBuilderAccessor.ControlBuilder IControlBuilderAccessor.ControlBuilder

For a description of this member, see ControlBuilder.

(Inherited from Control)
IControlDesignerAccessor.UserData IControlDesignerAccessor.UserData IControlDesignerAccessor.UserData IControlDesignerAccessor.UserData

For a description of this member, see UserData.

(Inherited from Control)
ID ID ID ID

Gets or sets the programmatic identifier assigned to the server control.

(Inherited from Control)
IDataBindingsAccessor.DataBindings IDataBindingsAccessor.DataBindings IDataBindingsAccessor.DataBindings IDataBindingsAccessor.DataBindings

For a description of this member, see DataBindings.

(Inherited from Control)
IDataBindingsAccessor.HasDataBindings IDataBindingsAccessor.HasDataBindings IDataBindingsAccessor.HasDataBindings IDataBindingsAccessor.HasDataBindings

For a description of this member, see HasDataBindings.

(Inherited from Control)
IdSeparator IdSeparator IdSeparator IdSeparator

Gets the character used to separate control identifiers.

(Inherited from Control)
IExpressionsAccessor.Expressions IExpressionsAccessor.Expressions IExpressionsAccessor.Expressions IExpressionsAccessor.Expressions

For a description of this member, see Expressions.

(Inherited from Control)
IExpressionsAccessor.HasExpressions IExpressionsAccessor.HasExpressions IExpressionsAccessor.HasExpressions IExpressionsAccessor.HasExpressions

For a description of this member, see HasExpressions.

(Inherited from Control)
IsChildControlStateCleared IsChildControlStateCleared IsChildControlStateCleared IsChildControlStateCleared

Gets a value indicating whether controls contained within this control have control state.

(Inherited from Control)
IsPostBack IsPostBack IsPostBack IsPostBack

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.

(Inherited from UserControl)
IsTrackingViewState IsTrackingViewState IsTrackingViewState IsTrackingViewState

Gets a value that indicates whether the server control is saving changes to its view state.

(Inherited from Control)
IsViewStateEnabled IsViewStateEnabled IsViewStateEnabled IsViewStateEnabled

Gets a value indicating whether view state is enabled for this control.

(Inherited from Control)
IUserControlDesignerAccessor.InnerText IUserControlDesignerAccessor.InnerText IUserControlDesignerAccessor.InnerText IUserControlDesignerAccessor.InnerText

Gets or sets the text that appears between the opening and closing tags of a user control.

(Inherited from UserControl)
IUserControlDesignerAccessor.TagName IUserControlDesignerAccessor.TagName IUserControlDesignerAccessor.TagName IUserControlDesignerAccessor.TagName

Gets or sets the full tag name of the user control.

(Inherited from UserControl)
LoadViewStateByID LoadViewStateByID LoadViewStateByID LoadViewStateByID

Gets a value indicating whether the control participates in loading its view state by ID instead of index.

(Inherited from Control)
Master Master Master Master

Gets the parent master page of the current master in nested master pages scenarios.

MasterPageFile MasterPageFile MasterPageFile MasterPageFile

Gets or sets the name of the master page that contains the current content.

NamingContainer NamingContainer NamingContainer 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)
Page Page Page Page

Gets a reference to the Page instance that contains the server control.

(Inherited from Control)
Parent Parent Parent Parent

Gets a reference to the server control's parent control in the page control hierarchy.

(Inherited from Control)
RenderingCompatibility RenderingCompatibility RenderingCompatibility RenderingCompatibility

Gets a value that specifies the ASP.NET version that rendered HTML will be compatible with.

(Inherited from Control)
Request Request Request Request

Gets the HttpRequest object for the current Web request.

(Inherited from UserControl)
Response Response Response Response

Gets the HttpResponse object for the current Web request.

(Inherited from UserControl)
Server Server Server Server

Gets the HttpServerUtility object for the current Web request.

(Inherited from UserControl)
Session Session Session Session

Gets the HttpSessionState object for the current Web request.

(Inherited from UserControl)
Site Site Site Site

Gets information about the container that hosts the current control when rendered on a design surface.

(Inherited from Control)
SkinID SkinID SkinID SkinID

Gets or sets the skin to apply to the control.

(Inherited from Control)
SupportAutoEvents SupportAutoEvents SupportAutoEvents SupportAutoEvents

Gets a value indicating whether the TemplateControl control supports automatic events.

(Inherited from TemplateControl)
TemplateControl TemplateControl TemplateControl TemplateControl

Gets or sets a reference to the template that contains this control.

(Inherited from Control)
TemplateSourceDirectory TemplateSourceDirectory TemplateSourceDirectory TemplateSourceDirectory

Gets the virtual directory of the Page or UserControl that contains the current server control.

(Inherited from Control)
Trace Trace Trace Trace

Gets the TraceContext object for the current Web request.

(Inherited from UserControl)
UniqueID UniqueID UniqueID UniqueID

Gets the unique, hierarchically qualified identifier for the server control.

(Inherited from Control)
ValidateRequestMode ValidateRequestMode ValidateRequestMode 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 ViewState ViewState 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 ViewStateIgnoresCase ViewStateIgnoresCase ViewStateIgnoresCase

Gets a value that indicates whether the StateBag object is case-insensitive.

(Inherited from Control)
ViewStateMode ViewStateMode ViewStateMode ViewStateMode

Gets or sets the view-state mode of this control.

(Inherited from Control)
Visible Visible Visible Visible

Gets or sets a value that indicates whether a server control is rendered as UI on the page.

(Inherited from Control)

Methods

AddContentTemplate(String, ITemplate) AddContentTemplate(String, ITemplate) AddContentTemplate(String, ITemplate) AddContentTemplate(String, ITemplate)

Adds a Content control to the ContentTemplates dictionary.

AddedControl(Control, Int32) AddedControl(Control, Int32) AddedControl(Control, Int32) AddedControl(Control, Int32)

Called after a child control is added to the Controls collection of the Control object.

(Inherited from Control)
AddParsedSubObject(Object) AddParsedSubObject(Object) AddParsedSubObject(Object) 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)
ApplyStyleSheetSkin(Page) ApplyStyleSheetSkin(Page) ApplyStyleSheetSkin(Page) ApplyStyleSheetSkin(Page)

Applies the style properties defined in the page style sheet to the control.

(Inherited from Control)
BeginRenderTracing(TextWriter, Object) BeginRenderTracing(TextWriter, Object) BeginRenderTracing(TextWriter, Object) BeginRenderTracing(TextWriter, Object)

Begins design-time tracing of rendering data.

(Inherited from Control)
BuildProfileTree(String, Boolean) BuildProfileTree(String, Boolean) BuildProfileTree(String, Boolean) 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)
ClearCachedClientID() ClearCachedClientID() ClearCachedClientID() ClearCachedClientID()

Sets the cached ClientID value to null.

(Inherited from Control)
ClearChildControlState() ClearChildControlState() ClearChildControlState() ClearChildControlState()

Deletes the control-state information for the server control's child controls.

(Inherited from Control)
ClearChildState() ClearChildState() ClearChildState() ClearChildState()

Deletes the view-state and control-state information for all the server control's child controls.

(Inherited from Control)
ClearChildViewState() ClearChildViewState() ClearChildViewState() ClearChildViewState()

Deletes the view-state information for all the server control's child controls.

(Inherited from Control)
ClearEffectiveClientIDMode() ClearEffectiveClientIDMode() ClearEffectiveClientIDMode() ClearEffectiveClientIDMode()

Sets the ClientIDMode property of the current control instance and of any child controls to Inherit.

(Inherited from Control)
Construct() Construct() Construct() Construct()

Performs design-time logic.

(Inherited from TemplateControl)
CreateChildControls() CreateChildControls() CreateChildControls() 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() CreateControlCollection() CreateControlCollection() CreateControlCollection()

Creates a new ControlCollection object to hold the child controls (both literal and server) of the server control.

(Inherited from Control)
CreateResourceBasedLiteralControl(Int32, Int32, Boolean) CreateResourceBasedLiteralControl(Int32, Int32, Boolean) CreateResourceBasedLiteralControl(Int32, Int32, Boolean) CreateResourceBasedLiteralControl(Int32, Int32, Boolean)

Accesses literal strings stored in a resource. The CreateResourceBasedLiteralControl(Int32, Int32, Boolean) method is not intended for use from within your code.

(Inherited from TemplateControl)
DataBind() DataBind() DataBind() DataBind()

Binds a data source to the invoked server control and all its child controls.

(Inherited from Control)
DataBind(Boolean) DataBind(Boolean) DataBind(Boolean) 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() DataBindChildren() DataBindChildren() DataBindChildren()

Binds a data source to the server control's child controls.

(Inherited from Control)
DesignerInitialize() DesignerInitialize() DesignerInitialize() DesignerInitialize()

Performs any initialization steps on the user control that are required by RAD designers.

(Inherited from UserControl)
Dispose() Dispose() Dispose() Dispose()

Enables a server control to perform final clean up before it is released from memory.

(Inherited from Control)
EndRenderTracing(TextWriter, Object) EndRenderTracing(TextWriter, Object) EndRenderTracing(TextWriter, Object) EndRenderTracing(TextWriter, Object)

Ends design-time tracing of rendering data.

(Inherited from Control)
EnsureChildControls() EnsureChildControls() EnsureChildControls() EnsureChildControls()

Determines whether the server control contains child controls. If it does not, it creates child controls.

(Inherited from Control)
EnsureID() EnsureID() EnsureID() EnsureID()

Creates an identifier for controls that do not have an identifier assigned.

(Inherited from Control)
Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Determines whether the specified object is equal to the current object.

(Inherited from Object)
Eval(String) Eval(String) Eval(String) Eval(String)

Evaluates a data-binding expression.

(Inherited from TemplateControl)
Eval(String, String) Eval(String, String) Eval(String, String) Eval(String, String)

Evaluates a data-binding expression using the specified format string to display the result.

(Inherited from TemplateControl)
FindControl(String) FindControl(String) FindControl(String) FindControl(String)

Searches the current naming container for a server control with the specified id parameter.

(Inherited from Control)
FindControl(String, Int32) FindControl(String, Int32) FindControl(String, Int32) 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)
Focus() Focus() Focus() Focus()

Sets input focus to a control.

(Inherited from Control)
FrameworkInitialize() FrameworkInitialize() FrameworkInitialize() FrameworkInitialize()

Initializes the control that is derived from the TemplateControl class.

(Inherited from TemplateControl)
GetDesignModeState() GetDesignModeState() GetDesignModeState() GetDesignModeState()

Gets design-time data for a control.

(Inherited from Control)
GetGlobalResourceObject(String, String) GetGlobalResourceObject(String, String) GetGlobalResourceObject(String, String) GetGlobalResourceObject(String, String)

Gets an application-level resource object based on the specified ClassKey and ResourceKey properties.

(Inherited from TemplateControl)
GetGlobalResourceObject(String, String, Type, String) GetGlobalResourceObject(String, String, Type, String) GetGlobalResourceObject(String, String, Type, String) GetGlobalResourceObject(String, String, Type, String)

Gets an application-level resource object based on the specified ClassKey and ResourceKey properties, object type, and property name of the resource.

(Inherited from TemplateControl)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Serves as the default hash function.

(Inherited from Object)
GetLocalResourceObject(String) GetLocalResourceObject(String) GetLocalResourceObject(String) GetLocalResourceObject(String)

Gets a page-level resource object based on the specified ResourceKey property.

(Inherited from TemplateControl)
GetLocalResourceObject(String, Type, String) GetLocalResourceObject(String, Type, String) GetLocalResourceObject(String, Type, String) GetLocalResourceObject(String, Type, String)

Gets a page-level resource object based on the specified ResourceKey property, object type, and property name.

(Inherited from TemplateControl)
GetRouteUrl(Object) GetRouteUrl(Object) GetRouteUrl(Object) GetRouteUrl(Object)

Gets the URL that corresponds to a set of route parameters.

(Inherited from Control)
GetRouteUrl(RouteValueDictionary) GetRouteUrl(RouteValueDictionary) GetRouteUrl(RouteValueDictionary) GetRouteUrl(RouteValueDictionary)

Gets the URL that corresponds to a set of route parameters.

(Inherited from Control)
GetRouteUrl(String, Object) GetRouteUrl(String, Object) GetRouteUrl(String, Object) GetRouteUrl(String, Object)

Gets the URL that corresponds to a set of route parameters and a route name.

(Inherited from Control)
GetRouteUrl(String, RouteValueDictionary) GetRouteUrl(String, RouteValueDictionary) GetRouteUrl(String, RouteValueDictionary) GetRouteUrl(String, RouteValueDictionary)

Gets the URL that corresponds to a set of route parameters and a route name.

(Inherited from Control)
GetType() GetType() GetType() GetType()

Gets the Type of the current instance.

(Inherited from Object)
GetUniqueIDRelativeTo(Control) GetUniqueIDRelativeTo(Control) GetUniqueIDRelativeTo(Control) GetUniqueIDRelativeTo(Control)

Returns the prefixed portion of the UniqueID property of the specified control.

(Inherited from Control)
HasControls() HasControls() HasControls() HasControls()

Determines if the server control contains any child controls.

(Inherited from Control)
HasEvents() HasEvents() HasEvents() HasEvents()

Returns a value indicating whether events are registered for the control or any child controls.

(Inherited from Control)
InitializeAsUserControl(Page) InitializeAsUserControl(Page) InitializeAsUserControl(Page) InitializeAsUserControl(Page)

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.

(Inherited from UserControl)
InstantiateInContentPlaceHolder(Control, ITemplate) InstantiateInContentPlaceHolder(Control, ITemplate) InstantiateInContentPlaceHolder(Control, ITemplate) InstantiateInContentPlaceHolder(Control, ITemplate)

Provides a method to set the current template control to a page that owns the master page.

IsLiteralContent() IsLiteralContent() IsLiteralContent() IsLiteralContent()

Determines if the server control holds only literal content.

(Inherited from Control)
LoadControl(String) LoadControl(String) LoadControl(String) LoadControl(String)

Loads a Control object from a file based on a specified virtual path.

(Inherited from TemplateControl)
LoadControl(Type, Object[]) LoadControl(Type, Object[]) LoadControl(Type, Object[]) LoadControl(Type, Object[])

Loads a Control object based on a specified type and constructor parameters.

(Inherited from TemplateControl)
LoadControlState(Object) LoadControlState(Object) LoadControlState(Object) LoadControlState(Object)

Restores control-state information from a previous page request that was saved by the SaveControlState() method.

(Inherited from Control)
LoadTemplate(String) LoadTemplate(String) LoadTemplate(String) LoadTemplate(String)

Obtains an instance of the ITemplate interface from an external file.

(Inherited from TemplateControl)
LoadViewState(Object) LoadViewState(Object) LoadViewState(Object) LoadViewState(Object)

Restores the view-state information from a previous user control request that was saved by the SaveViewState() method.

(Inherited from UserControl)
MapPath(String) MapPath(String) MapPath(String) MapPath(String)

Assigns a virtual file path, either absolute or relative, to a physical file path.

(Inherited from UserControl)
MapPathSecure(String) MapPathSecure(String) MapPathSecure(String) MapPathSecure(String)

Retrieves the physical path that a virtual path, either absolute or relative, maps to.

(Inherited from Control)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
OnAbortTransaction(EventArgs) OnAbortTransaction(EventArgs) OnAbortTransaction(EventArgs) OnAbortTransaction(EventArgs)

Raises the AbortTransaction event.

(Inherited from TemplateControl)
OnBubbleEvent(Object, EventArgs) OnBubbleEvent(Object, EventArgs) OnBubbleEvent(Object, EventArgs) OnBubbleEvent(Object, EventArgs)

Determines whether the event for the server control is passed up the page's UI server control hierarchy.

(Inherited from Control)
OnCommitTransaction(EventArgs) OnCommitTransaction(EventArgs) OnCommitTransaction(EventArgs) OnCommitTransaction(EventArgs)

Raises the CommitTransaction event.

(Inherited from TemplateControl)
OnDataBinding(EventArgs) OnDataBinding(EventArgs) OnDataBinding(EventArgs) OnDataBinding(EventArgs)

Raises the DataBinding event.

(Inherited from Control)
OnError(EventArgs) OnError(EventArgs) OnError(EventArgs) OnError(EventArgs)

Raises the Error event.

(Inherited from TemplateControl)
OnInit(EventArgs) OnInit(EventArgs) OnInit(EventArgs) OnInit(EventArgs)

Raises the Init event.

(Inherited from UserControl)
OnLoad(EventArgs) OnLoad(EventArgs) OnLoad(EventArgs) OnLoad(EventArgs)

Raises the Load event.

(Inherited from Control)
OnPreRender(EventArgs) OnPreRender(EventArgs) OnPreRender(EventArgs) OnPreRender(EventArgs)

Raises the PreRender event.

(Inherited from Control)
OnUnload(EventArgs) OnUnload(EventArgs) OnUnload(EventArgs) OnUnload(EventArgs)

Raises the Unload event.

(Inherited from Control)
OpenFile(String) OpenFile(String) OpenFile(String) OpenFile(String)

Gets a Stream used to read a file.

(Inherited from Control)
ParseControl(String) ParseControl(String) ParseControl(String) ParseControl(String)

Parses an input string into a Control object on the Web Forms page or user control.

(Inherited from TemplateControl)
ParseControl(String, Boolean) ParseControl(String, Boolean) ParseControl(String, Boolean) ParseControl(String, Boolean)

Parses an input string into a Control object on the ASP.NET Web page or user control.

(Inherited from TemplateControl)
RaiseBubbleEvent(Object, EventArgs) RaiseBubbleEvent(Object, EventArgs) RaiseBubbleEvent(Object, EventArgs) RaiseBubbleEvent(Object, EventArgs)

Assigns any sources of the event and its information to the control's parent.

(Inherited from Control)
ReadStringResource() ReadStringResource() ReadStringResource() ReadStringResource()

Reads a string resource. The ReadStringResource() method is not intended for use from within your code.

(Inherited from TemplateControl)
RemovedControl(Control) RemovedControl(Control) RemovedControl(Control) RemovedControl(Control)

Called after a child control is removed from the Controls collection of the Control object.

(Inherited from Control)
Render(HtmlTextWriter) Render(HtmlTextWriter) Render(HtmlTextWriter) Render(HtmlTextWriter)

Sends server control content to a provided HtmlTextWriter object, which writes the content to be rendered on the client.

(Inherited from Control)
RenderChildren(HtmlTextWriter) RenderChildren(HtmlTextWriter) RenderChildren(HtmlTextWriter) 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)
RenderControl(HtmlTextWriter) RenderControl(HtmlTextWriter) RenderControl(HtmlTextWriter) 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) RenderControl(HtmlTextWriter, ControlAdapter) RenderControl(HtmlTextWriter, ControlAdapter) RenderControl(HtmlTextWriter, ControlAdapter)

Outputs server control content to a provided HtmlTextWriter object using a provided ControlAdapter object.

(Inherited from Control)
ResolveAdapter() ResolveAdapter() ResolveAdapter() ResolveAdapter()

Gets the control adapter responsible for rendering the specified control.

(Inherited from Control)
ResolveClientUrl(String) ResolveClientUrl(String) ResolveClientUrl(String) ResolveClientUrl(String)

Gets a URL that can be used by the browser.

(Inherited from Control)
ResolveUrl(String) ResolveUrl(String) ResolveUrl(String) ResolveUrl(String)

Converts a URL into one that is usable on the requesting client.

(Inherited from Control)
SaveControlState() SaveControlState() SaveControlState() 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() SaveViewState() SaveViewState() SaveViewState()

Saves any user control view-state changes that have occurred since the last page postback.

(Inherited from UserControl)
SetDesignModeState(IDictionary) SetDesignModeState(IDictionary) SetDesignModeState(IDictionary) SetDesignModeState(IDictionary)

Sets design-time data for a control.

(Inherited from Control)
SetRenderMethodDelegate(RenderMethod) SetRenderMethodDelegate(RenderMethod) SetRenderMethodDelegate(RenderMethod) SetRenderMethodDelegate(RenderMethod)

Assigns an event handler delegate to render the server control and its content into its parent control.

(Inherited from Control)
SetStringResourcePointer(Object, Int32) SetStringResourcePointer(Object, Int32) SetStringResourcePointer(Object, Int32) SetStringResourcePointer(Object, Int32)

Sets a pointer to a string resource. The SetStringResourcePointer(Object, Int32) method is used by generated classes and is not intended for use from within your code.

(Inherited from TemplateControl)
SetTraceData(Object, Object) SetTraceData(Object, Object) SetTraceData(Object, Object) 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) SetTraceData(Object, Object, Object) SetTraceData(Object, Object, Object) 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)
TestDeviceFilter(String) TestDeviceFilter(String) TestDeviceFilter(String) TestDeviceFilter(String)

Returns a Boolean value indicating whether a device filter applies to the HTTP request.

(Inherited from TemplateControl)
ToString() ToString() ToString() ToString()

Returns a string that represents the current object.

(Inherited from Object)
TrackViewState() TrackViewState() TrackViewState() TrackViewState()

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 ViewState property.

(Inherited from Control)
TryUpdateModel<TModel>(TModel) TryUpdateModel<TModel>(TModel) TryUpdateModel<TModel>(TModel) TryUpdateModel<TModel>(TModel)

Attempts to update the model instance by using the values from the data-bound control.

(Inherited from UserControl)
TryUpdateModel<TModel>(TModel, IValueProvider) TryUpdateModel<TModel>(TModel, IValueProvider) TryUpdateModel<TModel>(TModel, IValueProvider) TryUpdateModel<TModel>(TModel, IValueProvider)

Attempts to update the model instance using values from the value provider.

(Inherited from UserControl)
UpdateModel<TModel>(TModel) UpdateModel<TModel>(TModel) UpdateModel<TModel>(TModel) UpdateModel<TModel>(TModel)

Updates the model instance by using values from the data-bound control.

(Inherited from UserControl)
UpdateModel<TModel>(TModel, IValueProvider) UpdateModel<TModel>(TModel, IValueProvider) UpdateModel<TModel>(TModel, IValueProvider) UpdateModel<TModel>(TModel, IValueProvider)

Updates the specified model instance using values from the value provider of the user control.

(Inherited from UserControl)
WriteUTF8ResourceString(HtmlTextWriter, Int32, Int32, Boolean) WriteUTF8ResourceString(HtmlTextWriter, Int32, Int32, Boolean) WriteUTF8ResourceString(HtmlTextWriter, Int32, Int32, Boolean) WriteUTF8ResourceString(HtmlTextWriter, Int32, Int32, Boolean)

Writes a resource string to an HtmlTextWriter control. The WriteUTF8ResourceString(HtmlTextWriter, Int32, Int32, Boolean) method is used by generated classes and is not intended for use from within your code.

(Inherited from TemplateControl)
XPath(String) XPath(String) XPath(String) XPath(String)

Evaluates an XPath data-binding expression.

(Inherited from TemplateControl)
XPath(String, IXmlNamespaceResolver) XPath(String, IXmlNamespaceResolver) XPath(String, IXmlNamespaceResolver) XPath(String, IXmlNamespaceResolver)

Evaluates an XPath data-binding expression using the specified prefix and namespace mappings for namespace resolution.

(Inherited from TemplateControl)
XPath(String, String) XPath(String, String) XPath(String, String) XPath(String, String)

Evaluates an XPath data-binding expression using the specified format string to display the result.

(Inherited from TemplateControl)
XPath(String, String, IXmlNamespaceResolver) XPath(String, String, IXmlNamespaceResolver) XPath(String, String, IXmlNamespaceResolver) XPath(String, String, IXmlNamespaceResolver)

Evaluates an XPath data-binding expression using the specified prefix and namespace mappings for namespace resolution and the specified format string to display the result.

(Inherited from TemplateControl)
XPathSelect(String) XPathSelect(String) XPathSelect(String) XPathSelect(String)

Evaluates an XPath data-binding expression and returns a node collection that implements the IEnumerable interface.

(Inherited from TemplateControl)
XPathSelect(String, IXmlNamespaceResolver) XPathSelect(String, IXmlNamespaceResolver) XPathSelect(String, IXmlNamespaceResolver) XPathSelect(String, IXmlNamespaceResolver)

Evaluates an XPath data-binding expression using the specified prefix and namespace mappings for namespace resolution and returns a node collection that implements the IEnumerable interface.

(Inherited from TemplateControl)

Events

AbortTransaction AbortTransaction AbortTransaction AbortTransaction

Occurs when a user ends a transaction.

(Inherited from TemplateControl)
CommitTransaction CommitTransaction CommitTransaction CommitTransaction

Occurs when a transaction completes.

(Inherited from TemplateControl)
DataBinding DataBinding DataBinding DataBinding

Occurs when the server control binds to a data source.

(Inherited from Control)
Disposed Disposed Disposed 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)
Error Error Error Error

Occurs when an unhandled exception is thrown.

(Inherited from TemplateControl)
Init Init Init Init

Occurs when the server control is initialized, which is the first step in its lifecycle.

(Inherited from Control)
Load Load Load Load

Occurs when the server control is loaded into the Page object.

(Inherited from Control)
PreRender PreRender PreRender PreRender

Occurs after the Control object is loaded but prior to rendering.

(Inherited from Control)
Unload Unload Unload Unload

Occurs when the server control is unloaded from memory.

(Inherited from Control)

Explicit Interface Implementations

IAttributeAccessor.GetAttribute(String) IAttributeAccessor.GetAttribute(String) IAttributeAccessor.GetAttribute(String) IAttributeAccessor.GetAttribute(String)

Returns the value of the specified user control attribute.

(Inherited from UserControl)
IAttributeAccessor.SetAttribute(String, String) IAttributeAccessor.SetAttribute(String, String) IAttributeAccessor.SetAttribute(String, String) IAttributeAccessor.SetAttribute(String, String)

Sets the value of the specified user control attribute.

(Inherited from UserControl)
IControlDesignerAccessor.GetDesignModeState() IControlDesignerAccessor.GetDesignModeState() IControlDesignerAccessor.GetDesignModeState() IControlDesignerAccessor.GetDesignModeState()

For a description of this member, see GetDesignModeState().

(Inherited from Control)
IControlDesignerAccessor.SetDesignModeState(IDictionary) IControlDesignerAccessor.SetDesignModeState(IDictionary) IControlDesignerAccessor.SetDesignModeState(IDictionary) IControlDesignerAccessor.SetDesignModeState(IDictionary)

For a description of this member, see SetDesignModeState(IDictionary).

(Inherited from Control)
IControlDesignerAccessor.SetOwnerControl(Control) IControlDesignerAccessor.SetOwnerControl(Control) IControlDesignerAccessor.SetOwnerControl(Control) IControlDesignerAccessor.SetOwnerControl(Control)

For a description of this member, see SetOwnerControl(Control).

(Inherited from Control)
IFilterResolutionService.CompareFilters(String, String) IFilterResolutionService.CompareFilters(String, String) IFilterResolutionService.CompareFilters(String, String) IFilterResolutionService.CompareFilters(String, String)

Returns a value that indicates whether a parent/child relationship exists between two specified device filters.

(Inherited from TemplateControl)
IFilterResolutionService.EvaluateFilter(String) IFilterResolutionService.EvaluateFilter(String) IFilterResolutionService.EvaluateFilter(String) IFilterResolutionService.EvaluateFilter(String)

Returns a value that indicates whether the specified filter is a type of the current filter object.

(Inherited from TemplateControl)
IParserAccessor.AddParsedSubObject(Object) IParserAccessor.AddParsedSubObject(Object) IParserAccessor.AddParsedSubObject(Object) IParserAccessor.AddParsedSubObject(Object)

For a description of this member, see AddParsedSubObject(Object).

(Inherited from Control)

Extension Methods

FindDataSourceControl(Control) FindDataSourceControl(Control) FindDataSourceControl(Control) FindDataSourceControl(Control)

Returns the data source that is associated with the data control for the specified control.

FindFieldTemplate(Control, String) FindFieldTemplate(Control, String) FindFieldTemplate(Control, String) FindFieldTemplate(Control, String)

Returns the field template for the specified column in the specified control's naming container.

FindMetaTable(Control) FindMetaTable(Control) FindMetaTable(Control) FindMetaTable(Control)

Returns the metatable object for the containing data control.

GetDefaultValues(INamingContainer) GetDefaultValues(INamingContainer) GetDefaultValues(INamingContainer) GetDefaultValues(INamingContainer)

Gets the collection of the default values for the specified data control.

GetMetaTable(INamingContainer) GetMetaTable(INamingContainer) GetMetaTable(INamingContainer) GetMetaTable(INamingContainer)

Gets the table metadata for the specified data control.

SetMetaTable(INamingContainer, MetaTable) SetMetaTable(INamingContainer, MetaTable) SetMetaTable(INamingContainer, MetaTable) SetMetaTable(INamingContainer, MetaTable)

Sets the table metadata for the specified data control.

SetMetaTable(INamingContainer, MetaTable, IDictionary<String,Object>) SetMetaTable(INamingContainer, MetaTable, IDictionary<String,Object>) SetMetaTable(INamingContainer, MetaTable, IDictionary<String,Object>) SetMetaTable(INamingContainer, MetaTable, IDictionary<String,Object>)

Sets the table metadata and default value mapping for the specified data control.

SetMetaTable(INamingContainer, MetaTable, Object) SetMetaTable(INamingContainer, MetaTable, Object) SetMetaTable(INamingContainer, MetaTable, Object) SetMetaTable(INamingContainer, MetaTable, Object)

Sets the table metadata and default value mapping for the specified data control.

TryGetMetaTable(INamingContainer, MetaTable) TryGetMetaTable(INamingContainer, MetaTable) TryGetMetaTable(INamingContainer, MetaTable) TryGetMetaTable(INamingContainer, MetaTable)

Determines whether table metadata is available.

EnableDynamicData(INamingContainer, Type) EnableDynamicData(INamingContainer, Type) EnableDynamicData(INamingContainer, Type) EnableDynamicData(INamingContainer, Type)

Enables Dynamic Data behavior for the specified data control.

EnableDynamicData(INamingContainer, Type, IDictionary<String,Object>) EnableDynamicData(INamingContainer, Type, IDictionary<String,Object>) EnableDynamicData(INamingContainer, Type, IDictionary<String,Object>) EnableDynamicData(INamingContainer, Type, IDictionary<String,Object>)

Enables Dynamic Data behavior for the specified data control.

EnableDynamicData(INamingContainer, Type, Object) EnableDynamicData(INamingContainer, Type, Object) EnableDynamicData(INamingContainer, Type, Object) EnableDynamicData(INamingContainer, Type, Object)

Enables Dynamic Data behavior for the specified data control.

Applies to

See also