FrameworkElementAutomationPeer.GetHelpTextCore Method

Returns the string that describes the functionality of the FrameworkElement that is associated with this FrameworkElementAutomationPeer. This method is called by GetHelpText.

Namespace:  System.Windows.Automation.Peers
Assembly:  System.Windows (in System.Windows.dll)

Syntax

'Declaration
Protected Overrides Function GetHelpTextCore As String
protected override string GetHelpTextCore()

Return Value

Type: System.String
The help text, or String.Empty if there is no help text.

Remarks

The value is settable on control instances through the AutomationProperties.HelpText attached property.

Notes to Inheritors

The return value for this method in the FrameworkElementAutomationPeer implementation comes from the AutomationProperties.HelpText property store on the peer.

For accessibility purposes, HelpText is often used to communicate instructions to the user, beyond the simple descriptive label that is provided by the UI Automation Name and possibly by the localized control type name for example "Button". In some controls, the HelpText is used to communicate control state.

Version Information

Silverlight

Supported in: 5, 4, 3

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.