AccessibleObject.Description Property
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Gets a string that describes the visual appearance of the specified object. Not all objects have a description.
public:
virtual property System::String ^ Description { System::String ^ get(); };public virtual string Description { get; }public virtual string? Description { get; }member this.Description : stringPublic Overridable ReadOnly Property Description As StringProperty Value
A description of the object's visual appearance to the user, or null if the object does not have a description.
Exceptions
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 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".
