Métodos do conector do Microsoft Excel

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

    • Os métodos do conector Microsoft do Excel executam várias ações em documentos Microsoft do Excel. Em um fluxo de automação, os métodos são conectados a outros métodos e componentes. Para usar os métodos, você deve primeiro expô-los.

    Aberto

    Cria ou abre um arquivo Microsoft existente, dependendo das entradas.
    Nota:
    Você deve executar este método antes de qualquer outro método.
    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

    Caminho para o arquivo existente que o método abre.

    Para criar um arquivo, você deve definir o valor do parâmetro CreateNewFile como verdadeiro.

    Nota:
    O caminho deve conter o nome do arquivo.
    		 Dados em Cadeia de caracteres Nenhum(a) Sim
    CriarNovoArquivo Cria um arquivo.

    Para criar um arquivo, defina o valor como Verdadeiro e forneça o caminho do arquivo e o nome do arquivo no parâmetro Filepath.

    		 Dados em Booliano Nenhum(a) Não
    Exibir Alertas Exibe um alerta na barra de tarefas quando um arquivo é aberto ou criado.

    Para exibir um alerta, defina o valor como Verdadeiro e o valor do parâmetro IsVisible como Verdadeiro.

    		 Dados em Booliano Nenhum(a) Não
    Está visível Funciona com o parâmetro DisplayAlerts para exibir um alerta na barra de tarefas quando um arquivo é aberto ou criado.

    Para exibir um alerta, defina o valor como Verdadeiro e o valor do parâmetro DisplayAlerts como Verdadeiro.

    		 Dados em Booliano Nenhum(a) Não
    ModoSomenteLeitura Se o valor for verdadeiro, o método abrirá o arquivo em um modo somente leitura, caso contrário, abrirá o arquivo em um modo editável. Dados em Booliano Nenhum(a) Não
    Senha Use uma senha se o documento estiver protegido por senha. Dados em Cadeia de caracteres Nenhum(a) Não
    Retornar Se o valor for Verdadeiro, o arquivo será aberto ou criado, caso contrário, o valor será Falso. Saída de dados Booliano Não aplicável Não aplicável

    AdicionarNovaPlanilha

    Adiciona uma planilha ao arquivo.
    Nota:
    Você deve executar o método Open antes de executar este método.
    Tabela 2. Parâmetros do método AddNewWorkSheet
    Parâmetro Descrição Tipo de porta de dados Tipo de dados Valor padrão Obrigatório?
    SheetName Nome da planilha que o método adiciona ao arquivo. Dados em Cadeia de caracteres Nenhum(a) Sim

    GetSheetNames

    Retorna os nomes das planilhas no documento do Excel Microsoft aberto.
    Nota:
    Você deve executar o método Open antes de executar este método.
    Tabela 3. Parâmetros do método GetSheetNames
    Parâmetro Descrição Tipo de porta de dados Tipo de dados Valor padrão Obrigatório?
    Retornar Retorna os nomes das planilhas no documento do Excel Microsoft aberto. Saída de dados Cadeia de caracteres Nenhum valor padrão Não aplicável

    Fechar

    Encerra o Microsoft documento do Excel ativo.
    Nota:
    Você deve executar o método Open antes de executar este método.
    Tabela 4. Parâmetros do método de fechamento
    Parâmetro Descrição Tipo de porta de dados Tipo de dados Valor padrão Obrigatório?
    salvarMudanças Se o valor estiver definido como Verdadeiro, as mudanças no arquivo serão salvas antes de fechar. Else, se definido como falso, nenhuma mudança será salva. Dados em Booliano Nenhum(a) Não

    ColumnsCount

    Retorna a contagem total de colunas em uma planilha do arquivo do Excel Microsoft ativo.
    Nota:
    Você deve executar o método Open antes de executar este método.
    Tabela 5. Parâmetros do método ColumnsCount
    Parâmetro Descrição Tipo de porta de dados Tipo de dados Valor padrão Obrigatório?
    SheetName Nome da planilha que o método usa para contar o número de colunas. Dados em Cadeia de caracteres Nenhum(a) Sim
    Retornar Retorna a contagem de colunas na planilha. Saída de dados Inteiro Não aplicável Não aplicável

    Copiar

    Copia o conteúdo de um intervalo de células em uma planilha.
    Dica:
    Você pode colar o conteúdo copiado com o método Colar.
    Tabela 6. Copiar parâmetros do método
    Parâmetro Descrição Tipo de porta de dados Tipo de dados Valor padrão Obrigatório?
    Nome da planilha Nome da planilha da qual o método copia o conteúdo da célula. Dados em Cadeia de caracteres Nenhum(a) Sim
    Intervalo de células Intervalo de células do qual o método copia o conteúdo. Dados em Cadeia de caracteres Nenhum(a) Sim

    CriarGráfico

    Cria o tipo de gráfico especificado no documento do Excel Microsoft aberto.
    Nota:
    Você deve executar o método Open antes deste método.
    Tabela 7. Parâmetros do método CreateChart
    Parâmetro Descrição Tipo de porta de dados Tipo de dados Valor padrão Obrigatório?
    SheetName Nome da folha na qual o gráfico é criado. Entrada de dados Cadeia de caracteres Nenhum valor padrão Sim
    Intervalo de células Intervalo de células do qual o método obtém os dados para criar um gráfico. Entrada de dados Cadeia de caracteres Nenhum valor padrão Sim
    Tipo de gráfico Tipo de gráfico que será criado. Entrada de dados ExcelChartType Nenhum valor padrão Sim
    Retornar Se for verdadeiro, o gráfico foi criado com sucesso. Else, se falso, a criação do gráfico falhou. Saída de dados Booliano Nenhum valor padrão Não aplicável

    ExcluirColuna

    Exclui uma coluna com base no índice especificado.

    Tabela 8. Parâmetros do método DeleteColumn
    Parâmetro Descrição Tipo de porta de dados Tipo de dados Valor padrão Obrigatório?
    SheetName Nome da planilha da qual a coluna é excluída. Entrada de dados Cadeia de caracteres Nenhum valor padrão Sim
    ColumnIndex Índice da coluna que o método excluirá. Entrada de dados Inteiro Nenhum valor padrão Sim
    Retornar Retorna o valor booliano que indica se a coluna foi excluída. Se for verdadeiro, a coluna será excluída. Else, se falso, a coluna não foi excluída. Saída de dados Booliano Não aplicável Não aplicável

    ExcluirConteúdoDoIntervalo

    Exclui o conteúdo do intervalo de células especificado.

    Tabela 9. Parâmetros do método DeleteContentFromRange
    Parâmetro Descrição Tipo de porta de dados Tipo de dados Valor padrão Obrigatório?
    SheetName Nome da planilha da qual o conteúdo será excluído. Entrada de dados Cadeia de caracteres Nenhum valor padrão Sim
    Intervalo de células Intervalo de células na coluna. Entrada de dados Cadeia de caracteres Nenhum valor padrão Sim
    Retornar Retorna o valor booliano de se o conteúdo foi excluído. Saída de dados Booliano Não aplicável Não aplicável

    ExcluirColunasVazias

    Exclui colunas sem conteúdo.

    Tabela 10. Parâmetros do método DeleteEmptyColumns
    Parâmetro Descrição Tipo de porta de dados Tipo de dados Valor padrão Obrigatório?
    SheetName Nome da planilha que contém a coluna vazia. Entrada de dados Cadeia de caracteres Nenhum valor padrão Sim

    DeleteEmptyRows

    Exclui linhas vazias da planilha especificada.

    Tabela 11. Parâmetros do método DeleteEmptyColumns
    Parâmetro Descrição Tipo de porta de dados Tipo de dados Valor padrão Obrigatório?
    SheetName Nome da planilha que contém as linhas vazias. Entrada de dados Cadeia de caracteres Nenhum valor padrão Sim

    Excluir linha

    Exclui a linha com base no índice especificado.

    Tabela 12. Parâmetros do método DeleteRow
    Parâmetro Descrição Tipo de porta de dados Tipo de dados Valor padrão Obrigatório?
    SheetName Nome da planilha da qual as linhas serão excluídas. Entrada de dados Cadeia de caracteres Nenhum valor padrão Sim
    ÍndiceDeLinha Índice da linha que será excluída. Entrada de dados Inteiro Nenhum valor padrão Sim
    Retornar Retorna o valor booliano que indica se a linha foi excluída. Saída de dados Booliano Não aplicável Não aplicável

    Excluir planilha

    Exclui a planilha especificada.

    Tabela 13. Parâmetros do método DeleteWorksheet
    Parâmetro Descrição Tipo de porta de dados Tipo de dados Valor padrão Obrigatório?
    SheetName Nome da planilha que será excluída. Entrada de dados Cadeia de caracteres Nenhum valor padrão Sim
    Retornar Retorna o valor booliano que indica se a planilha foi excluída. Saída de dados Booliano Não aplicável Não aplicável

    ExportChartAsImages

    Exporta o gráfico na planilha especificada como uma imagem para o local especificado.

    Tabela 14. Parâmetros do método ExportChartAsImages
    Parâmetro Descrição Tipo de porta de dados Tipo de dados Valor padrão Obrigatório?
    SheetName Nome da folha que contém o gráfico. Entrada de dados Cadeia de caracteres Nenhum valor padrão Sim
    Salvar caminho da pasta Caminho para a unidade local em que o gráfico será salvo. Entrada de dados Cadeia de caracteres Nenhum valor padrão Não aplicável

    Exportar para PDF

    Exporta o conteúdo do documento do Excel aberto para PDF.

    Tabela 15. Parâmetros do método ExportChartAsImages
    Parâmetro Descrição Tipo de porta de dados Tipo de dados Valor padrão Obrigatório?
    Caminho do arquivo Caminho para a unidade local em que o PDF é exportado. Entrada de dados Cadeia de caracteres Nenhum valor padrão Sim

    Localizar e substituir

    Localiza e substitui texto na planilha especificada.

    Tabela 16. Parâmetros do método FindAndReplace
    Parâmetro Descrição Tipo de porta de dados Tipo de dados Valor padrão Obrigatório?
    SheetName Nome da planilha em que o texto será substituído. Entrada de dados Cadeia de caracteres Nenhum valor padrão Sim
    LocalizarTexto Texto que será substituído. Entrada de dados Cadeia de caracteres Nenhum valor padrão Sim
    Substituir para Texto que substituirá o texto existente. Entrada de dados Cadeia de caracteres Nenhum valor padrão Sim
    Retornar Retorna o valor booliano que indica se o texto foi substituído. Saída de dados Booliano Não aplicável Não aplicável

    GetActiveSheetName

    Retorna o nome da planilha ativa.

    Tabela 17. Parâmetros do método GetActiveSheetName
    Parâmetro Descrição Tipo de porta de dados Tipo de dados Valor padrão Obrigatório?
    Retornar Retorna o nome da planilha ativa. Saída de dados Cadeia de caracteres Nenhum valor padrão Não aplicável

    InserirNovaColuna

    Insere uma nova coluna no índice especificado na planilha.

    Tabela 18. Parâmetros do método InserirNovaColuna
    Parâmetro Descrição Tipo de porta de dados Tipo de dados Valor padrão Obrigatório?
    SheetName Nome da planilha em que a coluna será inserida. Entrada de dados Cadeia de caracteres Nenhum valor padrão Sim
    ColumnIndex Índice da nova coluna. A nova coluna será inserida no índice especificado. Entrada de dados Inteiro Nenhum valor padrão Sim

    InserirNovaLinha

    Insere uma nova linha no índice especificado na planilha especificada.

    Tabela 19. Parâmetros do método InserirNovaRinha
    Parâmetro Descrição Tipo de porta de dados Tipo de dados Valor padrão Obrigatório?
    SheetName Nome da planilha em que a linha será inserida. Entrada de dados Cadeia de caracteres Nenhum valor padrão Sim
    ÍndiceDeLinha Índice da linha. A linha será inserida no índice especificado. Entrada de dados Inteiro Nenhum valor padrão Sim
    Retornar Retorna o valor booliano que indica se uma linha foi inserida. Se verdadeiro, a linha foi inserida. Else, se falso, a linha não foi inserida. Saída de dados Booliano Não aplicável Não aplicável

    Inserir objeto

    Insere um objeto na célula especificada de uma folha em um arquivo do Excel. O exemplo de um objeto pode ser um arquivo do Excel, uma imagem ou um arquivo PDF.
    Nota:
    Execute o método Open antes de executar este método.
    Tabela 20. Parâmetros do método InserirObject
    Parâmetro Descrição Tipo de porta de dados Tipo de dados Valor padrão Obrigatório?
    SheetName Planilha do Excel que contém a célula em que o método insere o objeto. Entrada de dados Cadeia de caracteres N/D Sim
    NomeCélula Nome da célula em que o método insere o objeto. Por exemplo, A1. Entrada de dados Cadeia de caracteres N/D Sim
    Caminho do arquivo Caminho do arquivo do objeto que o método insere. Entrada de dados Cadeia de caracteres N/D Sim

    Está aberto

    Retorna o valor booliano se o arquivo do Excel especificado estiver aberto.

    Tabela 21. Parâmetros do método IsOpen
    Parâmetro Descrição Tipo de porta de dados Tipo de dados Valor padrão Obrigatório?
    Caminho do arquivo Caminho para o arquivo do Excel na unidade local. Entrada de dados Cadeia de caracteres Nenhum valor padrão Sim
    Retornar Retorna o valor booliano que indica se o arquivo do Excel está aberto. Saída de dados Booliano Não aplicável Não aplicável

    MesclarCélulas

    Mescla as células especificadas no intervalo.

    Tabela 22. Parâmetros do método MergeCells
    Parâmetro Descrição Tipo de porta de dados Tipo de dados Valor padrão Obrigatório?
    Nome da planilha Nome da planilha na qual as células serão mescladas. Entrada de dados Cadeia de caracteres Nenhum valor padrão Sim
    Intervalo de células Intervalo de células. Todas as células dentro do intervalo serão mescladas. Entrada de dados Cadeia de caracteres Nenhum valor padrão Sim

    ReadFromRange

    Lê dados da planilha especificada e retorna os dados.

    Tabela 23. Parâmetros do método ReadFromRange
    Parâmetro Descrição Tipo de porta de dados Tipo de dados Valor padrão Obrigatório?
    SheetName Nome da planilha de onde o método lerá os dados. Entrada de dados Cadeia de caracteres Nenhum valor padrão Sim
    Intervalo de células Intervalo de células. O método lerá os dados dessas células. Entrada de dados Cadeia de caracteres Nenhum valor padrão Sim
    FirstRowAsHeader Valor booliano que indica se o método trata a primeira linha como o cabeçalho. Se for verdadeiro, a primeira linha será tratada como um cabeçalho. Caso contrário, se for falso, ele não tratará a primeira linha como um cabeçalho. Entrada de dados Booliano Nenhum valor padrão Não
    Retornar Retorna a tabela de dados que compreende os dados das células. Saída de dados Tabela de dados Não aplicável Não

    Ler da planilha

    Retorna todos os dados na planilha especificada.

    Tabela 24. Parâmetros do método MergeCells
    Parâmetro Descrição Tipo de porta de dados Tipo de dados Valor padrão Obrigatório?
    Nome da planilha Nome da planilha da qual o método lerá os dados. Entrada de dados Cadeia de caracteres Nenhum valor padrão Sim
    Retornar Retorna todos os dados na planilha especificada. Saída de dados Tabela de dados Não aplicável Não aplicável

    RenomearSheetName

    Renomeia uma planilha existente.

    Tabela 25. Parâmetros do método RenameSheetName
    Parâmetro Descrição Tipo de porta de dados Tipo de dados Valor padrão Obrigatório?
    AntigoNomeDePlanilha O nome da planilha existente. Entrada de dados Cadeia de caracteres Nenhum valor padrão Sim
    NewSheetName O novo nome da planilha. Entrada de dados Cadeia de caracteres Nenhum valor padrão Sim
    Retornar Retorna a resposta booliana que indica se a planilha foi renomeada. Saída de dados Booliano Nenhum valor padrão Não aplicável

    Contagem de linhas

    Retorna a contagem de linhas na planilha especificada.

    Tabela 26. Parâmetros do método RenameSheetName
    Parâmetro Descrição Tipo de porta de dados Tipo de dados Valor padrão Obrigatório?
    SheetName Nome da planilha de onde a contagem de linhas será retornada. Entrada de dados Cadeia de caracteres Nenhum valor padrão Sim
    Retornar Retorna o número de linhas. Saída de dados Inteiro Não aplicável Não aplicável

    RemoverFiltro

    Remove todos os filtros definidos no documento do Excel.

    Tabela 27. Parâmetros do método RemoveFilter
    Parâmetro Descrição Tipo de porta de dados Tipo de dados Valor padrão Obrigatório?
    Nome da planilha Nome da planilha da qual o método removerá os filtros. Entrada de dados Cadeia de caracteres Nenhum valor padrão Sim

    Salvar

    Salva as mudanças no documento do Excel.

    GravarNoIntervalo

    Grava dados em um intervalo especificado.

    Tabela 28. Parâmetros do método RemoveFilter
    Parâmetro Descrição Tipo de porta de dados Tipo de dados Valor padrão Obrigatório?
    SheetName Nome da planilha na qual os dados são gravados. Entrada de dados Cadeia de caracteres Nenhum valor padrão Sim
    NomeCélula Nome da célula na qual os dados são gravados. Entrada de dados Cadeia de caracteres Nenhum valor padrão Sim
    Dados Dados que serão gravados. Entrada de dados Tabela de dados Nenhum valor padrão Sim
    IncludeHeaders Valor booliano que indica se os cabeçalhos na tabela de dados serão adicionados. Entrada de dados Booliano Nenhum valor padrão Não