Export (0) Print
Expand All

QueryAccessibilityHelpEventArgs Class

Provides data for the QueryAccessibilityHelp event.

Namespace: System.Windows.Forms
Assembly: System.Windows.Forms (in system.windows.forms.dll)

[ComVisibleAttribute(true)] 
public class QueryAccessibilityHelpEventArgs : EventArgs
/** @attribute ComVisibleAttribute(true) */ 
public class QueryAccessibilityHelpEventArgs extends EventArgs
ComVisibleAttribute(true) 
public class QueryAccessibilityHelpEventArgs extends EventArgs
Not applicable.

The Control class exposes a public QueryAccessibilityHelp event. You can use the properties of the QueryAccessibilityHelpEventArgs class to return custom help for a particular control to an accessible client, such as a screen reader. When you handle the QueryAccessibilityHelp event, you must set the values of the HelpNamespace, HelpKeyword, and HelpString properties to appropriate values.

NoteNote:

The HelpKeyword property should be a string representation of a numeric Help topic ID.

The following code example demonstrates the creation of an accessibility-aware chart control, using the AccessibleObject and Control.ControlAccessibleObject classes to expose accessible information. The control plots two curves along with a legend. The ChartControlAccessibleObject class, which derives from ControlAccessibleObject, is used in the CreateAccessibilityInstance method to provide custom accessible information for the chart control. Because the chart legend is not an actual Control-based control, but instead is drawn by the chart control, it does not any built-in accessible information. Because of this, the ChartControlAccessibleObject class overrides the GetChild method to return the CurveLegendAccessibleObject that represents accessible information for each part of the legend. When an accessible-aware application uses this control, the control can provide the necessary accessible information.

This example demonstrates using the QueryAccessibilityHelpEventArgs class with the QueryAccessibilityHelp event. See the AccessibleObject class overview for the complete code example.

// Handles the QueryAccessibilityHelp event.
private void ChartControl_QueryAccessibilityHelp(object sender, 
                            System.Windows.Forms.QueryAccessibilityHelpEventArgs e)
{            
    e.HelpString = "Displays chart data";
}          

// Handles the QueryAccessibilityHelp event.
private void ChartControl_QueryAccessibilityHelp(Object sender, 
    System.Windows.Forms.QueryAccessibilityHelpEventArgs e)
{
    e.set_HelpString("Displays chart data");
} //ChartControl_QueryAccessibilityHelp

System.Object
   System.EventArgs
    System.Windows.Forms.QueryAccessibilityHelpEventArgs

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Windows 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0, 1.1, 1.0

Community Additions

ADD
Show:
© 2014 Microsoft