Click here to Skip to main content
15,038,237 members
Articles / Web Development / ASP.NET
Posted 12 Jan 2004


30 bookmarked

ASP.NET Client Side Focus Helper

Rate me:
Please Sign up or sign in to vote.
3.89/5 (9 votes)
19 Jan 20043 min read
Helper class that generates and registers a client side script which sets focus to a control during the loading of the page.

Sample Image - ClientSideFocus.jpg


I've been working on trying to set the focus of client side controls today and thought I'd submit this as I think it could be useful. I hope I haven't missed a method that is already built into ASP.NET that already does this.

I've created a helper class that enables you to set the client side focus with a single call. I decided against creating a subclass of the Page class as I think the helper class approach is better and easier to implement on existing systems.

How it worked originally

All that is required is the ID of the form which the control is in and the ID of the control itself. There are a couple of overloaded functions that automatically find these IDs depending on what type of server control you pass as a parameter.

private void Page_Load(object sender, System.EventArgs e)
  if( !this.IsPostBack )
    this.ViewState["focus"] = "WebControl";

The JavaScript script is then generated and registered to the given Page object.

The script itself makes a copy of the document.body.onload function and replaces it with the focus setting function which in turn calls the original onload function, which means that you won't have to tinker with any existing onload scripts you may have within your pages.

// save original function
  original = document.body.onload;

 // override original function
 document.body.onload = document_onLoad;

 function document_onLoad()

  // call original function

 function original()
  // do nothing if original is null

How it works now

After being notified that the original code could potentially steal the focus of another window (which can be irritating), I switched from using the document.body.onload event to the document.body.onfocus event.

var called = false;

    orig_document_body_onfocus = document.body.onfocus;

document.body.onfocus = document_body_onfocus;

function setFocus()
    var control = document.getElementById("html");

function orig_document_body_onfocus(){}

function document_body_onfocus ()
    if( !called )
        called = true;


if( window.__smartNav && window.__smartNav.restoreFocus)
    orig_window__smartNav_restoreFocus = window.__smartNav.restoreFocus;
    window.__smartNav.restoreFocus = window__smartNav_restoreFocus;

function orig_window__smartNav_restoreFocus(){}

function window__smartNav_restoreFocus()

I’ve also tried to solve the problem with Smart Navigation by overriding the restoreFocus function from within SmartNav.js file but this seems to only work on my local machine at the moment. This may be due to a security issue or due to the loading time taken from remote hosts.

I removed the need for the ID of the HTML form, as with most cases within ASP.NET, the page will only use one form. This modification alone removes about half the content from the original code. I’ve included the original code if you still need to reference the form's ID as well as the control ID.

Known Issues

Currently, the helper class doesn’t function properly when Smart Navigation is enabled.

The demo

I've included a simple demo that switches focus between a WebControl, HtmlControl and a hard coded HTML input control.

I use the viewstate to keep track of which control has focus.

private void Button1_Click(object sender, System.EventArgs e)
  string focus = this.ViewState["focus"] as string;
  if( focus == null )
    focus = "WebControl";
    case "Html":
      this.ViewState["focus"] = "WebControl";
    case "HtmlControl":
      McGiv.Web.UI.ClientSideFocus.setFocus(this, "html");
      this.ViewState["focus"] = "Html";
    case "WebControl":
      this.ViewState["focus"] = "HtmlControl";

In order to get it to work, unzip the demo files into a virtual directory mapped to http://localhost/ClientSideFocus/.

I've also setup an online demo here.


Version History

  • Version 1.3: Wednesday 21 Jan 2003
    • Fixed null object JavaScript bug.
  • Version 1.2: Tuesday 20 Jan 2003
    • Moved the call to setFocus from the document.body.onload event to the document.body.onfocus event. This stops the focus being taken from another browser window that has the focus.
    • Discovered that the code only works with Smart Navigation on my local machine & not my remote host. Don't know if this is a security issue or a loading time issue.
  • Version 1.1: Wednesday 14 Jan 2003
    • Removed script from onload event. Allows it to work with Mozilla browsers too.
    • Used getElementById([control name]) instead of using [form name].[control name].
    • Removed need to search for form's ID - with ASP.NET, only 1 form is used normally removing the need to supply the form ID.
    • Overrides restoreFocus Smart Navigation function. Now works when smart navigation is enabled.
  • Version 1.0: Tuesday 13 Jan 2003
    • Will function if Smart Navigation is enabled on the WebForm. Only tested on IE 6.1.


This article has no explicit license attached to it but may contain usage terms in the article text or the download files themselves. If in doubt please contact the author via the discussion board below.

A list of licenses authors might use can be found here


About the Author

Web Developer
United Kingdom United Kingdom
I'm a 3rd year student at Uni studing Computing. I've been coding in VB for about 6 years, Java for about 3 and C# for about 2 years.

Comments and Discussions

GeneralGodsend Pin
Vodstok31-Mar-05 9:32
MemberVodstok31-Mar-05 9:32 
GeneralSetFocus Pin
kameliar23-Mar-05 2:17
Memberkameliar23-Mar-05 2:17 
GeneralRe: SetFocus Pin
McGiv23-Mar-05 2:24
MemberMcGiv23-Mar-05 2:24 
GeneralThanks Pin
iconsam10-Mar-05 8:55
Membericonsam10-Mar-05 8:55 
GeneralMinor Change... Pin
Member 143348012-Oct-04 3:40
MemberMember 143348012-Oct-04 3:40 
GeneralRe: Minor Change... Pin
McGiv12-Oct-04 3:46
MemberMcGiv12-Oct-04 3:46 
GeneralRegisterStartupScript Pin
JasonBSteele20-Aug-04 4:27
MemberJasonBSteele20-Aug-04 4:27 
GeneralRe: RegisterStartupScript Pin
McGiv20-Aug-04 8:36
MemberMcGiv20-Aug-04 8:36 
GeneralRe: RegisterStartupScript Pin
JasonBSteele21-Aug-04 0:22
MemberJasonBSteele21-Aug-04 0:22 
GeneralBug in Demo. Pin
Cypher21-Jan-04 4:37
MemberCypher21-Jan-04 4:37 
GeneralRe: Bug in Demo. Pin
McGiv21-Jan-04 5:24
MemberMcGiv21-Jan-04 5:24 
GeneralRe: FIXED - Bug in Demo. Pin
McGiv21-Jan-04 5:48
MemberMcGiv21-Jan-04 5:48 
GeneralUpdated Code Pin
McGiv20-Jan-04 14:25
MemberMcGiv20-Jan-04 14:25 
GeneralFocus is evil Pin
Stephane Rodriguez.13-Jan-04 6:15
MemberStephane Rodriguez.13-Jan-04 6:15 
GeneralRe: Focus is evil Pin
McGiv13-Jan-04 6:47
MemberMcGiv13-Jan-04 6:47 
GeneralRe: Focus is evil Pin
Anonymous20-Jan-04 0:36
MemberAnonymous20-Jan-04 0:36 
GeneralRe: Focus is evil Pin
Stephane Rodriguez.20-Jan-04 19:14
MemberStephane Rodriguez.20-Jan-04 19:14 
GeneralRe: Focus is evil Pin
Jörgen Sigvardsson13-Jan-04 8:03
MemberJörgen Sigvardsson13-Jan-04 8:03 
GeneralRe: Focus is evil Pin
PeterHarrie19-Jan-04 21:25
MemberPeterHarrie19-Jan-04 21:25 
GeneralRe: Focus is evil Pin
Stephane Rodriguez.19-Jan-04 21:43
MemberStephane Rodriguez.19-Jan-04 21:43 
GeneralRe: Focus is evil Pin
Anonymous20-Jan-04 10:45
MemberAnonymous20-Jan-04 10:45 
GeneralRe: Focus is evil Pin
Anonymous29-Aug-05 15:44
MemberAnonymous29-Aug-05 15:44 
GeneralRe: Focus is evil Pin
McGiv20-Jan-04 14:28
MemberMcGiv20-Jan-04 14:28 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Praise Praise    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.