Microsoft Excel métodos de conector

  • Versão de lançamento: Zurich
  • Atualizado 31 de jul. de 2025
  • 36 min. de leitura

    • . Microsoft Excel os métodos de conector executam várias ações em Microsoft Excel documentos. 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 exibi-los.

    Aberto

    Cria ou abre um existente Microsoft Excel arquivo dependendo das entradas.
    Nota:
    Este método deve ser executado antes de qualquer outro método.
    Tabela 1. Abrir parâmetros de método
    Parâmetro Descrição Tipo de porta de dados Tipo de dados
    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
    CreateNewFile Especifica se um novo arquivo do Excel deve ser criado se o arquivo especificado não existir.

    Se o parâmetro CreateNewFile estiver definido como verdadeiro, um novo arquivo será criado no caminho de arquivo especificado. Se definido como Falso, ele tentará abrir o excel a partir do caminho de arquivo fornecido.

    		 Dados em Booliano
    Exibir Alertas Especifica se o Excel exibe alertas ou avisos durante o processo de abertura.

    Se definido como verdadeiro, o Excel exibirá alertas para problemas como conflitos de arquivo ou avisos de compatibilidade. Se definido como falso, esses alertas serão suprimidos.

    		 Dados em Booliano
    IsVisível Especifica se a janela da aplicação do Excel está visível para o usuário quando o arquivo é aberto ou não.

    Se definido como verdadeiro, a janela do Excel será exibida na tela. Se definido como falso, o Excel será executado em segundo plano sem uma interface visível.

    		 Dados em Booliano
    ReadOnlyMode Especifica se o arquivo do Excel deve ser aberto no modo somente leitura.

    Se definido como verdadeiro, o arquivo será aberto no modo somente leitura, impedindo que sejam feitas mudanças. Se definido como falso, o arquivo será aberto no modo normal, permitindo modificações.

    		 Dados em Booliano
    Senha Senha necessária para abrir o arquivo do Excel se ele estiver protegido por senha.

    Se o arquivo não estiver protegido por senha, este parâmetro poderá ser deixado em branco.

    		 Dados em Cadeia de caracteres
    Retornar Retorna valor Verdadeiro ou Falso. Se o valor for verdadeiro, o arquivo será aberto ou criado com sucesso. Saída de dados Booliano

    AdicionarNova Planilha

    Adiciona uma nova planilha ao arquivo. Este método requer um nome de planilha como parâmetro de entrada do tipo cadeia de caracteres que especifica o nome da nova planilha.
    Nota:
    Você deve executar o método Aberto 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
    SheetName Nome da nova planilha que o método adiciona ao arquivo. Dados em Cadeia de caracteres

    Preenchimento automático

    Preenche automaticamente as células em um intervalo especificado com base no conteúdo de células adjacentes ou em um padrão predefinido. Este método é útil para copiar dados ou formatar em várias células. Microsoft Excel analisa o conteúdo da seleção inicial e extrapola-o para preencher o intervalo desejado. Ele pode ser usado para estender uma série de números, duplicar fórmulas, replicar padrões de texto ou executar qualquer outro processamento de entrada de dados.

    Nota:
    Você deve executar o método Aberto antes de executar este método.
    Tabela 3. Parâmetros do método de preenchimento automático
    Parâmetro Descrição Tipo de porta de dados Tipo de dados
    SheetName Nome da planilha que contém os dados de origem. Dados em Cadeia de caracteres
    SourceRange Intervalo de células com os dados ou fórmulas a serem replicados. Dados em Cadeia de caracteres

    GetSheetNames

    Retorna os nomes de todas as planilhas no abertas Microsoft Excel documento.
    Nota:
    Você deve executar o método Aberto antes de executar este método.
    Tabela 4. Parâmetros do método GetSheetNames
    Parâmetro Descrição Tipo de porta de dados Tipo de dados
    Retornar Retorna os nomes das planilhas em aberto Microsoft Excel documento. Saída de dados Cadeia de caracteres

    Fechar

    Fecha o ativo Microsoft Excel documento se ele já estiver aberto e liberar a memória. Este método ajuda na manipulação de memória.
    Nota:
    Você deve executar o método Aberto antes de executar este método.
    Tabela 5. Parâmetros do método de fechamento
    Parâmetro Descrição Tipo de porta de dados Tipo de dados
    SalvaChanges Se o valor estiver definido como verdadeiro, as mudanças no arquivo serão salvas antes de fechar. Se definido como Falso, nenhuma mudança será salva. Dados em Booliano

    ColumnsCount

    Retorna o número total de colunas em uma planilha especificada de um Microsoft Excel arquivo. Este método requer o parâmetro SheetName para especificar a planilha e retorna a contagem de colunas dessa planilha.
    Nota:
    Você deve executar o método Aberto antes de executar este método.
    Tabela 6. Parâmetros do método ColumnsCount
    Parâmetro Descrição Tipo de porta de dados Tipo de dados
    SheetName Nome da planilha que o método usa para contar o número de colunas. Dados em Cadeia de caracteres
    Retornar Retorna a contagem de colunas na planilha. Saída de dados Inteiro

    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 7. Copiar parâmetros do método
    Parâmetro Descrição Tipo de porta de dados Tipo de dados
    Sheetname Nome da planilha que contém os dados de origem. Dados em Cadeia de caracteres
    Cellrange Intervalo de células a serem copiadas. Dados em Cadeia de caracteres

    Colar

    Cola o conteúdo da área de transferência em células específicas fornecidas no parâmetro CellLocation de uma planilha. Também pode ser um intervalo de células.

    Nota:
    Você deve executar o método Copiar antes de executar este método.
    Tabela 8. Colar parâmetros do método
    Parâmetro Descrição Tipo de porta de dados Tipo de dados
    Sheetname Nome da planilha em que o conteúdo da área de transferência será colado. Dados em Cadeia de caracteres
    CellLocation Indica o local (referência de célula) onde o conteúdo da área de transferência será colado. Dados em Cadeia de caracteres

    FillBlankValues

    Preenche células vazias em uma coluna especificada de uma planilha em um Microsoft Excel arquivo com um determinado valor. Ele requer o parâmetro SheetName para especificar a planilha, o parâmetro ColumnName para identificar a coluna e o parâmetro Valor para fornecer o valor de substituição para as células vazias.

    Nota:
    Você deve executar o método Aberto antes de executar este método.
    Tabela 9. Parâmetros do método FillBlankValues
    Parâmetro Descrição Tipo de porta de dados Tipo de dados
    Sheetname Nome da planilha para preencher valores em branco. Dados em Cadeia de caracteres
    ColumnName Nome da coluna na planilha que precisa ser preenchida com um valor.

    ColumnName é um tipo de dados Enum que representa colunas do Excel de Um a AZ.

    		 Dados em ColumnName
    Valor Valor a ser preenchido na coluna. Dados em Cadeia de caracteres

    CreateChart

    Cria um gráfico para um intervalo específico em uma planilha específica. Este método é usado para automatizar a criação de gráficos.
    Nota:
    Você deve executar o método Aberto antes deste método.
    Tabela 10. Parâmetros do método CreateChart
    Parâmetro Descrição Tipo de porta de dados Tipo de dados
    SheetName Nome da planilha em que o gráfico é criado. Dados em Cadeia de caracteres
    CellRange Intervalo de células a partir das quais o gráfico é criado. Dados em Cadeia de caracteres
    ChartType Especifica o tipo de gráfico a ser criado.

    Os tipos de gráfico disponíveis dependem da implementação específica do conector do Excel que está sendo usado.

    		 Dados em ExcelChartType
    Retornar Se verdadeiro, o gráfico será criado com sucesso. Se Falso, houve falha na criação do gráfico. Saída de dados Booliano

    CriarTabela Dinâmica

    Gera uma tabela dinâmica na planilha especificada, utilizando as configurações definidas na janela "Configurações da tabela dinâmica".

    Nota:
    Você deve executar o método Aberto antes deste método.
    Tabela 11. Parâmetros do método CreatePivotTable
    Parâmetro Descrição Tipo de porta de dados Tipo de dados
    SheetName Nome da planilha de onde a tabela dinâmica deve ser criada. Dados em Cadeia de caracteres
    NomeTabela Dinâmica Nome da tabela dinâmica. Dados em Cadeia de caracteres

    Excluir coluna

    Exclui uma coluna em uma determinada planilha com base no índice especificado da coluna.

    Tabela 12. Parâmetros do método DeleteColumn
    Parâmetro Descrição Tipo de porta de dados Tipo de dados
    SheetName Nome da planilha da qual a coluna é excluída. Dados em Cadeia de caracteres
    ColumnIndex Índice da coluna que deve ser excluída.

    No Excel, as colunas são rotuladas em ordem alfabética (A, B, C etc.) e cada coluna tem um índice numérico correspondente (1 para a coluna A, 2 para a coluna B e assim por diante).

    		 Dados em Inteiro
    Retornar Retorna o valor booliano que indica se a coluna foi excluída. Se verdadeiro, a coluna será excluída. Se Falso, a coluna não foi excluída. Saída de dados Booliano

    DeleteContentFromRange

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

    Tabela 13. Parâmetros do método DeleteContentFromRange
    Parâmetro Descrição Tipo de porta de dados Tipo de dados
    SheetName Nome da planilha da qual o conteúdo será excluído. Dados em Cadeia de caracteres
    CellRange Especifica o intervalo de células do qual os dados são excluídos. Dados em Cadeia de caracteres
    Retornar Retorna o valor booliano que indica se o conteúdo do intervalo de células foi excluído. Se verdadeiro, o conteúdo será excluído. Se Falso, o conteúdo não será excluído. Saída de dados Booliano

    ExcluirEmptyColunas

    Exclui colunas que não têm conteúdo em uma planilha especificada de um Microsoft Excel arquivo. Este método requer o parâmetro SheetName para identificar a planilha.

    Tabela 14. Parâmetros do método DeleteEmptyColumns
    Parâmetro Descrição Tipo de porta de dados Tipo de dados
    SheetName Nome da planilha que contém a coluna vazia. Dados em Cadeia de caracteres

    Excluir EmptyRows

    Exclui linhas que não têm conteúdo em uma planilha especificada de um Microsoft Excel arquivo. Este método requer o parâmetro SheetName para identificar a planilha.

    Tabela 15. Parâmetros do método DeleteEmptyColumns
    Parâmetro Descrição Tipo de porta de dados Tipo de dados
    SheetName Nome da planilha que contém as linhas vazias. Dados em Cadeia de caracteres

    ExcluirLinha

    Exclui uma linha da planilha com base no parâmetro rowNumber.

    Tabela 16. Parâmetros do método DeleteRow
    Parâmetro Descrição Tipo de porta de dados Tipo de dados
    SheetName Nome da planilha da qual a linha é excluída. Dados em Cadeia de caracteres
    Row Number Indica o número da linha que deve ser excluída. Dados em Inteiro
    Retornar Retorna o valor booliano que indica se a linha foi excluída. Se verdadeiro, a linha será excluída. Se Falso, a linha não será excluída. Saída de dados Booliano

    ExcluirPlanilha

    Exclui a planilha especificada. Este método requer o parâmetro SheetName para identificar a planilha.

    Tabela 17. Parâmetros do método DeleteWorksheet
    Parâmetro Descrição Tipo de porta de dados Tipo de dados
    SheetName Nome da planilha que deve ser excluída. Dados em Cadeia de caracteres
    Retornar Retorna o valor booliano que indica se a planilha foi excluída. Se verdadeiro, a planilha será excluída. Se Falso, a planilha não será excluída. Saída de dados Booliano

    ExportChartAsImages

    Exporta e salva um gráfico presente em uma planilha em um arquivo de imagem que é salvo no caminho especificado. Este processo separa o gráfico da pasta de trabalho do Excel, fornecendo uma representação visual autônoma que pode ser facilmente compartilhada ou inserida em vários documentos, apresentações ou relatórios.

    Tabela 18. Parâmetros do método ExportChartAsImages
    Parâmetro Descrição Tipo de porta de dados Tipo de dados
    SheetName Nome da planilha que contém o gráfico. Dados em Cadeia de caracteres
    Salvar caminho da pasta Especifica o caminho da pasta em que os gráficos são salvos como arquivos de imagem. Dados em Cadeia de caracteres

    ExportToPDF

    Exporta um arquivo do Excel como um arquivo PDF para o local do caminho mencionado no parâmetro FilePath.

    Tabela 19. Parâmetros do método ExportToPDF
    Parâmetro Descrição Tipo de porta de dados Tipo de dados
    Caminho do arquivo Especifica o caminho do arquivo para o qual o arquivo PDF é exportado. Dados em Cadeia de caracteres

    FindeReplace

    Localiza o texto fornecido no parâmetro FindText em uma determinada planilha especificada pelo parâmetro SheetName e o substitui por outro texto fornecido no parâmetro Substituir Para.

    Tabela 20. Parâmetros do método FindAndReplace
    Parâmetro Descrição Tipo de porta de dados Tipo de dados
    SheetName Nome da planilha em que o texto será substituído. Dados em Cadeia de caracteres
    Texto de destino O texto pesquisado nas células da planilha. Dados em Cadeia de caracteres
    Substitua O texto desejado para substituir o texto encontrado usando o parâmetro FindText. Dados em Cadeia de caracteres
    Retornar Retorna o valor booliano que indica se o texto foi substituído. Se verdadeiro, o texto será substituído. Se Falso, o texto não será substituído. Saída de dados Booliano

    GetActiveSheetName

    Retorna o nome da planilha ativa.

    Tabela 21. Parâmetros do método GetActiveSheetName
    Parâmetro Descrição Tipo de porta de dados Tipo de dados
    Retornar Retorna o nome da planilha ativa em um formato de cadeia de caracteres. Saída de dados Cadeia de caracteres

    ObterIfRowHas de EndereçoCellHas

    Pesquisa um determinado texto na planilha especificada. Ele verifica o nome da coluna especificado, começando no índice de linha indicado. Se o texto for encontrado, ele retornará verdadeiro. Caso contrário, retorna falso. Além disso, o endereço da célula correspondente pode ser armazenado no valor configurado.

    Nota:
    Execute o método Aberto antes de executar este método.
    Tabela 22. Parâmetros do método GetCellAddressIfRow
    Parâmetro Descrição Tipo de porta de dados Tipo de dados
    SheetName Nome da planilha a ser pesquisada. Dados em Cadeia de caracteres
    SearchText O texto a ser pesquisado na coluna especificada. Dados em Cadeia de caracteres
    Coluna de pesquisa A coluna em que a pesquisa será realizada.

    ColumnName é um tipo de dados Enum que representa colunas do Excel de Um a AZ.

    		 Dados em ColumnName
    StartRow Index O índice de linha a partir do qual a pesquisa começará. Dados em Inteiro
    Retornar Retorna um valor booliano que indica se o SearchText foi encontrado. Se verdadeiro, o texto será encontrado. Se Falso, o texto não será encontrado. Saída de dados Booliano

    GetCellFormula

    Recupera a fórmula da célula de uma planilha.

    Nota:
    Execute o método Aberto antes de executar este método.
    Tabela 23. Parâmetros do método GetCellFormula
    Parâmetro Descrição Tipo de porta de dados Tipo de dados
    SheetName Nome da planilha da qual recuperar a fórmula da célula. Dados em Cadeia de caracteres
    CellName Especifica o nome ou a referência da célula da qual recuperar a fórmula. Dados em Cadeia de caracteres
    Retornar Retorna a fórmula de célula especificada em um formato de cadeia de caracteres. Saída de dados Cadeia de caracteres

    GetCellValue

    Recupera o valor de uma célula de uma planilha especificada pelo parâmetro CellName.

    Nota:
    Execute o método Aberto antes de executar este método.
    Tabela 24. Parâmetros do método GetCellValue
    Parâmetro Descrição Tipo de porta de dados Tipo de dados
    SheetName Nome da planilha da qual o valor da célula será recuperado. Dados em Cadeia de caracteres
    CellName Retorna o valor da célula ou o texto de exibição com base na configuração definida em GetCellValue. Dados em Cadeia de caracteres
    Retornar Retorna o valor em uma célula especificada no formato de cadeia de caracteres. Saída de dados Cadeia de caracteres

    ObterCellValueIfRowHas

    Pesquisa um determinado texto na planilha especificada. Ele verifica a coluna especificada, começando no índice de linha indicado. Se o texto for encontrado, ele retornará verdadeiro. Caso contrário, retorna falso. Além disso, o valor da célula correspondente pode ser armazenado no valor configurado.

    Nota:
    Execute o método Aberto antes de executar este método.
    Tabela 25. Parâmetros do método GetCellAddressIfRow
    Parâmetro Descrição Tipo de porta de dados Tipo de dados
    SheetName Nome da planilha a ser pesquisada. Dados em Cadeia de caracteres
    SearchText O texto a ser pesquisado na coluna especificada. Dados em Cadeia de caracteres
    Coluna de pesquisa A coluna em que a pesquisa é realizada.

    ColumnName é um tipo de dados Enum que representa colunas do Excel de Um a AZ.

    		 Dados em ColumnName
    StartRow Index O índice de linha a partir do qual a pesquisa começa. Dados em Inteiro
    Retornar Retorna um valor booliano que indica se o SearchText foi encontrado. Se verdadeiro, o texto será encontrado. Se Falso, o texto não será encontrado. Saída de dados Booliano

    GetCellValues

    Retorna os valores das células de uma planilha.

    Nota:
    Execute o método Aberto antes de executar este método.
    Tabela 26. Parâmetros do método GetCellValues
    Parâmetro Descrição Tipo de porta de dados Tipo de dados
    SheetName Nome da planilha que contém os dados de origem. Dados em Cadeia de caracteres

    ObtColor

    Retorna o valor RGB de uma célula especificada no parâmetro CellName de uma planilha.

    Nota:
    Execute o método Aberto antes de executar este método.
    Tabela 27. Parâmetros do método GetColor
    Parâmetro Descrição Tipo de porta de dados Tipo de dados
    SheetName Nome da planilha da qual recuperar a cor da célula. Dados em Cadeia de caracteres
    CellName Nome ou referência da célula da qual recuperar a cor. Dados em Cadeia de caracteres
    Retornar Retorna a cor da célula especificada no formato de cadeia de caracteres. Saída de dados Cadeia de caracteres

    GetColumnNameByIndex

    Retorna o nome da coluna correspondente ao número da coluna fornecido, em que, por exemplo, 1 corresponde a "A".

    Nota:
    Execute o método Aberto antes de executar este método.
    Tabela 28. Parâmetros do método GetColumnNameByIndex
    Parâmetro Descrição Tipo de porta de dados Tipo de dados
    ColumnNumber O número da coluna da qual você deseja recuperar o nome. Dados em Inteiro
    Retornar Retorna o nome da coluna no formato de cadeia de caracteres. Saída de dados Cadeia de caracteres

    ObteFilterData

    Retorna dados filtrados de uma planilha com base nos critérios de filtro especificados. Os dados são obtidos a partir do número de linha fornecido no parâmetro rowNumber.

    Nota:
    Execute o método Aberto antes de executar este método.
    Tabela 29. Parâmetros do método GetFilterData
    Parâmetro Descrição Tipo de porta de dados Tipo de dados
    SheetName Nome da planilha que contém os dados de origem. Dados em Cadeia de caracteres
    Row Number O número da linha que é a linha inicial para a extração de dados. Dados em Inteiro
    FirstRow AsHeader Determina se a primeira linha dos dados filtrados deve ser tratada como linha de cabeçalho. Se definido como verdadeiro, a primeira linha será considerada como linha de cabeçalho e não incluída nas linhas de dados extraídas. Se definido como falso, a primeira linha será incluída como parte das linhas de dados extraídos. Dados em Booliano
    Retornar Retorna os dados filtrados em um formato de tabela. As operações podem ser realizadas nas linhas e colunas desta tabela. Saída de dados Tabela de dados

    GetFilteredDataAddress

    Retorna o endereço dos dados filtrados na planilha fornecida no parâmetro SheetName.

    Nota:
    Execute o método Aberto antes de executar este método.
    Tabela 30. Parâmetros do método RowsCount
    Parâmetro Descrição Tipo de porta de dados Tipo de dados
    SheetName Nome da planilha da qual recuperar o endereço dos dados filtrados. Dados em Cadeia de caracteres
    Retornar Retorna uma lista ou coleção de cadeias de caracteres em que as cadeias de caracteres são endereços de dados filtrados. Saída de dados Lista (de cadeia de caracteres)

    GetRow Values

    Retorna valores de célula do parâmetro SheetName especificado do qual extrair os valores. Por padrão, se rowNumber não for especificado (ou definido como -1), ele lerá os valores da última linha. Além disso, você pode incluir parâmetros de saída para adicionar nomes de coluna e armazenar seus valores na saída.

    Nota:
    Execute o método Aberto antes de executar este método.
    Tabela 31. Parâmetros do método GetRow Values
    Parâmetro Descrição Tipo de porta de dados Tipo de dados
    SheetName Especifica o nome da planilha da qual recuperar os valores. Dados em Cadeia de caracteres
    Row Number A linha da qual ler os valores. Se definido como -1, o padrão será a última linha. Dados em Inteiro

    GetSelectedRange

    Retorna o intervalo de células selecionado no momento da planilha especificada no parâmetro SheetName. Os dados são extraídos das áreas específicas da planilha que foram realçadas ou escolhidas.

    Nota:
    Execute o método Aberto antes de executar este método.
    Tabela 32. Parâmetros do método GetSelectedRange
    Parâmetro Descrição Tipo de porta de dados Tipo de dados
    SheetName Nome da planilha que contém os dados de origem. Dados em Cadeia de caracteres
    Retornar Retorna o intervalo de células selecionadas em uma planilha no formato de cadeia de caracteres. Saída de dados Cadeia de caracteres

    GetSheetNames

    Retorna uma lista de todos os nomes de planilhas presentes em um arquivo do Excel.

    Nota:
    Execute o método Aberto antes de executar este método.
    Tabela 33. Parâmetros do método GetSheetNames
    Parâmetro Descrição Tipo de porta de dados Tipo de dados
    Retornar Retorna todos os nomes de planilha disponíveis em um formato de matriz de cadeia de caracteres. Saída de dados Cadeia de caracteres[]

    GetUsedRange

    Retorna o intervalo de células usadas da planilha especificada.

    Nota:
    Execute o método Aberto antes de executar este método.
    Tabela 34. Parâmetros do método GetUsedRange
    Parâmetro Descrição Tipo de porta de dados Tipo de dados
    SheetName Nome da planilha a partir da qual ler o intervalo. Dados em Cadeia de caracteres
    IncludeCabeçalhos Indica se os cabeçalhos devem ser incluídos. Dados em Booliano
    Retornar Retorna o intervalo de células usadas no formato de cadeia de caracteres. Saída de dados Cadeia de caracteres

    ObterValoresPorcoluna

    Retorna uma lista de valores de um ColumnName especificado no SheetName fornecido com base nos critérios de parâmetros Distinct, FirstRow AsHeader e ValueType.

    Nota:
    Execute o método Aberto antes de executar este método.
    Tabela 35. Parâmetros do método GetValuesByColumn
    Parâmetro Descrição Tipo de porta de dados Tipo de dados
    SheetName Nome da planilha que contém os dados de origem. Dados em Cadeia de caracteres
    ColumnName Denota o nome da coluna da qual os valores são recuperados.

    ColumnName é um tipo de dados Enum que representa colunas do Excel de Um a AZ.

    		 Dados em ColumnName
    FirstRow AsHeader Indica se a primeira linha na coluna especificada contém cabeçalhos. Dados em Booliano
    Distinto Especifica se os valores recuperados devem ser distintos ou exclusivos. Dados em Booliano
    ValueType Extrai valores com base na visibilidade. Dados em ValorT
    Retornar Retorna o número de linhas. Saída de dados Inteiro

    NewColunn InsertNewColumn

    Insere uma nova coluna no índice fornecido no parâmetro ColumnNumber na planilha especificada.

    Tabela 36. Parâmetros do método InsertNewColumn
    Parâmetro Descrição Tipo de porta de dados Tipo de dados
    SheetName Nome da planilha em que a coluna deve ser inserida. Dados em Cadeia de caracteres
    ColumnIndex Especifica o índice da coluna em que a nova coluna é inserida. Por exemplo, 1 é A, 2 é B e assim por diante. Dados em Inteiro

    InsertNewRow

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

    Tabela 37. Parâmetros do método InsertNewRow
    Parâmetro Descrição Tipo de porta de dados Tipo de dados
    SheetName Nome da planilha em que a linha será inserida. Dados em Cadeia de caracteres
    Índice de linha Índice da linha. A linha será inserida no índice especificado. Dados em Inteiro
    Retornar Retorna o valor booliano que indica se uma linha foi inserida. Se verdadeiro, a linha será inserida. Se Falso, a linha não será inserida. Saída de dados Booliano

    InsertObject

    Insere um objeto incorporado em uma célula identificada pelo valor de índice no parâmetro CellName na planilha especificada. O caminho para esse objeto incorporado é fornecido no parâmetro FilePath. Um exemplo de objeto pode ser um arquivo do excel, uma imagem ou um arquivo PDF.
    Nota:
    Execute o método Aberto antes de executar este método.
    Tabela 38. Parâmetros do método InsertObject
    Parâmetro Descrição Tipo de porta de dados Tipo de dados
    SheetName Nome da planilha em que o método insere o objeto. Dados em Cadeia de caracteres
    CellName Nome da célula em que o método insere o objeto. Por exemplo, A1. Dados em Cadeia de caracteres
    Caminho do arquivo Caminho do arquivo do objeto que o método insere. Dados em Cadeia de caracteres

    EstAberto

    Verifica se um Microsoft Excel Pasta de trabalho ou arquivo no local fornecido no parâmetro Caminho do arquivo está aberto ou não.

    Tabela 39. Parâmetros do método IsOpen
    Parâmetro Descrição Tipo de porta de dados Tipo de dados
    Caminho do arquivo Caminho para o arquivo do Excel na unidade local. Dados em Cadeia de caracteres
    Retornar Retorna o valor booliano que indica se o arquivo do Excel está aberto. Se verdadeiro, o arquivo do Excel estará aberto. Se Falso, o arquivo do Excel não está aberto. Saída de dados Booliano

    MergeCells

    Mescla as células especificadas no intervalo na planilha especificada.

    Tabela 40. Parâmetros do método MergeCells
    Parâmetro Descrição Tipo de porta de dados Tipo de dados
    Sheetname Nome da planilha na qual as células serão mescladas. Dados em Cadeia de caracteres
    CellRange Intervalo de células. Todas as células no intervalo são mescladas. Dados em Cadeia de caracteres

    ReadFromRange

    Recupera dados de uma planilha especificada e os retorna. Você precisa fornecer o nome da planilha para indicar de qual planilha extrair o intervalo de células, especificar o intervalo de células para determinar o intervalo de células a ser lido e indicar se a primeira linha é um cabeçalho no parâmetro FirstRow AsHeader.

    Tabela 41. Parâmetros do método ReadFromRange
    Parâmetro Descrição Tipo de porta de dados Tipo de dados
    SheetName Nome da planilha de onde o método lê os dados. Dados em Cadeia de caracteres
    CellRange Intervalo de células. O método lê dados dessas células. Dados em Cadeia de caracteres
    FirstRow AsHeader Valor booliano que indica se o método trata a primeira linha como o cabeçalho. Se verdadeiro, a primeira linha será tratada como um cabeçalho. Se Falso, a primeira linha não será tratada como um cabeçalho. Dados em Booliano
    Retornar Retorna a tabela de dados que compreende os dados das células. Saída de dados Tabela de dados

    ReadFromSheet

    Extrai dados de uma planilha e os converte em um formato estruturado, como uma tabela de dados.

    Tabela 42. Parâmetros do método ReadFromSheet
    Parâmetro Descrição Tipo de porta de dados Tipo de dados
    Sheetname Nome da planilha da qual o método lê os dados. Dados em Cadeia de caracteres
    Retornar Retorna todos os dados na planilha especificada. Saída de dados DataTable

    RenameSheetName

    Renomeia uma planilha existente.

    Tabela 43. Parâmetros do método RenameSheetName
    Parâmetro Descrição Tipo de porta de dados Tipo de dados
    OldSheetName O nome existente da planilha. Dados em Cadeia de caracteres
    NewSheetName O novo nome da planilha. Dados em Cadeia de caracteres
    Retornar Retorna a resposta booliana que indica se a planilha foi renomeada. Se verdadeiro, a planilha será renomeada. Se Falso, a planilha não será renomeada. Saída de dados Booliano

    RowsCount

    Retorna a contagem de linhas na planilha especificada.

    Tabela 44. Parâmetros do método RowsCount
    Parâmetro Descrição Tipo de porta de dados Tipo de dados
    SheetName Nome da planilha da qual a contagem de linhas é retornada. Dados em Cadeia de caracteres
    Retornar Retorna o número de linhas. Saída de dados Inteiro

    ExecutarMacro

    Executa uma macro existente no arquivo do Excel. O método requer o nome da macro que o usuário pretende executar.

    Tabela 45. Parâmetros do método RunMacro
    Parâmetro Descrição Tipo de porta de dados Tipo de dados
    MacroName O nome da macro a ser executada. Dados em Cadeia de caracteres
    Retornar Retorna um valor booliano que indica se a macro foi executada com sucesso ou não. Saída de dados Booliano

    Redimensionar

    Altera as dimensões de largura e altura da janela da aplicação Excel. O layout e a aparência da aplicação Excel podem ser personalizados para acomodar requisitos de exibição específicos.

    Tabela 46. Parâmetros do método RowsCount
    Parâmetro Descrição Tipo de porta de dados Tipo de dados
    Esquerda Este parâmetro especifica a posição horizontal do canto superior esquerdo da janela da aplicação Excel em relação à borda esquerda da tela. Define a distância, em pixels ou pontos, da borda esquerda da tela até a borda esquerda da janela do Excel. Dados em Inteiro
    Superior Este parâmetro indica a posição vertical do canto superior esquerdo da janela da aplicação Excel em relação à borda superior da tela. Define a distância, em pixels ou pontos, da borda superior da tela até a borda superior da janela do Excel. Dados em Inteiro
    Largura Este parâmetro especifica a largura da janela da aplicação do Excel em pixels ou pontos. Determina o tamanho horizontal da janela, estendendo-se da borda esquerda até a borda direita. Dados em Inteiro
    Altura Este parâmetro indica a altura da janela da aplicação Excel em pixels ou pontos. Define o tamanho vertical da janela, estendendo-se da borda superior até a borda inferior. Dados em Inteiro

    RemoveFiltro

    Remove filtros de uma planilha fornecida no parâmetro SheetName.

    Tabela 47. Parâmetros do método RemoveFilter
    Parâmetro Descrição Tipo de porta de dados Tipo de dados
    Sheetname Nome da planilha da qual o método remove os filtros. Dados em Cadeia de caracteres

    Salvar

    Salva todas as atualizações, mudanças, adições ou exclusões feitas nos dados ou formatação em um Microsoft Excel Documento para garantir que o trabalho seja preservado e que o arquivo do Excel reflita as atualizações mais recentes.

    Salvar como

    Salva um arquivo do Excel com um nome ou formato diferente em um caminho de arquivo fornecido no parâmetro Caminho do arquivo. O arquivo também pode ser protegido por senha fornecendo o valor no parâmetro Senha.

    Tabela 48. Parâmetros do método Salvar como
    Parâmetro Descrição Tipo de porta de dados Tipo de dados
    Caminho do arquivo O caminho do arquivo em que o arquivo do Excel é salvo com um nome ou formato diferente. Dados em Cadeia de caracteres
    Senha Senha para proteger o arquivo do Excel que será salvo. Este parâmetro é opcional e tem um valor padrão de uma cadeia de caracteres vazia. Dados em Cadeia de caracteres

    Salvar copyAs

    Salva uma cópia do arquivo do Excel em um caminho especificado que serve como destino para a cópia salva.

    Tabela 49. Parâmetros do método SaveCopyAs
    Parâmetro Descrição Tipo de porta de dados Tipo de dados
    Caminho do arquivo O caminho do arquivo em que o arquivo do Excel é salvo com um nome ou formato diferente. Dados em Cadeia de caracteres
    Senha Senha para proteger o arquivo do Excel salvo. Este parâmetro é opcional e tem um valor padrão de uma cadeia de caracteres vazia. Dados em Cadeia de caracteres

    Selecionintervalo

    Especifica e destaca um intervalo de células em uma planilha do Excel.

    Tabela 50. Parâmetros do método SelectRange
    Parâmetro Descrição Tipo de porta de dados Tipo de dados
    SheetName Nome da planilha que contém os dados de origem. Dados em Cadeia de caracteres
    CellRange O intervalo de células selecionadas na planilha especificada. Ele define o grupo de células, normalmente identificado pelas referências de célula inicial e final, que serão realçadas ou ativadas. Dados em Cadeia de caracteres

    SelecionroByIndex

    Seleciona a linha inteira com base no índice fornecido no parâmetro rowNumber na planilha.

    Tabela 51. Parâmetros do método SelectRow ByIndex
    Parâmetro Descrição Tipo de porta de dados Tipo de dados
    SheetName Nome da planilha em que a linha está selecionada. Dados em Cadeia de caracteres
    Row Number O índice da linha a ser selecionada. Dados em Inteiro

    SetActiveWorksheet

    Marca a planilha especificada no Sheetname como a planilha ativa.

    Tabela 52. Parâmetros do método SetActiveWorksheet
    Parâmetro Descrição Tipo de porta de dados Tipo de dados
    SheetName Nome da planilha que precisa ser definida como ativa. Dados em Cadeia de caracteres
    Retornar Retorna o valor booliano que indica se a planilha fornecida foi definida como ativa ou não. Saída de dados Booliano

    Definir Alinhamento

    Ajusta as configurações de alinhamento das células fornecidas no CellRange para controlar a apresentação e a aparência dos dados na planilha do Excel e aprimorar o apelo visual e a legibilidade dos dados da planilha, melhorando a apresentação de dados e a comunicação.

    Tabela 53. SetParâmetros do método Alignment
    Parâmetro Descrição Tipo de porta de dados Tipo de dados
    SheetName Nome da planilha que contém os dados de origem. Dados em Cadeia de caracteres
    CellRange Intervalo de células ao qual as configurações ou propriedades de alinhamento são aplicadas. Dados em Cadeia de caracteres
    Alinhamento horizontal Alinhamento horizontal do conteúdo da célula dentro do intervalo especificado. Determina como o conteúdo (como texto ou números) é posicionado horizontalmente em cada célula. Os valores possíveis incluem esquerda, centro, direita, justificado ou distribuído. Dados em Alinhamento horizontal
    VerticalAlignment Alinhamento vertical do conteúdo da célula dentro do intervalo especificado. Determina como o conteúdo é posicionado em cada célula verticalmente. Os valores possíveis incluem superior, meio, inferior ou justificado. Dados em VerticalAlignment

    SetCellColor

    Define uma cor fornecida no parâmetro Cor em uma célula específica especificada no parâmetro CellName em uma planilha.

    Tabela 54. Parâmetros do método SetCellColor
    Parâmetro Descrição Tipo de porta de dados Tipo de dados
    SheetName Nome da planilha onde a célula está localizada. Dados em Cadeia de caracteres
    CellName Indica o nome ou referência da célula para a qual a cor será definida. Dados em Cadeia de caracteres
    Cor Especifica o valor da cor RGB a ser aplicado à célula. Dados em ExcelRgbColor
    Retornar Retorna um valor booliano que indica se a fórmula está definida para uma célula específica fornecida. Saída de dados Booliano

    SetCellFormula

    Atribui uma fórmula a uma célula especificada no arquivo do Excel. Este método requer os parâmetros SheetName, CellName e Fórmula para determinar a planilha, a célula e a fórmula a serem definidas, respectivamente.

    Tabela 55. Parâmetros do método SetCellFormula
    Parâmetro Descrição Tipo de porta de dados Tipo de dados
    SheetName Nome da planilha em que a ação será executada. Dados em Cadeia de caracteres
    CellName A célula na planilha em que a operação ocorrerá. Dados em Cadeia de caracteres
    Fórmula A expressão matemática ou lógica a ser aplicada à célula especificada. Dados em Cadeia de caracteres
    Retornar Retorna um valor booliano que indica se a fórmula está definida para a célula especificada. Saída de dados Booliano

    SetCellValue

    Atribui um valor a uma célula específica em uma planilha, substituindo qualquer conteúdo existente nessa célula.

    Tabela 56. Parâmetros do método SetCellValue
    Parâmetro Descrição Tipo de porta de dados Tipo de dados
    SheetName Nome da planilha que contém os dados de origem. Dados em Cadeia de caracteres
    CellName Este parâmetro indica a referência ou o identificador da célula de destino na planilha especificada. Ele pode ser representado pelo endereço da célula (por exemplo, "A1", "B2", "C3"). Dados em Cadeia de caracteres
    Valor Valor que será atribuído à célula especificada, que pode ser de qualquer tipo de dados compatível com o Excel, incluindo números, texto, datas, fórmulas, ou valores lógicos. Dados em Cadeia de caracteres

    SetCellValues

    Define valores em várias células, conforme configurado na caixa de diálogo do editor de método em uma planilha especificada.

    Tabela 57. Parâmetros do método SetCellValues
    Parâmetro Descrição Tipo de porta de dados Tipo de dados
    SheetName Nome da planilha em que os valores da célula serão definidos. Dados em Cadeia de caracteres

    SetCellValuesIfRow Has

    Verifica a planilha especificada em busca de um texto fornecido, examinando o nome da coluna designada do índice de linha indicado. Se o texto for encontrado, ele definirá o valor da célula especificada com os valores fornecidos. Retorna verdadeiro se o valor foi definido com sucesso, caso contrário, falso.

    Tabela 58. Parâmetros do método SetCellValuesIfRow Has
    Parâmetro Descrição Tipo de porta de dados Tipo de dados
    SheetName Nome da planilha a ser pesquisada. Dados em Cadeia de caracteres
    SearchText O texto a ser pesquisado na coluna especificada. Dados em Cadeia de caracteres
    Coluna de pesquisa A coluna em que a pesquisa é realizada.

    ColumnName é um tipo de dados Enum que representa colunas do Excel de Um a AZ.

    		 Dados em ColumnName
    StartRow Index O índice de linha a partir do qual a pesquisa começa. Dados em Inteiro
    Retornar Retorna verdadeiro se SearchText for encontrado na coluna especificada. Caso contrário, retorna Falso. Saída de dados Booliano

    SetColumnType

    Modifique o tipo de dados de uma coluna especificada em uma planilha. Por exemplo, os usuários podem converter uma coluna que contém valores numéricos em um formato de texto ou mudar uma coluna de dados de texto para o formato numérico. É possível ajustar o formato dos dados para melhor atender às necessidades de análise ou emissão de relatórios, garantindo consistência e precisão na representação dos dados. Útil para tarefas como conversão, formatação e manipulação de dados no Excel.

    Tabela 59. Parâmetros do método SetColumnType
    Parâmetro Descrição Tipo de porta de dados Tipo de dados
    SheetName Nome da planilha que contém os dados de origem. Dados em Cadeia de caracteres
    Formattype O tipo de formato desejado para o qual a coluna é convertida. Este parâmetro determina como os dados na coluna são interpretados ou exibidos. Os valores possíveis podem incluir numérico, texto, data, hora, moeda, formatos personalizados ou percentuais. Dados em Cadeia de caracteres
    Coluna A referência de coluna ou identificador na planilha especificada para a qual o tipo de dados é alterado. Ele pode ser representado pela letra da coluna (por exemplo, "A", "B", "C"). Dados em Cadeia de caracteres
    Retornar Retorna um valor booliano que identifica se o tipo de coluna foi definido ou não. Saída de dados Booliano

    SetColumnWidth

    Define a largura de todas as colunas fornecidas no parâmetro de largura.

    Tabela 60. Parâmetros do método SetColumnWidth
    Parâmetro Descrição Tipo de porta de dados Tipo de dados
    SheetName Nome da planilha em que a largura da coluna é ajustada. Dados em Cadeia de caracteres
    Largura A largura em caracteres para a qual a coluna está definida.

    Somente o valor inteiro é aceito. Valores decimais não são aceitos.

    		 Dados em Inteiro
    Retornar Retorna um valor booliano que identifica se o tipo de coluna foi definido ou não. Saída de dados Booliano

    SetFilter

    Aplica um filtro a uma coluna específica. Este método encontra a planilha com base no nome da planilha fornecido e aplica o valor de filtro fornecido.

    Tabela 61. Parâmetros do método SetFilter
    Parâmetro Descrição Tipo de porta de dados Tipo de dados
    SheetName Nome da planilha onde a coluna está localizada. Dados em Cadeia de caracteres
    ColumnName Coluna em que o filtro é aplicado.

    ColumnName é um tipo de dados Enum que representa colunas do Excel de Um a AZ.

    		 Dados em ColumnName
    FilterValue O valor a ser filtrado na coluna identificada. Dados em Cadeia de caracteres

    SetFilterByRow

    Aplica um filtro a uma coluna especificada, começando a partir de um determinado número de linha. Este método encontra a planilha com base no nome da planilha fornecido e aplica o valor de filtro fornecido.

    Tabela 62. Parâmetros do método SetFilterByRow
    Parâmetro Descrição Tipo de porta de dados Tipo de dados
    SheetName Nome da planilha que contém os dados de origem. Dados em Cadeia de caracteres
    Row Number Indica o número da linha na planilha especificada em que os critérios de filtragem estão definidos. Identifica a linha que contém os critérios que serão usados para filtrar os dados. Dados em Inteiro
    ColumnName Nome ou identificador da coluna com base na qual a filtragem será realizada. Representa a coluna à qual os critérios de filtragem se aplicam.

    ColumnName é um tipo de dados Enum que representa colunas do Excel de Um a AZ.

    ColumnName fornecido refere-se ao nome da coluna relativa à coluna inicial dos seus dados. Por exemplo, se os dados começarem na coluna B na planilha do Excel, o índice de coluna relativo A corresponderá à coluna B, o índice de coluna relativo B corresponderá à coluna C e assim por diante.

    		 Dados em ColumnName
    FilterValue Valor ou condição usada como critérios de filtro. Representa o valor específico ao qual os dados na coluna designada devem corresponder para serem exibidos depois que o filtro é aplicado. Dados em Cadeia de caracteres

    SetFontStyle

    Formata as células em um intervalo especificado definindo parâmetros como Cor, fontstyle, fontname, Negrito e Sublinhado.

    Tabela 63. Parâmetros do método SetFontStyle
    Parâmetro Descrição Tipo de porta de dados Tipo de dados
    SheetName Nome da planilha em que o estilo de fonte será definido. Dados em Cadeia de caracteres
    CellRange O intervalo de células para o qual o estilo de fonte será definido. Dados em Cadeia de caracteres
    Cor Especifica o valor de cor RGB da fonte. Dados em ExcelRgbColor
    FontSize Especifica o tamanho da fonte. O valor padrão é 11. Dados em Inteiro
    Nomefonte Especifica o nome da fonte. O valor padrão é Calibri. Dados em Cadeia de caracteres
    Negrito Indica se a fonte deve ficar em negrito. O valor padrão é Falso. Dados em Booliano
    Sublinhado Especifica o estilo de sublinhado da fonte. O valor padrão é Nenhum. Dados em Sublinhado

    ConfiguraçãoAltura

    Modifica a altura de uma linha específica em uma planilha do Excel.

    Tabela 64. Parâmetros do método SetRow Height
    Parâmetro Descrição Tipo de porta de dados Tipo de dados
    SheetName O nome da planilha onde as linhas estão localizadas. Dados em Cadeia de caracteres
    Altura Especifica a altura desejada. Dados em Inteiro
    StartIndex O índice da linha inicial. Dados em Cadeia de caracteres
    EndIndex O índice da linha final. Dados em Cadeia de caracteres
    Retornar Retorna um valor booliano que indica se a altura da linha foi definida com sucesso ou não. Saída de dados Booliano

    SetRow Values

    Define valores para uma linha específica em uma planilha do Excel. Por padrão, quando o parâmetro rowIndex é definido como -1, a função insere os valores no final da planilha. Se você não especificar um índice de linha específico, os valores serão anexados à parte inferior dos dados existentes na planilha.

    Tabela 65. Parâmetros do método SetRow Values
    Parâmetro Descrição Tipo de porta de dados Tipo de dados
    SheetName Nome da planilha que contém os dados de origem. Dados em Cadeia de caracteres
    Row Number Denota o número da linha em que os valores serão definidos ou atualizados. No Excel, as linhas são numeradas sequencialmente de cima para baixo, começando com 1. Ao especificar o rowNumber, você indica a linha específica em que os valores devem ser colocados. Se -1 for passado como o número de linha, isso normalmente indica que os valores serão inseridos no final da planilha. Dados em Inteiro

    Classificação

    Organiza os dados em um intervalo de células especificado em ordem crescente ou decrescente.

    Tabela 66. Parâmetros do método de classificação
    Parâmetro Descrição Tipo de porta de dados Tipo de dados
    SheetName Nome da planilha em que os dados serão classificados. Dados em Cadeia de caracteres
    CellRange O intervalo de células que contém os dados a serem classificados. Dados em Cadeia de caracteres
    ColumnName O nome da coluna pela qual os dados serão classificados.

    ColumnName é um tipo de dados Enum que representa colunas do Excel de Um a AZ.

    		 Dados em ColumnName
    ClassificaçãoOrdem A ordem de classificação (crescente ou decrescente) dos dados. Dados em ClassificaçãoOrdem

    VLookUp

    Pesquisa um valor específico na primeira coluna de um intervalo de células especificado e retorna um valor correspondente de uma coluna designada na mesma linha.

    Tabela 67. Parâmetros do método VLookUp
    Parâmetro Descrição Tipo de porta de dados Tipo de dados
    Sheetname Nome da planilha a ser pesquisada. Dados em Cadeia de caracteres
    SearchText O texto a ser pesquisado na coluna especificada. Dados em Cadeia de caracteres
    LookupRange Intervalo para verificar o texto. Dados em Cadeia de caracteres
    ApproximateMatch Este é um valor lógico que especifica se você deseja uma correspondência exata ou aproximada. Dados em Booliano
    Retornar Retorna um valor booliano que indica se a macro foi executada com sucesso ou não. Saída de dados Booliano

    WrapText

    Habilitar quebra de texto para todas as células em uma linha especificada em uma planilha do Excel. A quebra de texto garante que cadeias de caracteres de texto longas sejam exibidas dentro dos limites da célula, ajustando automaticamente a altura da linha para acomodar o texto encapsulado. Ao usar o método WrapText, os usuários podem melhorar a legibilidade de seus dados, garantindo que todo o texto esteja totalmente visível em cada célula, mesmo que ele se estenda além da largura original da célula. Isso pode ser particularmente útil para exibir entradas de texto longas ou conteúdo de várias linhas nas células da planilha.

    Tabela 68. Parâmetros do método WrapText
    Parâmetro Descrição Tipo de porta de dados Tipo de dados
    SheetName Nome da planilha que contém os dados de origem. Dados em Cadeia de caracteres
    Row Number O número da linha na planilha especificada em que a quebra de texto é definida para todas as células dessa linha. Dados em Inteiro

    WriteToRange

    Grava uma tabela de dados fornecida no parâmetro Dados em uma planilha a partir da célula fornecida no parâmetro CellName. Os cabeçalhos também podem ser incluídos definindo o parâmetro IncludeHeaders.

    Tabela 69. Parâmetros do método WriteToRange
    Parâmetro Descrição Tipo de porta de dados Tipo de dados
    SheetName Nome da planilha na qual os dados são gravados. Dados em Cadeia de caracteres
    CellName Nome da célula na qual os dados são gravados. Dados em Cadeia de caracteres
    Dados Dados gravados. Dados em Tabela de dados
    IncludeCabeçalhos Valor booliano que indica se cabeçalhos devem ser incluídos ao gravar os dados. O valor padrão é definido como verdadeiro. Dados em Booliano