Help2 Interface

Definição

A interface que dá suporte ao Gerenciador de documentos.

public interface class Help2 : Microsoft::VisualStudio::VSHelp::Help
public interface class Help2 : Microsoft::VisualStudio::VSHelp::Help
__interface Help2 : Microsoft::VisualStudio::VSHelp::Help
[System.Runtime.InteropServices.Guid("78413D2D-0492-4A9B-AB25-730633679977")]
[System.Runtime.InteropServices.TypeLibType(4160)]
public interface Help2 : Microsoft.VisualStudio.VSHelp.Help
[<System.Runtime.InteropServices.Guid("78413D2D-0492-4A9B-AB25-730633679977")>]
[<System.Runtime.InteropServices.TypeLibType(4160)>]
type Help2 = interface
    interface Help
Public Interface Help2
Implements Help
Atributos
Implementações

Comentários

Help2 dá suporte a como fazer, Pesquisar e favoritos. É o principal ponto de entrada para acessar o Gerenciador de documentos (Dexplorer.exe).

A forma como você obtém o Help2 objeto depende do aplicativo.

Em não VSPackages:

  • O Help2 objeto é um filho de DTE em sua hierarquia de objetos e pode ser acessado usando a propriedade de associação tardia DTE.Help . Para acessar Help2 o em um aplicativo que não seja um suplemento ou uma macro, você deve obter uma instância do DTE , que é ilustrada pelo exemplo a seguir:

    EnvDTE.DTE dte;  
    dte = (EnvDTE.DTE)System.Runtime.InteropServices.Marshal.GetActiveObject("VisualStudio.DTE.8.0");  
    Object helpobj  = dte.Help;  
    
  • Em um suplemento, você pode obter o Help2 objeto diretamente:

    Microsoft.VisualStudio.VSHelp80.Help2 help2 =   
    (Microsoft.VisualStudio.VSHelp80.Help2)dte.GetObject("Help2");  
    

Em um VSPackage:

  • Você Obtém o Help2 objeto por meio do SVsHelp serviço:

    Microsoft.VisualStudio.VSHelp80.Help2 help2;  
    // Obtain the Help2 object from SVsHelp service.  
    help2 =   
    (Microsoft.VisualStudio.VSHelp80.Help2)  
    this.GetService(typeof(Microsoft.VisualStudio.VSHelp.SVsHelp));  
    

Propriedades

Collection

Somente para uso interno da Microsoft.

Filter

Obtém ou define o filtro de coleção.

FilterQuery

Retorna a cadeia de caracteres de consulta para o filtro atual da coleção de ajuda.

Help

Usado para compatibilidade com DTE2 , quando usado como Windows. external, o objeto Help2 retorna a si mesmo.

HelpOwner

Somente para uso interno da Microsoft.

HxSession

Somente para uso interno da Microsoft.

Métodos

AskAQuestion(UInt32)

Exibe uma URL com base no sinalizador fornecido.

CanShowFilterUI()

Método preterido.

CanSyncContents(String)

Determina se uma URL pode ser sincronizada ou não.

Close()

Fecha o Gerenciador de documentos e todas as suas páginas.

Contents()

Seleciona a janela de navegação conteúdo e abre-a se ela estiver fechada.

DisplayTopicFrom_OLD_Help(String, UInt32)

Método preterido. Use DisplayTopicFromF1Keyword(String) em vez disso.

DisplayTopicFromF1Keyword(String)

Exibe a ajuda para as caixas de diálogo F1 e de.

DisplayTopicFromId(String, UInt32)

Preterido. Use DisplayTopicFromF1Keyword(String) em vez disso.

DisplayTopicFromKeyword(String)

Executa uma pesquisa usando o índice de palavra-chave K-Keyword.

DisplayTopicFromURL(String)

Exibe um tópico de ajuda especificado pela URL no Gerenciador de documentos.

DisplayTopicFromURLEx(String, IVsHelpTopicShowEvents)

Somente para uso interno da Microsoft.

DisplayTopicFromURLEx2(String, UInt32, String)

Exibe um tópico da ajuda no Gerenciador de documentos com base nos sinalizadores de exibição da ajuda.

Favorites()

Exibe a janela de ferramentas de favoritos.

FilterUI()

Método preterido.

GetNextTopic(String)

Uma URL fornecida retorna a próxima URL no sumário.

GetObject(String, String)

Somente para uso interno da Microsoft.

GetPrevTopic(String)

Uma URL fornecida retorna a URL anterior no sumário.

HowDoI()

Mostra a janela como faço.

Index()

Seleciona a janela de índice .

IndexResults()

Seleciona a janela resultados do índice .

InitializeSettingsToken(String)

Somente para uso interno da Microsoft.

Search()

Seleciona a caixa de diálogo Pesquisar .

SearchEx(String, String, UInt32)

Seleciona a janela Pesquisar e, opcionalmente, preenche a caixa de diálogo Pesquisar com um termo ou executa uma pesquisa para um termo específico.

SearchResults()

Seleciona a janela resultados da pesquisa .

SetCollection(String, String)

Somente para uso interno da Microsoft.

SyncContents(String)

Sincroniza o Sumário para a URL fornecida.

SyncIndex(String, Int32)

Pesquisa o tópico especificado pela palavra-chave K-, mas não exibe o tópico no Gerenciador de documentos, a menos que especificado.

Aplica-se a