AccessibleObject.Help Property

Reference

Definition

Namespace:: System.Windows.Forms

Assembly:: System.Windows.Forms.dll

Source:: AccessibleObject.cs

Source:: AccessibleObject.cs

Source:: AccessibleObject.cs

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 description of what the object does or how the object is used.

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

public virtual string Help { get; }

public virtual string? Help { get; }

member this.Help : string

Public Overridable ReadOnly Property Help As String

Property Value

String

A String that contains the description of what the object does or how the object is used. Returns null if no help is defined.

Exceptions

COMException

The help string for the control cannot be retrieved.

Notes to Inheritors

Not all objects need to support this property. Typically, this property contains ToolTip style information that is used either to describe what the object does or how to use it. For example, the Help property for a toolbar button that shows a printer might be "Prints the current document." The text for the Help property does not have to be unique within the user interface. Servers do not need to support the Help property if other properties provide sufficient information about the object's purpose and what actions the object might perform.

Applies to

Jaa