Interface Help2

Artigo
05/17/2015

A interface que suporta Document Explorer.

Namespace: Microsoft.VisualStudio.VSHelp80
Assembly: Microsoft.VisualStudio.VSHelp80 (em Microsoft.VisualStudio.VSHelp80.dll)

Sintaxe

'Declaração
<GuidAttribute("78413D2D-0492-4A9B-AB25-730633679977")> _
Public Interface Help2 _
    Inherits Help

[GuidAttribute("78413D2D-0492-4A9B-AB25-730633679977")]
public interface Help2 : Help

[GuidAttribute(L"78413D2D-0492-4A9B-AB25-730633679977")]
public interface class Help2 : Help

[<GuidAttribute("78413D2D-0492-4A9B-AB25-730633679977")>]
type Help2 =  
    interface 
        interface Help 
    end

public interface Help2 extends Help

O tipo Help2 expõe os membros a seguir.

Propriedades

	Nome	Descrição
	Collection	Infraestrutura. Somente para uso interno da Microsoft.
	Filter	Obtém ou define o filtro da coleção.
	FilterQuery	Retorna a seqüência de consulta para o filtro de coleção de Ajuda atual.
	Help	Usado para compatibilidade com DTE2, quando usado como Windows.External, Help2 objeto retorna a mesmo.
	HelpOwner	Infraestrutura. Somente para uso interno da Microsoft.
	HxSession	Infraestrutura. Somente para uso interno da Microsoft.

Superior

Métodos

	Nome	Descrição
	AskAQuestion	Exibe uma URL com base no sinalizador fornecido.
	CanShowFilterUI	Método substituído.
	CanSyncContents	Determina se um URL pode ser sincronizado com ou não.
	Close	Fecha o Explorer do documento e todas as suas páginas.
	Contents	Seleciona o conteúdo janela de navegação e abre-se ela estiver fechada.
	DisplayTopicFrom_OLD_Help	Método substituído.Use DisplayTopicFromF1Keyword em vez disso.
	DisplayTopicFromF1Keyword	Exibe a Ajuda de F1 e nas caixas de diálogo.
	DisplayTopicFromId	Preterido.Use DisplayTopicFromF1Keyword em vez disso.
	DisplayTopicFromKeyword	Executa uma pesquisa usando o índice de palavra-chave K.
	DisplayTopicFromURL	Exibe um tópico da Ajuda especificado pelo URL no Explorer do documento.
	DisplayTopicFromURLEx	Infraestrutura. Somente para uso interno da Microsoft.
	DisplayTopicFromURLEx2	Exibe um tópico da Ajuda no Explorer do documento que se baseia Ajuda exibe sinalizadores.
	Favorites	Exibe a janela da ferramenta de Favoritos.
	FilterUI	Método substituído.
	GetNextTopic	Uma URL especificada retorna o URL de avançar no sumário.
	GetObject	Infraestrutura. Somente para uso interno da Microsoft.
	GetPrevTopic	Uma URL especificada retorna o URL anterior no sumário.
	HowDoI	Mostra a How Do I janela.
	Index	Seleciona o índice janela.
	IndexResults	Seleciona o Índice de resultados janela.
	InitializeSettingsToken	Infraestrutura. Somente para uso interno da Microsoft.
	Search	Seleciona o pesquisa caixa de diálogo.
	SearchEx	Seleciona o pesquisa janela e, opcionalmente, preenche o pesquisa caixa de diálogo caixa com um termo ou executa uma pesquisa por um termo específico.
	SearchResults	Seleciona o Os resultados da pesquisa janela.
	SetCollection	Infraestrutura. Somente para uso interno da Microsoft.
	SyncContents	Sincroniza o sumário para a URL fornecida.
	SyncIndex	Aparência até o tópico especificado pela palavra-chave K, mas ele não exibe o tópico no Explorer do documento, a menos que especificado.

Superior

Comentários

Help2suporta How Do I, pesquisar e Favoritos. Ele é o ponto de entrada principal para acessar o documento Explorer (Dexplorer.exe).

Como obter o Help2 objeto depende do aplicativo.

No não-VSPackages:

O Help2 objeto é um filho do DTE em sua hierarquia de objeto e podem ser acessados usando a ligação tardia DTE.Help propriedade. Para acesso Help2 em um aplicativo que não seja um add-in ou uma macro, você deve obter uma instância de DTE, que é ilustrado 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ê poderá obter o Help2 de objeto diretamente:

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

Em um VSPackage:

Você pode obter o Help2 de objeto por meio de SVsHelp service:

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