Page.SetFocus Method (String) (System.Web.UI)

Switch View :
Classic
Lightweight
ScriptFree
.NET Framework Class Library
Page.SetFocus Method (String)

[This documentation is for preview only, and is subject to change in later releases. Blank topics are included as placeholders.]

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

Namespace:  System.Web.UI
Assembly:  System.Web (in System.Web.dll)
Syntax
Visual Basic
Public Sub SetFocus ( _
	clientID As String _
)
C#
public void SetFocus(
	string clientID
)
Visual C++
public:
void SetFocus(
	String^ clientID
)
F#
member SetFocus : 
        clientID:string -> unit

Parameters

clientID
Type: System.String

The ID of the control to set focus to.

Exceptions
Exception Condition
ArgumentNullException

clientID is null.
InvalidOperationException

SetFocus is called when the control is not part of a Web Forms page.

- or -

SetFocus is called after the PreRender event.
Remarks

Use the SetFocus method to make the control with the specified ID string the active control in the Web page displayed by the browser. The SetFocus method must be called before the page is prepared for rendering to the client in the PreRender event.

Note Note

The SetFocus method will work only on browsers supporting ECMAScript version 1.3 or later.
Examples

The following code example sets the focus to the second text box on a Web page.

Security note Security Note

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

<%@ 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">
    Sub Page_Init(ByVal sender As Object, ByVal e As EventArgs)
        SetFocus(focusHere.ClientID)
    End Sub
</script>

<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
    <title>Untitled Page</title>
</head>
<body>
    <form id="form1" runat="server">
        <asp:textbox id="default" runat="server" /><br />
        <asp:textbox id="focusHere" runat="server" />
    </form>
</body>
</html>
C#

<%@ 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">
    void Page_Init(object sender, EventArgs e)
    {
        SetFocus(focusHere.ClientID);
    }
</script>

<html xmlns="http://www.w3.org/1999/xhtml" >
<head id="Head1" runat="server">
    <title>Untitled Page</title>
</head>
<body>
    <form id="form1" runat="server">
        <asp:textbox id="default" runat="server" /><br />
        <asp:textbox id="focusHere" runat="server" />
    </form>
</body>
</html>
Version Information

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0, 2.0
Platforms

Windows 8 Consumer Preview, Windows Server 8 Beta, Windows 7, Windows Server 2008 SP2, Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

See Also

Reference

Page Class
SetFocus Overload
System.Web.UI Namespace