Page Class

Definition

Represents an .aspx file, also known as a Web Forms page, requested from a server that hosts an ASP.NET Web application.

public ref class Page : System::Web::UI::TemplateControl, System::Web::IHttpHandler
public class Page : System.Web.UI.TemplateControl, System.Web.IHttpHandler
type Page = class
    inherit TemplateControl
    interface IHttpHandler
Public Class Page
Inherits TemplateControl
Implements IHttpHandler
Inheritance
Derived
Implements

Examples

A Visual Studio Web site project with source code is available to accompany this topic: Download.

The following code example demonstrates how the Page class is used in the code-behind page model. Note that the code-behind source file declares a partial class that inherits from a base page class. The base page class can be Page, or it can be another class that derives from Page. Furthermore, note that the partial class allows the code-behind file to use controls defined on the page without the need to define them as field members.

using System;

public partial class MyCodeBehindCS : System.Web.UI.Page
{     
    protected void Page_Load(object sender, EventArgs e)
    {

        // Place page-specific code here.
    }

    // Define a handler for the button click.
    protected void SubmitBtn_Click(object sender, EventArgs e)
    {	

        MySpan.InnerHtml = "Hello, " + MyTextBox.Text + ".";
    }
}
Partial Class MyCodeBehindVB
    Inherits System.Web.UI.Page


    Protected Sub Page_Load(ByVal sender As Object, ByVal e As System.EventArgs) Handles Me.Load

        ' Place page-specific code here.

    End Sub

    ' Define a handler for the button click.
    Protected Sub SubmitBtn_Click(ByVal sender As Object, ByVal e As System.EventArgs) Handles MyButton.Click

        MySpan.InnerHtml = "Hello, " + MyTextBox.Text + "."

    End Sub

End Class

The following code example shows the .aspx file that corresponds to the preceding code-behind source file.

Important

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.

<%@ Page Language="C#" CodeFile="pageexample.aspx.cs" Inherits="MyCodeBehindCS" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
    <title>Page Class Example</title>
</head>
<body>
    <form id="form1" runat="server">
    <div>
       <table>
          <tr>
            <td> Name: </td>
            <td> <asp:textbox id="MyTextBox" runat="server"/> </td>
          </tr>
          <tr>
             <td></td>
             <td><asp:button id="MyButton" text="Click Here" onclick="SubmitBtn_Click" runat="server"/></td>
          </tr>
          <tr>
             <td></td>
             <td><span id="MySpan" runat="server" /></td>
          </tr>
       </table>     
    </div>
    </form>
</body>
</html>
<%@ Page Language="VB" CodeFile="pageexample.aspx.vb" Inherits="MyCodeBehindVB" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
    <title>Page Class Example</title>
</head>
<body>
    <form id="form1" runat="server">
    <div>
       <table>
          <tr>
            <td> Name: </td>
            <td> <asp:textbox id="MyTextBox" runat="server"/> </td>
          </tr>
          <tr>
             <td></td>
             <td><asp:button id="MyButton" text="Click Here" onclick="SubmitBtn_Click" runat="server"/></td>
          </tr>
          <tr>
             <td></td>
             <td><span id="MySpan" runat="server" /></td>
          </tr>
       </table>         
    </div>
    </form>
</body>
</html>

You must use the @ Page directive and use the Inherits and CodeFile attributes to link the code-behind file to the .aspx file. In this example, the Inherits attribute indicates the MyCodeBehind class and the CodeFile attribute indicates the path to the language-specific file that contains the class.

The following code example demonstrates the single-file page model and how to access the IsPostBack property and the Response property of the Page.

<%@ Page Language="C#" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<script runat="server">

  protected void Page_Load(object sender, EventArgs e)
  {
    StringBuilder sb = new StringBuilder();
    
    if (Page.IsPostBack)
      sb.Append("You posted back to the page.<br />");

    sb.Append("The host address is " + Page.Request.UserHostAddress + ".<br />");
    sb.Append("The page title is \"" + Page.Header.Title + "\".");

    PageMessage.Text = sb.ToString();

  }
</script>

<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
    <title>Page Class Example</title>
</head>
<body>
    <form id="form1" 
          runat="server">
    <div>
    <asp:Label id="PageMessage" 
               runat="server"/>
    <br /> <br />
    <asp:Button id="PageButton"
                Text="PostBack"
                runat="server" />
    </div>
    </form>
</body>
</html>
<%@ Page Language="VB" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<script runat="server">

  Protected Sub Page_Load(ByVal sender As Object, ByVal e As System.EventArgs)

    Dim sb As New StringBuilder()
    
    If (Page.IsPostBack) Then
      
      sb.Append("You posted back to the page.<br />")
    
    End If
    
    sb.Append("The host address is " + Page.Request.UserHostAddress + ".<br />")
    sb.Append("The page title is """ + Page.Header.Title + """.")
    
    PageMessage.Text = sb.ToString()
    
  End Sub
  
</script>

<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
    <title>Page Class Example</title>
</head>
<body>
    <form id="form1" 
          runat="server">
    <div>
    <asp:Label id="PageMessage" 
               runat="server"/>
    <br /> <br />
    <asp:Button id="PageButton"
                Text="PostBack"
                runat="server" />    
    </div>
    </form>
</body>
</html>

Remarks

The Page class is associated with files that have an .aspx extension. These files are compiled at run time as Page objects and cached in server memory.

If you want to create a Web Forms page using the code-behind technique, derive from this class. Rapid application development (RAD) designers, such as Microsoft Visual Studio, automatically use this model to create Web Forms pages.

The Page object serves as the naming container for all server controls in a page, except those that implement the INamingContainer interface or are child controls of controls that implement this interface.

The Page class is a control that acts as 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.

Constructors

Page()

Initializes a new instance of the Page class.

Fields

postEventArgumentID

A string that defines the EVENTARGUMENT hidden field in the rendered page.

postEventSourceID

A string that defines the EVENTTARGET hidden field in the rendered page.

Properties

Adapter

Gets the browser-specific adapter for the control.

(Inherited from Control)
Application

Gets the HttpApplicationState object for the current Web request.

AppRelativeTemplateSourceDirectory

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

(Inherited from Control)
AppRelativeVirtualPath

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

(Inherited from TemplateControl)
AspCompatMode

Sets a value indicating whether the page can be executed on a single-threaded apartment (STA) thread.

AsyncMode

Sets a value indicating whether the page is processed synchronously or asynchronously.

AsyncTimeout

Gets or sets a value indicating the time-out interval used when processing asynchronous tasks.

AutoHandlers
Obsolete.

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)
AutoPostBackControl

Gets or sets the control in the page that is used to perform postbacks.

BindingContainer

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

(Inherited from Control)
Buffer

Sets a value indicating whether the page output is buffered.

Cache

Gets the Cache object associated with the application in which the page resides.

ChildControlsCreated

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

(Inherited from Control)
ClientID

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

(Inherited from Control)
ClientIDMode

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

(Inherited from Control)
ClientIDSeparator

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

(Inherited from Control)
ClientQueryString

Gets the query string portion of the requested URL.

ClientScript

Gets a ClientScriptManager object used to manage, register, and add script to the page.

ClientTarget

Gets or sets a value that allows you to override automatic detection of browser capabilities and to specify how a page is rendered for particular browser clients.

CodePage

Sets the code page identifier for the current Page.

ContentType

Sets the HTTP MIME type for the HttpResponse object associated with the page.

Context

Gets the HttpContext object associated with the page.

Controls

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

(Inherited from Control)
Culture

Sets the culture ID for the Thread object associated with the page.

DataItemContainer

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

(Inherited from Control)
DataKeysContainer

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

(Inherited from Control)
DesignMode

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

(Inherited from Control)
EnableEventValidation

Gets or sets a value indicating whether the page validates postback and callback events.

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

Gets or sets a value indicating whether the page maintains its view state, and the view state of any server controls it contains, when the current page request ends.

EnableViewStateMac

Gets or sets a value indicating whether ASP.NET should check message authentication codes (MAC) in the page's view state when the page is posted back from the client.

ErrorPage

Gets or sets the error page to which the requesting browser is redirected in the event of an unhandled page exception.

Events

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

(Inherited from Control)
FileDependencies
Obsolete.

Sets an array of files that the current HttpResponse object is dependent upon.

Form

Gets the HTML form for the page.

HasChildViewState

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

(Inherited from Control)
Header

Gets the document header for the page if the head element is defined with a runat=server in the page declaration.

ID

Gets or sets an identifier for a particular instance of the Page class.

IdSeparator

Gets the character used to separate control identifiers when building a unique ID for a control on a page.

IdSeparator

Gets the character used to separate control identifiers.

(Inherited from Control)
IsAsync

Gets a value indicating whether the page is processed asynchronously.

IsCallback

Gets a value that indicates whether the page request is the result of a callback.

IsChildControlStateCleared

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

(Inherited from Control)
IsCrossPagePostBack

Gets a value indicating whether the page is involved in a cross-page postback.

IsPostBack

Gets a value that indicates whether the page is being rendered for the first time or is being loaded in response to a postback.

IsPostBackEventControlRegistered

Gets a value that indicates whether the control in the page that performs postbacks has been registered.

IsReusable

Gets a value indicating whether the Page object can be reused.

IsTrackingViewState

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

(Inherited from Control)
IsValid

Gets a value indicating whether page validation succeeded.

IsViewStateEnabled

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

(Inherited from Control)
Items

Gets a list of objects stored in the page context.

LCID

Sets the locale identifier for the Thread object associated with the page.

LoadViewStateByID

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

(Inherited from Control)
MaintainScrollPositionOnPostBack

Gets or sets a value indicating whether to return the user to the same position in the client browser after postback. This property replaces the obsolete SmartNavigation property.

Master

Gets the master page that determines the overall look of the page.

MasterPageFile

Gets or sets the virtual path of the master page.

MaxPageStateFieldLength

Gets or sets the maximum length for the page's state field.

MetaDescription

Gets or sets the content of the "description" meta element.

MetaKeywords

Gets or sets the content of the "keywords" meta element.

ModelBindingExecutionContext

Gets the model binding execution context.

ModelState

Gets the model state dictionary object that contains the state of the model and of model-binding validation.

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

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

(Inherited from Control)
PageAdapter

Gets the adapter that renders the page for the specific requesting browser.

PageStatePersister

Gets the PageStatePersister object associated with the page.

Parent

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

(Inherited from Control)
PreviousPage

Gets the page that transferred control to the current page.

RenderingCompatibility

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

(Inherited from Control)
Request

Gets the HttpRequest object for the requested page.

Response

Gets the HttpResponse object associated with the Page object. This object allows you to send HTTP response data to a client and contains information about that response.

ResponseEncoding

Sets the encoding language for the current HttpResponse object.

RouteData

Gets the RouteData value of the current RequestContext instance.

Server

Gets the Server object, which is an instance of the HttpServerUtility class.

Session

Gets the current Session object provided by ASP.NET.

Site

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

(Inherited from Control)
SkinID

Gets or sets the skin to apply to the control.

(Inherited from Control)
SkipFormActionValidation

Gets or sets a value that indicates whether the query string value is validated.

SmartNavigation
Obsolete.

Gets or sets a value indicating whether smart navigation is enabled. This property is deprecated.

StyleSheetTheme

Gets or sets the name of the theme that is applied to the page early in the page life cycle.

SupportAutoEvents

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

(Inherited from TemplateControl)
TemplateControl

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

(Inherited from Control)
TemplateSourceDirectory

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

(Inherited from Control)
Theme

Gets or sets the name of the page theme.

Title

Gets or sets the title for the page.

Trace

Gets the TraceContext object for the current Web request.

TraceEnabled

Sets a value indicating whether tracing is enabled for the Page object.

TraceModeValue

Sets the mode in which trace statements are displayed on the page.

TransactionMode

Sets the level of transaction support for the page.

UICulture

Sets the user interface (UI) ID for the Thread object associated with the page.

UniqueFilePathSuffix

Gets a unique suffix to append to the file path for caching browsers.

UniqueID

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

(Inherited from Control)
UnobtrusiveValidationMode

Gets or sets a value that indicates whether unobtrusive JavaScript is used for client-side validation.

User

Gets information about the user making the page request.

ValidateRequestMode

Gets or sets a value that indicates whether the page checks client input from the browser for potentially dangerous values.

ValidateRequestMode

Gets or sets a value that indicates whether the control checks client input from the browser for potentially dangerous values.

(Inherited from Control)
Validators

Gets a collection of all validation controls contained on the requested page.

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)
ViewStateEncryptionMode

Gets or sets the encryption mode of the view state.

ViewStateIgnoresCase

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

(Inherited from Control)
ViewStateMode

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

(Inherited from Control)
ViewStateUserKey

Assigns an identifier to an individual user in the view-state variable associated with the current page.

Visible

Gets or sets a value indicating whether the Page object is rendered.

Methods

AddContentTemplate(String, ITemplate)

Called during page initialization to create a collection of content (from content controls) that is handed to a master page, if the current page or master page refers to a master page.

AddedControl(Control, Int32)

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

(Inherited from Control)
AddOnPreRenderCompleteAsync(BeginEventHandler, EndEventHandler)

Registers beginning and ending event handler delegates that do not require state information for an asynchronous page.

AddOnPreRenderCompleteAsync(BeginEventHandler, EndEventHandler, Object)

Registers beginning and ending event handler delegates for an asynchronous page.

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)
AddWrappedFileDependencies(Object)

Adds a list of dependent files that make up the current page. This method is used internally by the ASP.NET page framework and is not intended to be used directly from your code.

ApplyStyleSheetSkin(Page)

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

(Inherited from Control)
AspCompatBeginProcessRequest(HttpContext, AsyncCallback, Object)

Initiates a request for Active Server Page (ASP) resources. This method is provided for compatibility with legacy ASP applications.

AspCompatEndProcessRequest(IAsyncResult)

Terminates a request for Active Server Page (ASP) resources. This method is provided for compatibility with legacy ASP applications.

AsyncPageBeginProcessRequest(HttpContext, AsyncCallback, Object)

Begins processing an asynchronous page request.

AsyncPageEndProcessRequest(IAsyncResult)

Ends processing an asynchronous page request.

BeginRenderTracing(TextWriter, Object)

Begins design-time tracing of rendering data.

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

Sets the cached ClientID value to null.

(Inherited from Control)
ClearChildControlState()

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

(Inherited from Control)
ClearChildState()

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

(Inherited from Control)
ClearChildViewState()

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

(Inherited from Control)
ClearEffectiveClientIDMode()

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

(Inherited from Control)
Construct()

Performs design-time logic.

(Inherited from TemplateControl)
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)
CreateHtmlTextWriter(TextWriter)

Creates an HtmlTextWriter object to render the page's content.

CreateHtmlTextWriterFromType(TextWriter, Type)

Creates a specified HtmlTextWriter object to render the page's content.

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()

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)
DesignerInitialize()

Performs any initialization of the instance of the Page class that is required by RAD designers. This method is used only at design time.

DeterminePostBackMode()

Returns a NameValueCollection of data posted back to the page using either a POST or a GET command.

DeterminePostBackModeUnvalidated()

Returns a name-value collection of data that was posted to the page using either a POST or a GET command, without performing ASP.NET request validation on the request.

Dispose()

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

(Inherited from Control)
EndRenderTracing(TextWriter, Object)

Ends design-time tracing of rendering data.

(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)
Eval(String)

Evaluates a data-binding expression.

(Inherited from TemplateControl)
Eval(String, String)

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

(Inherited from TemplateControl)
ExecuteRegisteredAsyncTasks()

Starts the execution of an asynchronous task.

FindControl(String)

Searches the page naming container for a server control with the specified identifier.

FindControl(String)

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

(Inherited from Control)
FindControl(String, Int32)

Searches the current naming container for a server control with the specified id and an integer, specified in the pathOffset parameter, which aids in the search. You should not override this version of the FindControl method.

(Inherited from Control)
Focus()

Sets input focus to a control.

(Inherited from Control)
FrameworkInitialize()

Initializes the control tree during page generation based on the declarative nature of the page.

FrameworkInitialize()

Initializes the control that is derived from the TemplateControl class.

(Inherited from TemplateControl)
GetDataItem()

Gets the data item at the top of the data-binding context stack.

GetDesignModeState()

Gets design-time data for a control.

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

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()

Serves as the default hash function.

(Inherited from Object)
GetLocalResourceObject(String)

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

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

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

(Inherited from TemplateControl)
GetPostBackClientEvent(Control, String)
Obsolete.

Gets a reference that can be used in a client event to post back to the server for the specified control and with the specified event arguments.

GetPostBackClientHyperlink(Control, String)
Obsolete.

Gets a reference, with javascript: appended to the beginning of it, that can be used in a client event to post back to the server for the specified control and with the specified event arguments.

GetPostBackEventReference(Control)
Obsolete.

Returns a string that can be used in a client event to cause postback to the server. The reference string is defined by the specified Control object.

GetPostBackEventReference(Control, String)
Obsolete.

Returns a string that can be used in a client event to cause postback to the server. The reference string is defined by the specified control that handles the postback and a string argument of additional event information.

GetRouteUrl(Object)

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

(Inherited from Control)
GetRouteUrl(RouteValueDictionary)

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

(Inherited from Control)
GetRouteUrl(String, Object)

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

(Inherited from Control)
GetRouteUrl(String, RouteValueDictionary)

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

(Inherited from Control)
GetType()

Gets the Type of the current instance.

(Inherited from Object)
GetTypeHashCode()

Retrieves a hash code that is generated by Page objects that are generated at run time. This hash code is unique to the Page object's control hierarchy.

GetUniqueIDRelativeTo(Control)

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

(Inherited from Control)
GetValidators(String)

Returns a collection of control validators for a specified validation group.

GetWrappedFileDependencies(String[])

Returns a list of physical file names that correspond to a list of virtual file locations.

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)
InitializeCulture()

Sets the Culture and UICulture for the current thread of the page.

InitOutputCache(Int32, String, String, OutputCacheLocation, String)

Initializes the output cache for the current page request.

InitOutputCache(Int32, String, String, String, OutputCacheLocation, String)

Initializes the output cache for the current page request.

InitOutputCache(OutputCacheParameters)

Initializes the output cache for the current page request based on an OutputCacheParameters object.

IsClientScriptBlockRegistered(String)
Obsolete.

Determines whether the client script block with the specified key is registered with the page.

IsLiteralContent()

Determines if the server control holds only literal content.

(Inherited from Control)
IsStartupScriptRegistered(String)
Obsolete.

Determines whether the client startup script is registered with the Page object.

LoadControl(String)

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

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

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

(Inherited from TemplateControl)
LoadControlState(Object)

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

(Inherited from Control)
LoadPageStateFromPersistenceMedium()

Loads any saved view-state information to the Page object.

LoadTemplate(String)

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

(Inherited from TemplateControl)
LoadViewState(Object)

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

(Inherited from Control)
MapPath(String)

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

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)
OnAbortTransaction(EventArgs)

Raises the AbortTransaction event.

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

Raises the CommitTransaction event.

(Inherited from TemplateControl)
OnDataBinding(EventArgs)

Raises the DataBinding event.

(Inherited from Control)
OnError(EventArgs)

Raises the Error event.

(Inherited from TemplateControl)
OnInit(EventArgs)

Raises the Init event to initialize the page.

OnInit(EventArgs)

Raises the Init event.

(Inherited from Control)
OnInitComplete(EventArgs)

Raises the InitComplete event after page initialization.

OnLoad(EventArgs)

Raises the Load event.

(Inherited from Control)
OnLoadComplete(EventArgs)

Raises the LoadComplete event at the end of the page load stage.

OnPreInit(EventArgs)

Raises the PreInit event at the beginning of page initialization.

OnPreLoad(EventArgs)

Raises the PreLoad event after postback data is loaded into the page server controls but before the OnLoad(EventArgs) event.

OnPreRender(EventArgs)

Raises the PreRender event.

(Inherited from Control)
OnPreRenderComplete(EventArgs)

Raises the PreRenderComplete event after the OnPreRenderComplete(EventArgs) event and before the page is rendered.

OnSaveStateComplete(EventArgs)

Raises the SaveStateComplete event after the page state has been saved to the persistence medium.

OnUnload(EventArgs)

Raises the Unload event.

(Inherited from Control)
OpenFile(String)

Gets a Stream used to read a file.

(Inherited from Control)
ParseControl(String)

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

(Inherited from TemplateControl)
ParseControl(String, Boolean)

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

(Inherited from TemplateControl)
ProcessRequest(HttpContext)

Sets the intrinsic server objects of the Page object, such as the Context, Request, Response, and Application properties.

RaiseBubbleEvent(Object, EventArgs)

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

(Inherited from Control)
RaisePostBackEvent(IPostBackEventHandler, String)

Notifies the server control that caused the postback that it should handle an incoming postback event.

ReadStringResource()

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

(Inherited from TemplateControl)
RegisterArrayDeclaration(String, String)
Obsolete.

Declares a value that is declared as an ECMAScript array declaration when the page is rendered.

RegisterAsyncTask(PageAsyncTask)

Registers a new asynchronous task with the page.

RegisterClientScriptBlock(String, String)
Obsolete.

Emits client-side script blocks to the response.

RegisterHiddenField(String, String)
Obsolete.

Allows server controls to automatically register a hidden field on the form. The field will be sent to the Page object when the HtmlForm server control is rendered.

RegisterOnSubmitStatement(String, String)
Obsolete.

Allows a page to access the client OnSubmit event. The script should be a function call to client code registered elsewhere.

RegisterRequiresControlState(Control)

Registers a control as one whose control state must be persisted.

RegisterRequiresPostBack(Control)

Registers a control as one that requires postback handling when the page is posted back to the server.

RegisterRequiresRaiseEvent(IPostBackEventHandler)

Registers an ASP.NET server control as one requiring an event to be raised when the control is processed on the Page object.

RegisterRequiresViewStateEncryption()

Registers a control with the page as one requiring view-state encryption.

RegisterStartupScript(String, String)
Obsolete.

Emits a client-side script block in the page response.

RegisterViewStateHandler()

Causes page view state to be persisted, if called.

RemovedControl(Control)

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

(Inherited from Control)
Render(HtmlTextWriter)

Initializes the HtmlTextWriter object and calls on the child controls of the Page to render.

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)

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)

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)
RequiresControlState(Control)

Determines whether the specified Control object is registered to participate in control state management.

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)
SavePageStateToPersistenceMedium(Object)

Saves any view-state and control-state information for the page.

SaveViewState()

Saves any server control view-state changes that have occurred since the time the page was posted back to the server.

(Inherited from Control)
SetDesignModeState(IDictionary)

Sets design-time data for a control.

(Inherited from Control)
SetFocus(Control)

Sets the browser focus to the specified control.

SetFocus(String)

Sets the browser focus to the control with the specified identifier.

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)

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)

Sets trace data for design-time tracing of rendering data, using the trace data key and the trace data value.

(Inherited from Control)
SetTraceData(Object, Object, Object)

Sets trace data for design-time tracing of rendering data, using the traced object, the trace data key, and the trace data value.

(Inherited from Control)
TestDeviceFilter(String)

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

(Inherited from TemplateControl)
ToString()

Returns a string that represents the current object.

(Inherited from Object)
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)

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

TryUpdateModel<TModel>(TModel, IValueProvider)

Updates the model instance using values from the specified value provider.

UnregisterRequiresControlState(Control)

Stops persistence of control state for the specified control.

UpdateModel<TModel>(TModel)

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

UpdateModel<TModel>(TModel, IValueProvider)

Updates the specified model instance using values from a specified value provider.

Validate()

Instructs any validation controls included on the page to validate their assigned information.

Validate(String)

Instructs the validation controls in the specified validation group to validate their assigned information.

VerifyRenderingInServerForm(Control)

Confirms that an HtmlForm control is rendered for the specified ASP.NET server control at run time.

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)

Evaluates an XPath data-binding expression.

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

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

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

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

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

Occurs when a user ends a transaction.

(Inherited from TemplateControl)
CommitTransaction

Occurs when a transaction completes.

(Inherited from TemplateControl)
DataBinding

Occurs when the server control binds to a data source.

(Inherited from Control)
Disposed

Occurs when a server control is released from memory, which is the last stage of the server control lifecycle when an ASP.NET page is requested.

(Inherited from Control)
Error

Occurs when an unhandled exception is thrown.

(Inherited from TemplateControl)
Init

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

(Inherited from Control)
InitComplete

Occurs when page initialization is complete.

Load

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

(Inherited from Control)
LoadComplete

Occurs at the end of the load stage of the page's life cycle.

PreInit

Occurs before page initialization.

PreLoad

Occurs before the page Load event.

PreRender

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

(Inherited from Control)
PreRenderComplete

Occurs before the page content is rendered.

SaveStateComplete

Occurs after the page has completed saving all view state and control state information for the page and controls on the page.

Unload

Occurs when the server control is unloaded from memory.

(Inherited from Control)

Explicit Interface Implementations

IControlBuilderAccessor.ControlBuilder

For a description of this member, see ControlBuilder.

(Inherited from Control)
IControlDesignerAccessor.GetDesignModeState()

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

(Inherited from Control)
IControlDesignerAccessor.SetDesignModeState(IDictionary)

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

(Inherited from Control)
IControlDesignerAccessor.SetOwnerControl(Control)

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

(Inherited from Control)
IControlDesignerAccessor.UserData

For a description of this member, see UserData.

(Inherited from Control)
IDataBindingsAccessor.DataBindings

For a description of this member, see DataBindings.

(Inherited from Control)
IDataBindingsAccessor.HasDataBindings

For a description of this member, see HasDataBindings.

(Inherited from Control)
IExpressionsAccessor.Expressions

For a description of this member, see Expressions.

(Inherited from Control)
IExpressionsAccessor.HasExpressions

For a description of this member, see HasExpressions.

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

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

(Inherited from TemplateControl)
IParserAccessor.AddParsedSubObject(Object)

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

(Inherited from Control)

Extension Methods

FindDataSourceControl(Control)

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

FindFieldTemplate(Control, String)

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

FindMetaTable(Control)

Returns the metatable object for the containing data control.

GetDefaultValues(INamingContainer)

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

GetMetaTable(INamingContainer)

Gets the table metadata for the specified data control.

SetMetaTable(INamingContainer, MetaTable)

Sets the table metadata for the specified data control.

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

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

SetMetaTable(INamingContainer, MetaTable, Object)

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

TryGetMetaTable(INamingContainer, MetaTable)

Determines whether table metadata is available.

EnableDynamicData(INamingContainer, Type)

Enables Dynamic Data behavior for the specified data control.

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

Enables Dynamic Data behavior for the specified data control.

EnableDynamicData(INamingContainer, Type, Object)

Enables Dynamic Data behavior for the specified data control.

Applies to

See also