Microsoft Métodos de conector do Word

  • Versão de lançamento: Xanadu
  • Atualizado 1 de ago. de 2024
  • 12 min. de leitura

    • Os métodos do conector Microsoft do Word permitem que você execute várias tarefas diárias com documentos do Microsoft Word e as automatize. Por exemplo, adicione um rodapé de página.

    Aberto

    Abre um Microsoft arquivo do Word salvo no disco local.
    Nota:
    Você deve executar este método antes de executar qualquer outro método no conector do Microsoft Word.
    Tabela 1. Parâmetros de método aberto
    Parâmetro Descrição Tipo de porta de dados Tipo de dados Valor padrão Obrigatório?
    Caminho do arquivo Especifica o caminho para o arquivo do Word Microsoft no disco local. Dados em Cadeia de caracteres Nenhum valor padrão Sim
    Tempo limite Especifica o tempo após o qual a operação expira. Dados em Inteiro Nenhum valor padrão Não
    Senha Use uma senha se o documento estiver protegido por senha. Dados em Cadeia de caracteres Nenhum(a) Não
    Retornar Retorna o valor booliano com base no resultado da operação. Se for verdadeiro, o arquivo será aberto. Else, se falso, o arquivo falhou ao abrir. Saída de dados Booliano Não aplicável Não aplicável

    Para obter detalhes sobre os problemas relacionados ao método Open, consulte o artigo da base de conhecimento KB1123558 e o artigo da base de conhecimento KB1123548.

    AdicionarRodapé

    Adiciona um rodapé ao documento do Word Microsoft no tamanho de fonte especificado.

    Para usar este método, forneça o texto a ser adicionado ao parâmetro Text e o tamanho da fonte em que o texto do rodapé precisa ser exibido para o parâmetro FontSize. O valor padrão do parâmetro FontSize é 12.

    Nota:
    Você deve executar o método Open antes de executar este método.
    Tabela 2. Parâmetros do método AddFooter
    Parâmetro Descrição Tipo de porta de dados Tipo de dados
    Texto Especifica o texto no rodapé. Dados em Cadeia de caracteres
    Tamanho da fonte Especifica o tamanho da fonte do texto no rodapé. O valor padrão é 12. Dados em Inteiro

    Para fornecer entradas, consulte Configurar propriedades da porta

    AdicionarCabeçalho

    Adiciona um cabeçalho a um documento do Word Microsoft no tamanho de fonte especificado.

    Para usar este método, forneça o texto a ser adicionado ao parâmetro Text e o tamanho da fonte em que o texto do cabeçalho precisa ser exibido para o parâmetro FontSize. O valor padrão do parâmetro FontSize é 12.

    Nota:
    Você deve executar o método Open antes de executar este método.
    Tabela 3. Parâmetros do método AddHeader
    Parâmetro Descrição Tipo de porta de dados Tipo de dados
    Texto Especifica o texto no cabeçalho. Dados em Cadeia de caracteres
    Tamanho da fonte Especifica o tamanho da fonte do texto no cabeçalho. O valor padrão é 12. Dados em Inteiro

    Cópia de célula

    Copia o conteúdo de uma célula de tabela identificada usando o índice de linha e o índice de coluna da tabela em um documento Microsoft Palavra.

    Para usar este método, forneça o índice de linha para o parâmetro RowIndex e o índice de coluna para o parâmetro ColumnIndex. O valor padrão para RowIndex e ColumnIndex é -1 cada.

    Nota:
    Você deve executar o método SetTable antes de executar este método.
    Tabela 4. Parâmetros do método “CelularCopy”
    Parâmetro Descrição Tipo de porta de dados Tipo de dados
    ÍndiceDeLinha Índice da linha da célula que precisa ser copiada. O valor do índice de linha deve ser igual ou maior que zero. O valor padrão é -1, o que significa que não há célula disponível. Dados em Inteiro
    ColumnIndex Índice da coluna da célula que precisa ser copiada. O índice da coluna deve ser igual ou maior que zero. O valor padrão é -1, o que significa que não há célula disponível. Dados em Inteiro

    ColarCélula

    cola o conteúdo da célula da tabela copiada em uma célula da tabela identificada usando o índice de linha e o índice de coluna da tabela em um documento Microsoft Palavra.

    Para usar este método, forneça o índice de linha para o parâmetro RowIndex e o índice de coluna para o parâmetro ColumnIndex. O valor padrão para RowIndex e ColumnIndex é -1 cada.

    Nota:
    Você deve executar o método "CelularCopy" antes de executar este método.
    Tabela 5. Parâmetros do método cellPaste
    Parâmetro Descrição Tipo de porta de dados Tipo de dados
    ÍndiceDeLinha Índice da linha da célula para a qual os dados precisam ser colados. O valor do índice de linha deve ser igual ou maior que zero. O valor padrão é -1, o que significa que não há linha disponível para colar dados. Dados em Inteiro
    ColumnIndex Índice da coluna da célula para a qual os dados precisam ser colados. O índice da coluna deve ser igual ou maior que zero. O valor padrão é -1, o que significa que não há coluna disponível para colar dados. Dados em Inteiro

    Fechar

    Encerra o último Microsoft Palavra documento aberto. Ao fechar o documento, é opcional salvar as mudanças.

    Se a modificação feita no documento do Word precisar ser salva, defina o parâmetro booliano saveChanges como Verdadeiro, caso contrário, defina-o como Falso. Por padrão, o parâmetro booliano saveChanges é definido como Verdadeiro.

    Nota:
    Você deve executar o método Open antes de executar este método.
    Tabela 6. Parâmetros do método de fechamento
    Parâmetro Descrição Tipo de porta de dados Tipo de dados
    salvarMudanças Especifica se as mudanças feitas no documento do Word devem ser salvas antes de fechar. Por padrão, está definido como Verdadeiro, o que significa que as mudanças serão salvas antes do fechamento. Se as mudanças não precisarem ser salvas antes do fechamento, defina como Falso. Dados em Booliano

    ExcluirColuna

    Exclui uma coluna de uma tabela com base em um valor de índice especificado da coluna em um documento Microsoft Palavra.

    Para usar este método, forneça o índice da coluna que precisa ser excluída para o parâmetro ColumnIndex. O valor padrão é -1.

    Nota:
    Você deve executar o método SetTable antes de executar este método.
    Tabela 7. Parâmetros do método DeleteColumn
    Parâmetro Descrição Tipo de porta de dados Tipo de dados
    ColumnIndex Índice da coluna que precisa ser excluída. O índice da coluna deve ser igual ou maior que zero. O valor padrão é -1, o que significa que não há coluna disponível para ser excluída. Dados em Inteiro

    Excluir página

    Exclui uma página com base em um valor de índice especificado de um documento Microsoft Palavra.

    Para usar este método, forneça o valor de índice da página que precisa ser excluída para o parâmetro PageIndex.

    Nota:
    Você deve executar o método Open antes de executar este método.
    Tabela 8. Parâmetros do método DeletePage
    Parâmetro Descrição Tipo de porta de dados Tipo de dados
    PageIndex Especifica o número de índice da página que precisa ser removida ou excluída.

    Se você não fornecer nenhum número de índice, o método excluirá a primeira página por padrão.

    		 Dados em Inteiro

    Excluir linha

    Exclui uma linha com base no valor de índice especificado de uma tabela em um documento Microsoft Palavra.

    Para usar este método, forneça o índice da linha que precisa ser excluída para o parâmetro RowIndex. O valor padrão é -1.

    Nota:
    Você deve executar o método SetTable antes de executar este método.
    Tabela 9. Parâmetros do método DeleteRow
    Parâmetro Descrição Tipo de porta de dados Tipo de dados
    ÍndiceDeLinha Índice da linha que precisa ser excluída. O valor do índice de linha deve ser igual ou maior que zero. O valor padrão é -1, o que significa que não há linha disponível para ser excluída. Dados em Inteiro

    Excluir tabela

    Exclui uma tabela de um documento Microsoft Palavra.

    Se o documento tiver várias tabelas, o método excluirá a primeira tabela do documento.

    Nota:
    Você deve executar o método SetTable antes de executar este método.

    Exportar para PDF

    Exporta um documento Microsoft Palavra para um documento PDF.
    Nota:
    Você deve executar o método Open antes de executar este método.
    Tabela 10. Parâmetros do método ExportToPDF
    Parâmetro Descrição Tipo de porta de dados Tipo de dados Valor padrão Obrigatório?
    Caminho do arquivo Especifica o caminho para o local em que o documento do Word é exportado para PDF. Dados em Cadeia de caracteres Nenhum valor padrão Sim

    Localizar

    Encontra o texto especificado em um documento Microsoft Palavra e retorna uma resposta booliana.
    Entrada
    Texto
    Saída
    Retornar (booliano)

    ObterValorCélulaPorIndex

    Retorna o valor em uma célula de uma tabela em um documento Microsoft Palavra.
    Entrada
    ÍndiceDeCélula

    ObterTextoRodapé

    Retorna o conteúdo do rodapé em um documento Microsoft Palavra.

    Nota:
    Você deve executar o método Open antes de executar este método.
    Saída
    Retornar (cadeia de caracteres)

    ObterTextoCabeçalho

    Retorna o conteúdo do cabeçalho em um documento Microsoft Palavra.

    Nota:
    Você deve executar o método Open antes de executar este método.
    Saída
    Retornar (cadeia de caracteres)

    GetPageCount

    Retorna o número de páginas em um documento Microsoft Palavra.

    Saída
    Retornar (inteiro)

    GetRowIndexByValue

    Retorna o valor de índice de uma linha com base no valor na linha.
    Nota:
    Você deve executar os métodos GetTable e SetTable antes de executar este método.
    Entrada
    Tabela, Valor

    ObterTabela

    Retorna os dados em uma tabela de um documento do Word Microsoft como um objeto de tabela e uma tabela de dados. Se o documento contiver várias tabelas, você poderá especificar o índice da tabela para identificar a tabela para o método. Você também pode especificar o tipo de tabela, se necessário.

    Dependendo da estrutura da tabela, você pode configurar opcionalmente o tipo de tabela para o método. Para configurar a tabela, siga as etapas abaixo.
    1. Clique no ícone de configurações de método (ícone de configurações de método).
    2. Selecione o tipo de tabela.
    3. Clique em OK.
    Entrada
    TableIndex, FirstRowIsHeader
    Saída
    Tabela (objeto)
    Dados (DataTable)

    ObterValoresDeCélulaTabela

    Retorna os valores em uma ou mais células da tabela.

    Para especificar o número de células, você deve configurar os valores de índice das células. Para configurar, faça o seguinte.
    1. Clique no ícone de configurações de método (ícone de configurações de método).
    2. Clique em ( ícone Clique para adicionar índice de célula).
    3. Insira os valores de índice para as células.
    4. Repita as etapas para adicionar mais valores de índice.
    5. Clique em OK.
    Saída
    Índice de célula (objeto)

    ObterContagemDeTabela

    Retorna o número de tabelas em um documento Microsoft Palavra. Opcionalmente, você pode especificar o tipo de tabela para o método identificar.

    Para configurar o tipo de tabela, siga as etapas abaixo.
    1. Clique no ícone de configurações de método (ícone de configurações de método).
    2. Selecione o tipo de tabela.
    3. Clique em OK.
    Saída
    Retornar (inteiro)

    ObterDadosTableRow

    Retorna os valores em uma ou mais células de uma linha em um Microsoft documento do Word. Você pode especificar os valores de índice das células da linha.

    Você pode configurar os valores de índice das células em uma linha. Para configurar, siga estas etapas.
    1. Clique no ícone de configurações de método (ícone de configurações de método).
    2. Clique no ícone para adicionar valor de índice (ícone para adicionar valor de índice).
    3. Insira o valor de índice da célula.
    4. Repita as etapas para adicionar mais valores de índice.
    5. Clique em OK.
    Saída
    Índice de linha (objeto)

    ObterTexto

    Retorna todo o conteúdo de texto em um Microsoft documento do Word.

    Tabela 11. Parâmetros do método GetText
    Parâmetro Descrição Tipo de porta de dados Tipo de dados Valor padrão Obrigatório?
    Retornar Retorna o texto do documento do Word. Saída de dados Cadeia de caracteres Nenhum valor padrão Não aplicável

    InserirNovaColuna

    Insere uma nova coluna na primeira tabela do documento com base no valor de índice da coluna especificada.
    Entrada
    ColumnIndex

    InserirNovaLinha

    Insere uma nova linha com base no valor do índice.
    Entrada
    ÍndiceDeLinha

    Inserir imagem

    Insere uma imagem.
    Entrada
    ImageFilePath
    Marcador

    Inserir tabela

    Insere uma tabela em um documento Microsoft Palavra. Insere uma tabela em um documento Microsoft. Opcionalmente, você pode personalizar o documento configurando-o antes de inserir.

    Nota:
    Antes de executar este método, você deve executar os métodos GetTable e SetTable.
    Para personalizar a tabela antes de inserir, siga as etapas abaixo.
    1. Clique no ícone de configurações de método (ícone de configurações de método).
    2. Selecione Incluir cabeçalhos.
    3. Selecione o estilo de borda e o comportamento de ajuste automático.
    4. Selecione Incluir linhas vazias.
    5. Para ignorar colunas específicas, clique no ícone para adicionar valor de índice ( Adicionar valor de índice).
    6. Insira o valor de índice da coluna.
    7. Clique em OK.
    Entrada
    Marcador
    Dados

    Inserir texto

    Insere texto no início do documento do Word.

    Tabela 12. Parâmetros do método InserirTexto
    Parâmetro Descrição Tipo de porta de dados Tipo de dados Valor padrão Obrigatório?
    texto Usa o texto. Entrada de dados Cadeia de caracteres Nenhum valor padrão Sim

    Está aberto

    Verifica se um documento Microsoft Palavra está aberto.

    Saída
    Retornar (booliano)

    MesclarPorIndicesDeCélula

    Mescla o intervalo de células especificado na forma de intervalo de valores de índice.
    Entrada
    IniciarCélulaIndexEndCélulaIndex ​

    MesclarPorRinhaCol

    Mescla um intervalo de células de uma tabela em um documento Microsoft Palavra.
    Entrada
    StartRowIndex StartColIndex EndRowIndex EndColIndex

    SubstituirMarcador

    Substitui um marcador em um documento Microsoft Palavra pelo texto especificado.
    Entrada
    Marcar Substituição de Texto

    SubstituirMarcadores

    Localiza e substitui vários marcadores em um documento Microsoft Palavra pelo texto especificado.
    Entrada
    Texto
    Forneça mais detalhes sobre o texto do marcador a ser substituído da seguinte forma:
    1. Clique duas vezes no componente.
    2. Na caixa de diálogo FORNECER RÓTULOS/MARCADORES, clique no ícone de clique para adicionar rótulo (ícone Clique para adicionar rótulo) e insira o marcador para substituí-lo.

      Repita esta etapa para adicionar mais marcadores.

    3. Clique em OK.

    SubstituirTextoRodapé

    Localiza e substitui o texto do rodapé em um documento Microsoft Palavra pelo texto especificado.
    Entrada
    LocalizarTexto
    Substituir texto

    Substituir texto do cabeçalho

    Localiza e substitui o texto do cabeçalho em um documento Microsoft Palavra pelo texto especificado.
    Entrada
    LocalizarTexto
    Substituir texto

    Substituir textoestático

    Localiza e substitui o texto em um documento Microsoft Palavra pelo texto especificado. Substitui marcadores, títulos ou qualquer texto com base na configuração.

    Você deve configurar o método antes de executar. Para configurar, siga as etapas.
    1. Clique no ícone de configurações de método (ícone de configurações de método).
    2. Clique no ícone adicionar texto ( ícone Adicionar texto.)
    3. Insira o título, o marcador ou o texto que você deseja substituir.
    4. Repita as etapas para inserir mais texto.
    5. Clique em OK.
    Entrada
    Objeto

    Substituir texto

    Localiza e substitui o texto em um documento Microsoft Palavra pelo texto especificado.
    Entrada
    LocalizarTexto
    Substituir texto

    Redimensionar

    Redimensiona a janela de um documento Microsoft Palavra.
    Entrada
    Esquerda
    Superior
    Largura
    Altura

    Salvar

    Salva o documento Microsoft Palavra aberto.

    Salvar como

    Salva o documento Microsoft Palavra aberto com o nome de arquivo especificado.
    Entrada
    Caminho do arquivo

    Definir tabela

    Define uma tabela em um documento Microsoft Palavra.
    Entrada
    Tabela

    DefinirValoresDeCélulaTabela

    Define o conteúdo de uma célula de tabela em um documento Microsoft Palavra.

    Forneça um ou mais índices de célula e tipos de valor da seguinte forma:
    1. Clique duas vezes no componente.
    2. Na caixa de diálogo FORNECER ÍNDICE DE CÉLULA, clique no ícone de clique para adicionar índice de célula (ícone Clique para adicionar índice de célula), insira um índice de célula e selecione um tipo de valor.

      Repita esta etapa para adicionar mais índices de célula e tipos de valor.

    3. Clique em OK.

    SetTableRowData

    Define o conteúdo em uma linha da tabela em uma planilha de um documento Microsoft Palavra.
    Entrada
    ÍndiceDeLinha
    Forneça o índice da coluna da seguinte forma:
    1. Clique duas vezes no componente.
    2. Na caixa de diálogo FORNECER ÍNDICE DE COLUNA, clique no ícone de clique para adicionar índice de célula (ícone Clique para adicionar índice de célula) e insira um índice de coluna.
    3. Clique em OK.