Expand Minimize

AutomationPeer.GetHelpTextCore method

Applies to Windows and Windows Phone

Provides the peer's behavior when a Microsoft UI Automation client calls GetHelpText or an equivalent UI Automation client API.

Syntax


protected virtual string GetHelpTextCore()

Parameters

This method has no parameters.

Return value

Type: System.String [.NET] | Platform::String [C++]

The help text.

Remarks

The "Core" methods are the standard implementations that perform the default action of an associated UI Automation client-callable method. You can override any of the "Core" methods to return alternative values in a custom automation peer. In this case, GetHelpTextCore is invoked any time that GetHelpText is called.

The base implementation returns null. Peers that represent items may defer the result to their container.

Specifying a control behavior for help text is uncommon. In most cases, apps that need it will establish help text information in the UI by applying the AutomationProperties.HelpText attached property to the UI definition XAML.

Requirements

Minimum supported client

Windows 8

Minimum supported server

Windows Server 2012

Minimum supported phone

Windows Phone 8.1 [Windows Runtime apps only]

Namespace

Windows.UI.Xaml.Automation.Peers
Windows::UI::Xaml::Automation::Peers [C++]

Metadata

Windows.winmd

See also

AutomationPeer
FrameworkElementAutomationPeer
AutomationProperties.HelpText
Custom automation peers
Accessibility for Windows Store apps using C#/VB/C++ and XAML

 

 

Show:
© 2014 Microsoft