AccessibleObject.DefaultAction Property

Definition

Namespace:

System.Windows.Forms

Assembly:

System.Windows.Forms.dll

Source:

AccessibleObject.cs

Gets a string that describes the default action of the object. Not all objects have a default action.

public:
 virtual property System::String ^ DefaultAction { System::String ^ get(); };

public virtual string? DefaultAction { get; }

member this.DefaultAction : string

Public Overridable ReadOnly Property DefaultAction As String

Property Value

String

A description of the default action for an object, or null if this object has no default action.

Exceptions

COMException

The default action for the control cannot be retrieved.

Remarks

The string describes the action that is performed on an object, not what the object does as a result. That is, a toolbar button that prints a document has a default action of "Press" rather than "Prints the current document." Do not confuse an object's default action with its value.

Notes to Inheritors

The default implementation returns the accessible object's default action if the object wraps a system control that has a default action; otherwise, it returns null. Only controls that perform actions should support this method. Not all objects have default actions, and some objects might have a default action that is related to its Value property, such as in the following examples: A selected check box has a default action of "Uncheck" and a value of "Checked." A cleared check box has a default action of "Check" and a value of "Unchecked." A button labeled "Print" has a default action of "Press," with no value. A static text control or an edit control that shows "Printer" has no default action, but would have a value of "Printer." An object's DefaultAction property should be a verb or a short verb phrase.

See also

• Bounds
• Description
• Help
• KeyboardShortcut
• Name
• Parent
• Role
• State
• Value