Share via

Demonstra Passo a passo: Criar sua primeira personalização em nível de documento para o Word

  • Artigo

Este passo a passo introdutório mostra como criar uma personalização em nível de documento para o Microsoft Office Word. Os recursos criados nesse tipo de solução estão disponíveis somente quando um documento específico é aberto. Você não pode usar uma personalização em nível de documento para fazer alterações em todo o aplicativo, por exemplo, exibindo uma nova guia da Faixa de Opções quando qualquer documento estiver aberto.

Aplica-se a: As informações neste tópico se aplicam a projetos de nível de documento para o Word. Para obter mais informações, consulte Recursos disponíveis por aplicativo e tipo de projeto do Office.

Este passo a passo ilustra as seguintes tarefas:

  • Criando um projeto de documento do Word.

  • Adicionando texto ao documento que está hospedado no designer do Visual Studio.

  • Escrever código que usa o modelo de objeto do Word para adicionar texto ao documento personalizado quando ele é aberto.

  • Construindo e executando o projeto para testá-lo.

  • Limpando o projeto para remover arquivos de compilação desnecessários e configurações de segurança do computador de desenvolvimento.

    Observação

    Seu computador pode mostrar diferentes nomes ou locais para alguns dos elementos de interface do usuário do Visual Studio nas instruções a seguir. A edição do Visual Studio que você possui e as configurações que você usa determinam esses elementos. Para obter mais informações, confira Personalizar o IDE.

Pré-requisitos

Você precisará dos seguintes componentes para concluir este passo a passo:

Criar o projeto

Para criar um novo projeto de documento do Word no Visual Studio

  1. Inicie o Visual Studio.

  2. No menu Arquivo , aponte para Novoe clique em Projeto.

  3. Na caixa de diálogo Criar um novo projeto, selecione o projeto Documento VSTO do Word.

    Observação

    Você também pode pesquisar modelos digitando o nome do produto do Office na caixa de texto Pesquisar na parte superior da caixa de diálogo Criar um Novo Projeto . Por exemplo, digitar Excel mostrará todos os modelos de projeto para o Excel . Você também pode filtrar a lista de modelos para mostrar apenas os modelos do Office selecionando Office na caixa suspensa Tipo de projeto. Para obter mais informações, consulte Criar um novo projeto no Visual Studio.

  4. Clique em Avançar.

  5. Digite FirstWorkbookCustomization na caixa Nome na caixa de diálogo Configurar seu novo projeto e clique em Criar.

  6. Selecione Criar um novo documento no Assistente do Visual Studio Tools for Office Project e clique em OK.

    • O Visual Studio cria o projeto FirstDocumentCustomization e adiciona o documento FirstDocumentCustomization e o arquivo de código ThisDocument ao projeto. O documento FirstDocumentCustomization é aberto automaticamente no designer.

Fechar e reabrir o documento no designer

Se você fechar deliberadamente ou acidentalmente o documento no designer enquanto estiver desenvolvendo seu projeto, poderá reabri-lo.

Para fechar e reabrir o documento no designer

  1. Feche o documento clicando no botão Fechar (X) da janela do designer.

  2. No Gerenciador de Soluções, clique com o botão direito do mouse no arquivo de código ThisDocument e clique em Exibir Designer.

    - ou -

    No Gerenciador de Soluções, clique duas vezes no arquivo de código ThisDocument .

Adicionar texto ao documento no designer

Você pode criar a interface do usuário (UI) de sua personalização modificando o documento que está aberto no designer. Por exemplo, você pode adicionar texto, tabelas ou controles do Word. Para obter mais informações sobre como usar o designer, consulte Projetos do Office no ambiente do Visual Studio.

Para adicionar texto ao documento usando o designer

  1. No documento aberto no designer, digite o seguinte texto.

    Este texto foi adicionado usando o designer.

Adicionar texto ao documento programaticamente

Em seguida, adicione código ao arquivo de código ThisDocument. O novo código usa o modelo de objeto do Word para adicionar um segundo parágrafo de texto ao documento. Por padrão, o arquivo de código ThisDocument contém o seguinte código gerado:

  • Uma definição parcial da ThisDocument classe, que representa o modelo de programação do documento e fornece acesso ao modelo de objeto do Word. Para obter mais informações, consulte Visão geral do item de host do documento e do modelo de objeto do Word. O restante da classe é definido em um arquivo de ThisDocument código oculto que você não deve modificar.

  • Os ThisDocument_Startup manipuladores de eventos e ThisDocument_Shutdown . Esses manipuladores de eventos são chamados quando o documento é aberto e fechado. Use esses manipuladores de eventos para inicializar sua personalização quando o documento é aberto e para limpar os recursos usados pela personalização quando o documento é fechado. Para obter mais informações, consulte Eventos em projetos do Office.

Para adicionar um segundo parágrafo de texto ao documento usando código

  1. No Gerenciador de Soluções, clique com o botão direito do mouse em ThisDocument e clique em Exibir Código.

    O arquivo de código é aberto no Visual Studio.

  2. Substitua o ThisDocument_Startup manipulador de eventos pelo código a seguir. Quando o documento é aberto, esse código adiciona um segundo parágrafo de texto ao documento.

    private void ThisDocument_Startup(object sender, System.EventArgs e)
{
    this.Paragraphs[1].Range.InsertParagraphAfter();
    this.Paragraphs[2].Range.Text = "This text was added by using code.";
}

    Observação

    Esse código usa o valor de índice 1 para acessar o primeiro parágrafo da Paragraphs propriedade. Embora o Visual Basic e o Visual C# usem matrizes baseadas em 0, os limites inferiores da matriz da maioria das coleções no modelo de objeto do Word é 1. Para obter mais informações, consulte Escrever código em soluções do Office.

Testar o projeto

Para testar o documento

  1. Pressione F5 para compilar e executar seu projeto.

    Quando você cria o projeto, o código é compilado em um assembly que está associado ao documento. O Visual Studio coloca uma cópia do documento e do assembly na pasta de saída de compilação para o projeto e define as configurações de segurança no computador de desenvolvimento para permitir a execução da personalização. Para obter mais informações, consulte Criar soluções do Office.

  2. No documento, verifique se você vê o texto a seguir.

    Este texto foi adicionado usando o designer.

    Este texto foi adicionado usando código.

  3. Feche o documento.

Limpar o projeto

Quando terminar de desenvolver um projeto, você deve remover os arquivos na pasta de saída da compilação e as configurações de segurança criadas pelo processo de compilação.

Para limpar o projeto concluído no computador de desenvolvimento

  1. No Visual Studio, no menu Compilar , clique em Limpar Solução.

Próximas etapas

Agora que você criou uma personalização básica em nível de documento para o Word, você pode aprender mais sobre como desenvolver personalizações a partir destes tópicos:

  • Tarefas gerais de programação que você pode executar em personalizações em nível de documento: programe personalizações em nível de documento.

  • Tarefas de programação específicas para personalizações em nível de documento para soluções do Word: Word.

  • Usando o modelo de objeto do Word: Visão geral do modelo de objeto do Word.

  • Personalizar a interface do usuário do Word, por exemplo, adicionando uma guia personalizada à Faixa de Opções ou criando seu próprio painel de ações: personalização da interface do usuário do Office.

  • Usando objetos estendidos do Word fornecidos por soluções do Office no Visual Studio para executar tarefas que não são possíveis usando o modelo de objeto do Word (por exemplo, hospedar controles gerenciados em documentos e vincular controles do Word a dados usando o modelo de vinculação de dados do Windows Forms): Automatizar o Word usando objetos estendidos.

  • Criando e depurando personalizações em nível de documento para o Word: Criar soluções do Office.

  • Implantando personalizações em nível de documento para o Word: implantar uma solução do Office.

Conteúdo relacionado