Export (0) Print
Expand All

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 Value

Type: System.String
A description of the object's visual appearance to the user, or null if the object does not have a description.

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

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Show:
© 2014 Microsoft