This documentation is archived and is not being maintained.

AccessibleObject.Help Property

Gets a description of what the object does or how the object is used.

[Visual Basic]
Public Overridable ReadOnly Property Help As String
[C#]
public virtual string Help {get;}
[C++]
public: __property virtual String* get_Help();
[JScript]
public function get Help() : String;

Property Value

A String that contains the description of what the object does or how the object is used. Returns a null reference (Nothing in Visual Basic) if no help is defined.

Exceptions

Exception Type Condition
COMException The help string for the control cannot be retrieved.

Remarks

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.

Requirements

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

See Also

AccessibleObject Class | AccessibleObject Members | System.Windows.Forms Namespace | Bounds | DefaultAction | Description | KeyboardShortcut | Name | Parent | Role | State | Value

Show: