AccessibleObject.GetHelpTopic(String) Método

  • Referência

Definição

Namespace:
System.Windows.Forms
Assembly:
System.Windows.Forms.dll

Obtém um identificador para um identificador de tópico da Ajuda e o caminho para o arquivo 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);
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 este objeto acessível.

Retornos

Int32

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

Exceções

COMException

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

Comentários

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

Notas aos Herdeiros

Nem todos os objetos precisam dar suporte a essa propriedade.

Aplica-se a

Confira também