This documentation is archived and is not being maintained.

HotSpot.AccessKey Property

Gets or sets the access key that allows you to quickly navigate to the HotSpot region.

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

[LocalizableAttribute(true)] 
public virtual string AccessKey { get; set; }
/** @property */
public String get_AccessKey ()

/** @property */
public void set_AccessKey (String value)

public function get AccessKey () : String

public function set AccessKey (value : String)

Not applicable.

Property Value

The access key for quick navigation to the HotSpot region. The default value is Empty, which indicates that this property is not set.

Exception typeCondition

ArgumentOutOfRangeException

The specified access key is neither a null reference (Nothing in Visual Basic), an empty string (""), nor a single character string.

Use the AccessKey property to specify the keyboard shortcut for a HotSpot region. This allows you to navigate quickly to the region by pressing the ALT key and the key for the specified character on the keyboard. For example, setting the access key of a HotSpot region 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 a null reference (Nothing in Visual Basic), Empty, nor a single character string, an exception is thrown.

NoteNote:

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

The value of this property, when set, can be saved automatically to a resource file by using a designer tool. For more information, see LocalizableAttribute and ASP.NET Globalization and Localization.

TopicLocation
How to: Check Accessibility of Web Pages in Visual Web DeveloperBuilding ASP .NET Web Applications in Visual Studio

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

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0
Show: