AccessibleObject.GetHelpTopic(String) Método

Definición

Espacio de nombres:
System.Windows.Forms
Ensamblado:
System.Windows.Forms.dll

Obtiene un identificador de un tema de ayuda y la ruta de acceso al archivo de ayuda asociado a este objeto accesible.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

Parámetros

fileName
String

Al devolverse, esta propiedad contiene la ruta de acceso al archivo de ayuda asociado a este objeto accesible.On return, this property contains the path to the Help file associated with this accessible object.

Devoluciones

Int32

Identificador de un tema de ayuda o -1 si no hay tema de ayuda.An identifier for a Help topic, or -1 if there is no Help topic. Al devolverse, el parámetro fileName contiene la ruta de acceso al archivo de ayuda asociado a este objeto accesible.On return, the fileName parameter contains the path to the Help file associated with this accessible object.

Excepciones

COMException

No se puede recuperar el tema de ayuda para el control.The Help topic for the control cannot be retrieved.

Comentarios

Para mostrar la ayuda del AccessibleObject con el sistema de ayuda de Windows, puede pasar el nombre de archivo y el identificador del tema al método Help.ShowHelp adecuado de Help.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.

Notas a los desarrolladores de herederos

No todos los objetos deben admitir esta propiedad.Not all objects need to support this property.

Se aplica a

Consulte también: