Export (0) Print
Expand All

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)

'Declaration
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.

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.6, 4.5, 4, 3.5, 3.0, 2.0, 1.1

.NET Framework Client Profile

Supported in: 4, 3.5 SP1
Show:
© 2015 Microsoft