This topic has not yet been rated - Rate this topic

QueryAccessibilityHelpEventArgs Class

Provides data for the QueryAccessibilityHelp event.

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

Namespace:  System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)
[ComVisibleAttribute(true)]
public class QueryAccessibilityHelpEventArgs : EventArgs

The QueryAccessibilityHelpEventArgs type exposes the following members.

  Name Description
Public method QueryAccessibilityHelpEventArgs() Initializes a new instance of the QueryAccessibilityHelpEventArgs class.
Public method QueryAccessibilityHelpEventArgs(String, String, String) Initializes a new instance of the QueryAccessibilityHelpEventArgs class.
Top
  Name Description
Public property HelpKeyword Gets or sets the Help keyword for the specified control.
Public property HelpNamespace Gets or sets a value specifying the name of the Help file.
Public property HelpString Gets or sets the string defining what Help to get for the AccessibleObject.
Top
  Name Description
Public method Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Top

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.

Note Note

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";
}          


.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ