AccessibleObject.Description Property


The .NET API Reference documentation has a new home. Visit the .NET API Browser on to see the new experience.

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.

Exception Condition

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
Available since 1.1
Return to top