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

SetFocus Method (Control)

Switch on low bandwidth view

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2005/.NET Framework 2.0

Other versions are also available for the following:

.NET Framework Class Library

Page.SetFocus Method (Control)

Note: This method is new in the .NET Framework version 2.0.

Sets the browser focus to the specified control.

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

Syntax

Visual Basic (Declaration)

Public Sub SetFocus ( _
    control As Control _
)

Visual Basic (Usage)

Dim instance As Page
Dim control As Control

instance.SetFocus(control)

public void SetFocus (
    Control control
)

C++

public:
void SetFocus (
    Control^ control
)

public void SetFocus (
    Control control
)

JScript

public function SetFocus (
    control : Control
)

Parameters

control: The control to receive focus.

Exceptions

Exception type	Condition
ArgumentNullException	control is a null reference (Nothing in Visual Basic).
InvalidOperationException	SetFocus is called when the control is not part of a Web Forms page. - or - SetFocus is called after the PreRender event.

Exception type

Condition

ArgumentNullException

control is a null reference (Nothing in Visual Basic).

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 specified control the active control on 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
The SetFocus method will work only on browsers supporting ECMAScript version 1.3 or later.

Topic	Location
How to: Set Focus on ASP.NET Web Server Controls	Building ASP .NET Web Applications
How to: Set Focus on ASP.NET Web Server Controls	Building ASP .NET Web Applications
How to: Set Focus on ASP.NET Web Server Controls	Building ASP .NET Web Applications in Visual Studio
How to: Set Focus on ASP.NET Web Server Controls	Building ASP .NET Web Applications in Visual Studio

Example

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

Visual Basic

<%@ page language="VB" %>

<script runat="server">
    Sub Page_Init(ByVal sender As Object, ByVal e As EventArgs)
        SetFocus(focusHere)
    End Sub
</script>

<html>
<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>

<%@ page language="C#" %>

<script runat="server">
    void Page_Init(object sender, EventArgs e)
    {
        SetFocus(focusHere);
    }
</script>

<html>
<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>

Platforms

Windows 98, Windows 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

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

Version Information

.NET Framework

Supported in: 2.0

Reference

Page Class
Page Members
System.Web.UI Namespace
MaintainScrollPositionOnPostBack