Page.SetFocus Method (String)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

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

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

Public Sub SetFocus (
	clientID As String
)

Parameters

clientID
Type: System.String

The ID of the control to set focus to.

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.

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.

System_CAPS_noteNote

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

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

System_CAPS_security 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.

<%@ 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>

.NET Framework
Available since 2.0
Return to top
Show: