AccessibleObject.GetHelpTopic Method (String)

 

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 Overridable Function GetHelpTopic (
	<OutAttribute> ByRef fileName As String
) As Integer

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.

Exception Condition
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
Available since 1.1
Return to top
Show: