AccessibleObject.GetHelpTopic(String) Método

Definição

Obtém um identificador para um identificador de tópico de Ajuda e o caminho para o ficheiro de Ajuda associado a este objeto acessível.

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

Ao devolver, esta propriedade contém o caminho para o ficheiro de Ajuda associado a este objeto acessível.

Devoluções

Um identificador para um tópico de Ajuda, ou -1 se não houver um tópico de Ajuda. No retorno, o fileName parâmetro contém o caminho para o ficheiro de Ajuda associado a este objeto acessível.

Exceções

O tópico Ajuda para o controlo não pode ser recuperado.

Observações

Para mostrar ajuda para o AccessibleObject usando o sistema de Ajuda Windows, pode passar o nome do ficheiro e o ID do tópico ao método apropriado Help.ShowHelp de Help.

Notas para Herdeiros

Nem todos os objetos precisam de suportar esta propriedade.

Aplica-se a

Ver também