HelpString Property
Collapse the table of content
Expand the table of content

QueryAccessibilityHelpEventArgs.HelpString Property

Gets or sets the string defining what Help to get for the AccessibleObject.

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

public string HelpString { get; set; }
/** @property */
public String get_HelpString ()

/** @property */
public void set_HelpString (String value)

public function get HelpString () : String

public function set HelpString (value : String)

Not applicable.

Property Value

The Help to retrieve for the accessible object.

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.

// Overridden to return the custom AccessibleObject 
// for the entire chart.
protected override AccessibleObject CreateAccessibilityInstance() 
    return new ChartControlAccessibleObject(this);

// Overridden to return the custom AccessibleObject 
// for the entire chart.
protected AccessibleObject CreateAccessibilityInstance()
    return new ChartControlAccessibleObject(this);
} //CreateAccessibilityInstance

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

© 2016 Microsoft