This documentation is archived and is not being maintained.

ToolStripItem.QueryAccessibilityHelp Event

Occurs when an accessibility client application invokes help for the ToolStripItem.

Namespace:  System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)

public event QueryAccessibilityHelpEventHandler QueryAccessibilityHelp

You should use the HelpProvider class to allow users to invoke help on your accessible object by pressing the F1 key. Using the HelpProvider provides you with complete information in the QueryAccessibilityHelpEventArgs object.

For more information about handling events, see Consuming Events.

The following code example demonstrates the use of this member. In the example, an event handler reports on the occurrence of the QueryAccessibilityHelp event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing MessageBox.Show with Console.WriteLine or appending the message to a multiline TextBox.

To run the example code, paste it into a project that contains an instance of a type that inherits from ToolStripItem, such as a ToolStripButton or ToolStripMenuItem. Then name the instance ToolStripItem1 and ensure that the event handler is associated with the QueryAccessibilityHelp event.


private void ToolStripItem1_QueryAccessibilityHelp(Object sender, QueryAccessibilityHelpEventArgs e) {

System.Text.StringBuilder messageBoxCS = new System.Text.StringBuilder();
messageBoxCS.AppendFormat("{0} = {1}", "HelpNamespace", e.HelpNamespace );
messageBoxCS.AppendLine();
messageBoxCS.AppendFormat("{0} = {1}", "HelpString", e.HelpString );
messageBoxCS.AppendLine();
messageBoxCS.AppendFormat("{0} = {1}", "HelpKeyword", e.HelpKeyword );
messageBoxCS.AppendLine();
MessageBox.Show(messageBoxCS.ToString(), "QueryAccessibilityHelp Event" );
}


.NET Framework

Supported in: 4, 3.5, 3.0, 2.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.
Show: