AccessibleObject.GetHelpTopic Method

Gets an identifier for a Help topic identifier and the path to the Help file associated with this accessible object.

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

public virtual int GetHelpTopic(
	out string fileName
)

Parameters

fileName
Type: System.String

On return, this property contains the path to the Help file associated with this accessible object.

Return Value

Type: System.Int32
An identifier for a Help topic, or -1 if there is no Help topic. On return, the fileName parameter contains the path to the Help file associated with this accessible object.

ExceptionCondition
COMException

The Help topic for the control cannot be retrieved.

To display help for the AccessibleObject using the Windows Help system, you can pass the file name and topic ID to the appropriate Help.ShowHelp method of Help.

Notes to Inheritors

Not all objects need to support this property.

.NET Framework

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

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft