This documentation is archived and is not being maintained.

AccessibleObject.Description Property

Gets a string that describes the visual appearance of the specified object. Not all objects have a description.

[Visual Basic]
Public Overridable ReadOnly Property Description As String
[C#]
public virtual string Description {get;}
[C++]
public: __property virtual String* get_Description();
[JScript]
public function get Description() : String;

Property Value

A description of the object's visual appearance to the user, or a null reference (Nothing in Visual Basic) if the object does not have a description.

Exceptions

Exception Type Condition
COMException The description for the control cannot be retrieved.

Remarks

This property describes the object's visual appearance to the user.

Notes to Inheritors:  The default implementation returns the accessible object's description if the object wraps a system control; otherwise, it returns a null reference (Nothing in Visual Basic). The description is typically used to provide greater context for low-vision or blind users. It can also be used for context searching or other applications. Servers need to support the Description property if the description is not obvious, or if it is redundant based on the object's Name, Role, State, and Value properties. For example, a button with "OK" does not need additional information, but a button that shows a picture of a cactus would. The Name, Role, and perhaps Help properties for the cactus button describe its purpose, but the Description property conveys information that is less tangible, like "A button that shows a picture of a cactus".

Requirements

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

See Also

AccessibleObject Class | AccessibleObject Members | System.Windows.Forms Namespace | Bounds | DefaultAction | Help | KeyboardShortcut | Name | Parent | Role | State | Value

Show: