WebControl.AccessKey Property (System.Web.UI.WebControls)

AccessKey Property

.NET Framework Class Library

WebControl..::.AccessKey Property

Gets or sets the access key that allows you to quickly navigate to the Web server control.

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

Syntax

Visual Basic (Declaration)

Public Overridable Property AccessKey As String

Visual Basic (Usage)

Dim instance As WebControl
Dim value As String

value = instance.AccessKey

instance.AccessKey = value

public virtual string AccessKey { get; set; }

Visual C++

public:
virtual property String^ AccessKey {
    String^ get ();
    void set (String^ value);
}

JScript

public function get AccessKey () : String
public function set AccessKey (value : String)

ASP.NET

<asp:WebControl AccessKey="String" />

Property Value

Type: System..::.String
The access key for quick navigation to the Web server control. The default value is Empty, which indicates that this property is not set.

Exceptions

Exception	Condition
ArgumentOutOfRangeException	The specified access key is neither nullNothingnullptra null reference (Nothing in Visual Basic), Empty nor a single character string.

Remarks

Use the AccessKey property to specify the keyboard shortcut for the Web server control. This allows you to navigate quickly to the control by pressing the ALT key and the key for the specified character on the keyboard. For example, setting the access key of a control to the string "D" indicates that the user can navigate to the control by pressing ALT+D.

Only a single character string is allowed for the AccessKey property. If you attempt to set this property to a value that is neither nullNothingnullptra null reference (Nothing in Visual Basic), Empty, nor a single character string, an exception is thrown.

Note:
This property is supported only in Internet Explorer 4.0 and later.

Topic	Location
How to: Add Button Web Server Controls to a Web Forms Page	Building ASP .NET Web Applications in Visual Studio
How to: Add Button Web Server Controls to a Web Forms Page	Building ASP .NET Web Applications in Visual Studio
How to: Add Button Web Server Controls to a Web Forms Page	Building ASP .NET Web Applications
How to: Add Button Web Server Controls to a Web Forms Page	Building ASP .NET Web Applications
How to: Add Button Web Server Controls to a Web Forms Page (Visual Studio)	Building ASP .NET Web Applications in Visual Studio
How to: Check Accessibility of Web Pages in Visual Web Developer	Building ASP .NET Web Applications in Visual Studio
How to: Check Accessibility of Web Pages in Visual Web Developer	Building ASP .NET Web Applications in Visual Studio
How to: Check Accessibility of Web Pages in Visual Web Developer	Building ASP .NET Web Applications in Visual Studio

Examples

The following example illustrates how to set and use the AccessKey property of a TextBox control.

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" AutoEventWireup="True" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html  >
 <head>
    <title>AccessKey Property of a Web Control</title>
</head>
 <body>

   <h3>AccessKey Property of a Web Control</h3>

 <form id="form1" runat="server">

   <asp:TextBox id="TextBox1" 
     AccessKey="Y" 
     Text="Press Alt-Y to get focus here" 
     Columns="45"
     runat="server"/>

   <br />

   <asp:TextBox id="TextBox2" 
     AccessKey="Z" 
     Text="Press Alt-Z to get focus here" 
     Columns="45"
     runat="server"/>

 </form>

 </body>
 </html>

<%@ Page Language="C#" AutoEventWireup="True" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html  >
 <head>
    <title>AccessKey Property of a Web Control</title>
</head>
 <body>

   <h3>AccessKey Property of a Web Control</h3>

 <form id="form1" runat="server">

   <asp:TextBox id="TextBox1" 
     AccessKey="Y" 
     Text="Press Alt-Y to get focus here" 
     Columns="45"
     runat="server"/>

   <br />

   <asp:TextBox id="TextBox2" 
     AccessKey="Z" 
     Text="Press Alt-Z to get focus here" 
     Columns="45"
     runat="server"/>

 </form>

 </body>
 </html>

JScript

<%@ Page Language="JScript" AutoEventWireup="True" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html  >
 <head>
    <title>AccessKey Property of a Web Control</title>
</head>
 <body>

   <h3>AccessKey Property of a Web Control</h3>

 <form id="form1" runat="server">

   <asp:TextBox id="TextBox1" 
     AccessKey="Y" 
     Text="Press Alt-Y to get focus here" 
     Columns="45"
     runat="server"/>

   <br />

   <asp:TextBox id="TextBox2" 
     AccessKey="Z" 
     Text="Press Alt-Z to get focus here" 
     Columns="45"
     runat="server"/>

 </form>

 </body>
 </html>

Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

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

Version Information

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0

Reference

WebControl Class

WebControl Members

System.Web.UI.WebControls Namespace

Other Resources

ASP.NET Web Server Controls and Browser Capabilities

Web Server Control Syntax

Developing Custom ASP.NET Server Controls