DataGridColumnHeaderAutomationPeer.GetHelpTextCore Method

Microsoft Silverlight will reach end of support after October 2021. Learn more.

Returns a string that describes the functionality of the owner control.

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

Syntax

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

Return Value

Type: System.String
A localized human-readable string value that indicates funtionality of the control, specifically its sorting mode if any.

Remarks

This implementation overloads the usual generalized meaning of the "HelpText" concept in order to report information about the current grid column sorting mode. Specifically, the implementation returns a localized human-readable resource string that indicates whether sorting is active, and whether sorted by ascending or descending value. The sorting mode is typically also indicated to users through the use of icons in the default templates. The sorting mode is also exposed as HelpText by the default peer implementation in order to address accessibility scenarios.

If the owner is not sortable, this implementation calls base.

Version Information

Silverlight

Supported in: 5, 4, 3

Platforms

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