Compartilhar via


Método IAssistance.SetDefaultContext (Office)

Define um tópico de ajuda como tópico padrão que será exibido quando o usuário abrir uma janela de ajuda.

Sintaxe

expressão. SetDefaultContext (HelpId)

Expressão Uma expressão que retorna um objeto IAssistance .

Parâmetros

Nome Obrigatório/Opcional Tipo de dados Descrição
HelpId Obrigatório String A ID do tópico de ajuda padrão.

Comentários

O tópico de ajuda especificado neste método não será exibido se o Office já tiver definido um tópico de ajuda padrão nesse escopo. Além disso, para algumas caixas de diálogo, independentemente de uma ID ser passada pelo método, o tópico de ajuda enviado com o Office será exibido quando o usuário pressionar a tecla F1 ou escolher o botão Ajuda .

Por exemplo, se o usuário estiver em uma caixa de diálogo e pressionar F1, um tópico de ajuda interno ou personalizado será exibido se for um tópico especificado pelo desenvolvedor. Se não houver ID padrão especificada, o tópico de ajuda padrão interno do Office será exibido. Da mesma forma, se o usuário estiver na caixa de diálogo Novo documento, por exemplo, o tópico de ajuda especificado do Office será exibido,independentemente de uma ID diferente ser passada ao método.

A propriedade Assistência retorna um objeto IAssistance. O objeto IAssistance expõe métodos que permitem que os desenvolvedores para exibir tópicos de Ajuda no Visualizador da Ajuda do Office ou para exibir os tópicos de Ajuda que acompanham o Office na janela da Ajuda do aplicativo host. Os desenvolvedores passam identificações da Ajuda específicos para o sistema de Ajuda ou passam consultas de pesquisa específica. Ajuda IDs precisa ser explicitamente adicionada ao arquivo de ajuda na ordem para a ID de ajuda retornar o tópico da Ajuda.

Exemplo

No exemplo a seguir, o tópico de ajuda associado à ID "60385" será definido como o padrão para o aplicativo.

Sub SetDefaultHelpTopic() 
 Application.Assistance.SetDefaultContext "60385" 
End Sub

Confira também

Suporte e comentários

Tem dúvidas ou quer enviar comentários sobre o VBA para Office ou sobre esta documentação? Confira Suporte e comentários sobre o VBA para Office a fim de obter orientação sobre as maneiras pelas quais você pode receber suporte e fornecer comentários.