This documentation is archived and is not being maintained.

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
)
public int GetHelpTopic (
	/** @attribute OutAttribute() */ /** @ref */ String fileName
)
Not applicable.

Parameters

fileName

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

Return Value

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 typeCondition

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.

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
Show: