AccessibleObject.GetHelpTopic(String) Método

Definição

Obtém um identificador para um identificador de tópico da Ajuda e o caminho para o arquivo de Ajuda associado a esse 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

No retorno, essa propriedade contém o caminho para o arquivo de Ajuda associado a esse objeto acessível.

Retornos

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

Exceções

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

Comentários

Para exibir a ajuda do AccessibleObject usando o sistema de Ajuda Windows, você pode passar o nome do arquivo e a ID do tópico para o método Help.ShowHelp apropriado de Help.

Notas aos Herdeiros

Nem todos os objetos precisam dar suporte a essa propriedade.

Aplica-se a

Confira também