QueryAccessibilityHelpEventArgs.HelpKeyword Property

Definition

Namespace:

System.Windows.Forms

Assembly:

System.Windows.Forms.dll

Gets or sets the Help keyword for the specified control.

public:
 property System::String ^ HelpKeyword { System::String ^ get(); void set(System::String ^ value); };

public string? HelpKeyword { get; set; }

member this.HelpKeyword : string with get, set

Public Property HelpKeyword As String

Property Value

String

The Help topic associated with the AccessibleObject that was queried.

Examples

The following code example demonstrates the use of this member. In the example, an event handler reports on the occurrence of the Control.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 Control, such as a Button or ComboBox. Then name the instance Control1 and ensure that the event handler is associated with the Control.QueryAccessibilityHelp event.

private void Control1_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" );
}

Private Sub Control1_QueryAccessibilityHelp(sender as Object, e as QueryAccessibilityHelpEventArgs) _ 
     Handles Control1.QueryAccessibilityHelp

    Dim messageBoxVB as New System.Text.StringBuilder()
    messageBoxVB.AppendFormat("{0} = {1}", "HelpNamespace", e.HelpNamespace)
    messageBoxVB.AppendLine()
    messageBoxVB.AppendFormat("{0} = {1}", "HelpString", e.HelpString)
    messageBoxVB.AppendLine()
    messageBoxVB.AppendFormat("{0} = {1}", "HelpKeyword", e.HelpKeyword)
    messageBoxVB.AppendLine()
    MessageBox.Show(messageBoxVB.ToString(),"QueryAccessibilityHelp Event")

End Sub

See also

• Help