This documentation is archived and is not being maintained.

ToolStripItem.AccessibleDescription Property

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

Gets or sets the description that will be reported to accessibility client applications.

Namespace: System.Windows.Forms
Assembly: System.Windows.Forms (in system.windows.forms.dll)

[LocalizableAttribute(true)] 
public string AccessibleDescription { get; set; }
/** @property */
public String get_AccessibleDescription ()

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

public function get AccessibleDescription () : String

public function set AccessibleDescription (value : String)

Property Value

The description of the control used by accessibility client applications. The default is a null reference (Nothing in Visual Basic).

An object's AccessibleDescription property provides a textual description about an object's visual appearance. The description is primarily used to provide greater context for low-vision or blind users, but can also be used for context searching or other applications.

The AccessibleDescription property is needed if the description is not obvious, or if it is not redundant based on the object's AccessibleName, AccessibleRole, State, and Value properties. For example, a button labeled OK would not need additional information, but a button that shows a picture of a cactus would. The AccessibleName and AccessibleRole and, perhaps, AccessibleObject.Help properties for the cactus button would describe its purpose, but the AccessibleDescription property would convey information that is less tangible, such as "A button that shows a picture of a cactus."

For more information about properties of accessible objects, see "Content of Descriptive Properties" in the "Active Accessibility" section of the MSDN Library, at http://msdn.microsoft.com/library.

For samples, see the AccessibleObject class.

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, 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.

.NET Framework

Supported in: 2.0
Show: