Version

GetDefaultHelpText Method

Returns a help text string associated with the automation element.
Syntax
'Declaration
 
Protected Overridable Function GetDefaultHelpText() As String
protected virtual string GetDefaultHelpText()

Return Value

A help text string associated with the automation element.
Remarks

The HelpText property is typically obtained from tooltip text associated with the element. The property can also be supported with placeholder text appearing in edit or list controls. For example, "Type text here for search" is a good candidate the HelpText property for an edit control that places the text prior to the user’s actual input. However, it is not adequate for the name property of the edit control.

When HelpText is supported, the string must match the application UI language or the operating system default UI language.

The HelpText property has a variant type of VT_BSTR; the default value is NULL.

Requirements

Target Platforms: Windows 10, Windows 8.1, Windows 8, Windows 7, Windows Server 2012, Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

See Also