WebControl::AccessKey Property

.NET Framework (current version)

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

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

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 null, Empty nor a single character string.

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 null, Empty, nor a single character string, an exception is thrown.

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

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.

C++

No code example is currently available or this language may not be supported.

Version Information

.NET Framework
Available since 1.1