AccessibleObject.GetHelpTopic(String) Method

Definition

获取帮助主题标识符及与该辅助性对象相关的帮助文件的路径。Gets an identifier for a Help topic identifier and the path to the Help file associated with this accessible object.

public:
 virtual int GetHelpTopic([Runtime::InteropServices::Out] System::String ^ % fileName);
public virtual int GetHelpTopic (out string fileName);
abstract member GetHelpTopic : string -> int
override this.GetHelpTopic : string -> int
Public Overridable Function GetHelpTopic (ByRef fileName As String) As Integer

Parameters

fileName
String

返回时,该属性包含与辅助性对象关联的帮助文件的路径。On return, this property contains the path to the Help file associated with this accessible object.

Returns

Int32

帮助主题的标识符,或者,如果没有帮助主题,则为 -1。An identifier for a Help topic, or -1 if there is no Help topic. 返回时,fileName 参数包含与该辅助性对象相关的帮助文件的路径。On return, the fileName parameter contains the path to the Help file associated with this accessible object.

Exceptions

无法检索控件的帮助主题。The Help topic for the control cannot be retrieved.

Remarks

若要使用 Windows 帮助系统显示 AccessibleObject 的帮助,可以将文件名和主题 ID 传递到 Help的适当 Help.ShowHelp 方法。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.

Applies to

See also