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.

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

public virtual string Description { get; }
/** @property */
public String get_Description ()

public function get Description () : String

Not applicable.

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.

Exception typeCondition

COMException

The description for the control cannot be retrieved.

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".

Windows 98, Windows Server 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 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, 1.1, 1.0
Show: