Classe Workbooks (Excel VBA)

Uma coleção de todos os objetos Workbook que estão atualmente abertos no aplicativo Microsoft Excel. Para usar uma variável de classe Workbooks, ela primeiro precisa ser instanciada por exemplo


Dim wrks as Workbooks
Set wrks = Workbooks

For Each

Aqui está um exemplo de processamento dos itens Workbooks em uma coleção.


Dim wb As Workbook
For Each wb In Workbooks
	
Next wb

Add

Cria uma nova pasta de trabalho. A nova pasta de trabalho se transforma na pasta de trabalho ativa.

Quando o argumento Template especifica um arquivo, o nome do arquivo pode incluir um caminho.

Add (Template)

Template: Determina como a nova pasta de trabalho será criada. Se este argumento for uma cadeia de caracteres especificando o nome de um arquivo do Microsoft Excel existente, a nova pasta de trabalho será criada com o arquivo especificado como modelo. Se esse argumento for uma constante, a nova pasta de trabalho conterá uma única planilha do tipo especificado. Pode ser uma das seguintes constantes XlWBATemplate : xlWBATChart, xlWBATExcel4IntlMacroSheet, xlWBATExcel4MacroSheetou xlWBATWorksheet. Se esse argumento for omitido, o Microsoft Excel criará uma nova pasta de trabalho com várias planilhas em branco (o número de planilhas é definido pela propriedade SheetsInNewWorkbook ).


Dim wb As Workbook
Set wb = Workbooks.Add()

CanCheckOut

True se o Microsoft Excel puder fazer check out de uma pasta de trabalho especificada em um servidor. Boolean de leitura/gravação.

CanCheckOut (Filename)

Filename: O nome do arquivo para ser retirado.


Dim strFilename As String: strFilename = 
Dim booCanCheckOut As Boolean
booCanCheckOut = Workbooks.CanCheckOut(Filename:=strFilename)

CheckOut

Retorna um String representando uma pasta de trabalho especificada de um servidor para um computador local para edição.

CheckOut (Filename)

Filename: O nome do arquivo para ser retirado.


Dim strFilename As String: strFilename = 
Workbooks.CheckOut Filename:=strFilename

Close

Fecha o objeto.

Fechar uma pasta de trabalho do Visual Basic não executa macros Auto_Close na pasta de trabalho. Use o método RunAutoMacros para executar as macros de fechamento automático.


Workbooks.Close

Count

Retorna um valor Long que representa o número de objetos na coleção.


Dim lngCount As Long
lngCount = Workbooks.Count

Item

Retorna um único objeto de uma coleção.

Item (Index)

Index: O nome ou número de índice do objeto.


Dim wbItem As Workbook
Set wbItem = Workbooks(Index:=1)

Open

Abre uma pasta de trabalho.

Por padrão, as macros são ativadas quando os arquivos são abertos por programação. Use a propriedade AutomationSecurity para definir o modo de segurança de macro usado ao abrir arquivos por programação. Você pode especificar um dos seguintes valores no parâmetro UpdateLinks para determinar se as referências externas (links) serão atualizadas quando a pasta de trabalho for aberta.

Open (Filename, UpdateLinks, ReadOnly, Format, Password, WriteResPassword, IgnoreReadOnlyRecommended, Origin, Delimiter, Editable, Notify, Converter, AddToMru, Local, CorruptLoad)


Dim strFilename As String: strFilename = 
Dim wb As Workbook
Set wb = Workbooks.Open(Filename:=strFilename)

Arguments

O seguinte argumento é necessário

Filename (String) - O nome de arquivo da pasta de trabalho a ser aberta.

Optional arguments

Os seguintes argumentos são opcionais

UpdateLinks - Especifica a maneira como as referências externas (links) no arquivo, como a referência a um intervalo na pasta de trabalho Orcament. xls na fórmula =SUM([Budget.xls]Annual!C10:C25)a seguir, são atualizadas. Se esse argumento for omitido, será solicitado que o usuário especifique como os links serão atualizados. Para saber mais sobre os valores usados por este parâmetro, veja a seção Comentários. Se o Microsoft Excel estiver abrindo um arquivo no formato WKS, WK1 ou WK3 e o argumento UpdateLinks for 0, nenhum gráfico será criado; caso contrário, o Microsoft Excel gera gráficos dos gráficos anexados ao arquivo

ReadOnly (Boolean) - Verdadeiro para abrir a pasta de trabalho em modo somente leitura.

Format (String) - Se o Microsoft Excel abrir um arquivo de texto, esse argumento especificará o caractere delimitador. Se esse argumento for omitido, o delimitador atual será usado. Para saber mais sobre os valores usados por esse parâmetro, veja a seção Comentários.

Password (String) - Uma cadeia de caracteres que contém a senha necessária para abrir uma pasta de trabalho protegida. Se esse argumento for omitido e a pasta de trabalho exigir uma senha, será solicitada a senha do usuário.

WriteResPassword - Uma cadeia de caracteres que contém a senha necessária para gravar uma pasta de trabalho reservada para gravação. Se esse argumento for omitido e se a pasta de trabalho exigir uma senha, a senha será solicitada do usuário

IgnoreReadOnlyRecommended (Boolean) - True para fazer com que o Microsoft Excel não exiba a mensagem recomendada somente leitura (se a pasta de trabalho tiver sido salva com a opção Somente Leitura Recomendada).

Origin (XlPlatform) - Se o arquivo for um arquivo de texto, esse argumento indicará onde foi originado, de forma que as páginas de código e o Retorno de Carro/Alimentação de Linha (CR/LF) possam ser mapeadas corretamente. Pode ser uma das seguintes constantes XlPlatform : xlMacintosh, xlWindowsou xlMSDOS. Se esse argumento for omitido, o sistema operacional atual será usado.

Os valores de retorno possíveis são xlMacintosh - Estes, xlMSDOS - Tais, xlWindows - Microsoft WindowsMicrosoft Windows.

Delimiter (String) - Se o arquivo for um arquivo de texto e o argumento Format for 6, este argumento será uma cadeia de caracteres que especifica o caractere a ser usado como o delimitador. Por exemplo, use Chr(9) para tabulações, use "," para vírgulas, use ";" para ponto-e-vírgulas ou use um caractere personalizado. Somente o primeiro caractere da cadeia de caracteres será usado.

Editable (Boolean) - Se o arquivo for um suplemento do Microsoft Excel 4.0, esse argumento será True para abrir o suplemento, de forma que seja uma janela visível. Se esse argumento for False ou se for omitido, o suplemento será aberto como oculto e não poderá ser reexibido. Essa opção não se aplica a suplementos criados no Microsoft Excel 5.0 ou posterior. Se o arquivo for um modelo do Excel, True para abrir o modelo especificado para edição. False para abrir uma nova pasta de trabalho com base no modelo especificado. O valor padrão é False.

Notify (Boolean) - Se o arquivo não puder ser aberto em modo leitura/gravação, esse argumento será True para adicionar o arquivo para a lista de notificações de arquivo. O Microsoft Excel abrirá o arquivo como somente leitura, pesquisará a lista de notificações de arquivo e então notificará o usuário quando o arquivo for disponibilizado. Se esse argumento for False ou se for omitido, nenhuma notificação será solicitada e todas as tentativas de abrir um arquivo não disponível falharão.

Converter - O índice do primeiro conversor de arquivos a ser experimentado na abertura do arquivo. O conversor do arquivo especificado será experimentado primeiro; se esse conversor não reconhecer o arquivo, todos os outros conversores serão experimentados. O índice do conversor consiste nos números de linha dos conversores retornados pela propriedade FileConverters

AddToMru (Boolean) - True para adicionar esta pasta de trabalho à lista de arquivos usados recentemente. O valor padrão é False.

Local - True salva os arquivos na linguagem do Microsoft Excel (incluindo as configurações do painel de controle). False (padrão) salva arquivos na linguagem do Visual Basic for Applications (VBA) (que normalmente é Inglês (Estados Unidos) a menos que o projeto VBA onde Workbooks.Open seja executado de um antigo projeto internacionalizado do VBA XL5/95)

CorruptLoad (XlCorruptLoad) - Pode ser uma das seguintes constantes: xlNormalLoad, xlRepairFile e xlExtractData. O comportamento padrão, se nenhum valor for especificado, é xlNormalLoad, e não tenta a recuperação quando iniciado pelo OM.

Os valores de retorno possíveis são xlExtractData - A pasta de trabalho está aberta no modo de extração de dados, xlNormalLoad - A pasta de trabalho está aberta normalmente, xlRepairFile - A pasta de trabalho está aberta no modo de reparo.

OpenDatabase

Retorna um objeto Workbook que representa um banco de dados.

OpenDatabase (Filename, CommandText, CommandType, BackgroundQuery, ImportDataAs)


Dim strFilename As String: strFilename = 
Dim wbOpenDatabase As Workbook
Set wbOpenDatabase = Workbooks.OpenDatabase(Filename:=strFilename)

Arguments

O seguinte argumento é necessário

Filename (String) - A cadeia de caracteres de conexão que contém o local e o nome do arquivo do banco de dados.

Optional arguments

Os seguintes argumentos são opcionais

CommandText (String) - O texto do comando da consulta.

CommandType (XlCmdType) - O tipo de comando da consulta. Especifique uma das constantes da enumeração XlCmdType : xlCmdCube, xlCmdList, xlCmdSql, xlCmdTablee xlCmdDefault.


Os valores possíveis são

xlCmdCube Contém um nome de cubo para uma fonte de dados OLAP.
xlCmdDAX Contém uma fórmula DAX (expressões de análise de dados).
xlCmdDefault Contém texto de comandos que o provedor OLE DB entende.
xlCmdExcel Contém uma fórmula do Excel.
xlCmdList Contém um ponteiro para listar dados.
xlCmdSql Contém uma instrução SQL.
xlCmdTable Contém um nome de tabela para acessar fontes de dados OLE DB.
xlCmdTableCollection Contém o nome de uma coleção de tabelas.

BackgroundQuery (Boolean) - Esse parâmetro é um tipo de dados Variant, mas você só pode passar um valor Boolean . Se passar True, a consulta será realizada no plano de fundo (de forma assíncrona). O valor padrão é False.

ImportDataAs (XlImportDataAs) - Esse parâmetro usa um dos valores da enumeração XlImportDataAs . Os dois valores dessa enumeração são xlPivotTableReport e xlQueryTable. Passe um desses valores para retornar os dados como uma tabela dinâmica ou um a tabela de consulta. valor padrão é xlQueryTable.

Os valores de retorno possíveis são xlPivotTableReport - Retorna os dados como uma tabela dinâmica, xlQueryTable - Retorna os dados como uma tabela de consulta, xlTable.

OpenText

Carrega e analisa um arquivo de texto como uma nova pasta de trabalho com uma única planilha contendo os dados do arquivo de texto analisados.

Parâmetro FieldInfo Você só poderá usar xlEMDFormat se tiver instalado e selecionado o suporte ao idioma taiwanês. A constante xlEMDFormat especifica que datas da era taiwanesa estão sendo usadas. Os especificadores de coluna podem estar em qualquer ordem. Se não houver um especificador de coluna para uma coluna em particular nos dados de entrada, a coluna será analisada com a configuração Geral. Este exemplo faz com que a terceira coluna seja analisada como MDA (por exemplo, 01/10/1970), a primeira coluna seja analisada como texto,e as colunas restantes nos dados de origem sejam analisadas com a configuração Geral.

OpenText (Filename, Origin, StartRow, DataType, TextQualifier, ConsecutiveDelimiter, Tab, Semicolon, Comma, Space, Other, OtherChar, FieldInfo, TextVisualLayout, DecimalSeparator, ThousandsSeparator, TrailingMinusNumbers, Local)


Dim strFilename As String: strFilename = 
Workbooks.OpenText Filename:=strFilename

Arguments

O seguinte argumento é necessário

Filename (String) - Especifica o nome do arquivo de texto a ser aberto ou analisado.

Optional arguments

Os seguintes argumentos são opcionais

Origin (XlPlatform) - Especifica a origem do arquivo de texto. Pode ser uma das seguintes constantes XlPlatform : xlMacintosh, xlWindowsou xlMSDOS. Adicionalmente, poderia ser um inteiro representando o número da página de código da página de código desejada. Por exemplo, "1256" especificaria que a codificação do arquivo de texto de origem é Árabe (Windows). Se esse argumento for omitido, o método usará a configuração atual da opção origem do arquivo no assistente de importação de texto.

Os valores de retorno possíveis são xlMacintosh - Estes, xlMSDOS - Tais, xlWindows - Microsoft WindowsMicrosoft Windows.

StartRow (Long) - O número da linha na qual o texto começa a ser analisado. O valor padrão é 1.

DataType (XlTextParsingType) - Especifica o formato da coluna dos dados no arquivo. Pode ser uma das seguintes constantes XlTextParsingType: xlDelimited ou xlFixedWidth. Se esse argumento não for especificado, o Microsoft Excel tentará determinar o formato da coluna quando abrir o arquivo.

Os valores de retorno possíveis são xlDelimited - Padrão. Indica que o arquivo é delimitado por caracteres delimitadores, xlFixedWidth - Indica que os dados no arquivo são organizados em colunas com largura fixa.

TextQualifier (XlTextQualifier) - Especifica o qualificador do texto.

Os valores de retorno possíveis são xlTextQualifierDoubleQuote - Aspas duplas ("), xlTextQualifierNone - Sem delimitador, xlTextQualifierSingleQuote - Aspas simples (').

ConsecutiveDelimiter (Boolean) - True para ter delimitadores consecutivos considerados como um delimitador. O padrão é False.

Tab (Tab) - True para que o caractere de tabulação seja o delimitador (DataType deve ser xlDelimited). O valor padrão é False.

Semicolon (XlTextParsingType) - True para que o caractere de ponto e vírgula seja o delimitador (DataType deve ser xlDelimited). O valor padrão é False.

Os valores de retorno possíveis são xlDelimited - Padrão. Indica que o arquivo é delimitado por caracteres delimitadores, xlFixedWidth - Indica que os dados no arquivo são organizados em colunas com largura fixa.

Comma (XlTextParsingType) - True para que o caractere de vírgula seja o delimitador (DataType deve ser xlDelimited). O valor padrão é False.

Os valores de retorno possíveis são xlDelimited - Padrão. Indica que o arquivo é delimitado por caracteres delimitadores, xlFixedWidth - Indica que os dados no arquivo são organizados em colunas com largura fixa.

Space (XlTextParsingType) - True para que o caractere de espaço seja o delimitador (DataType deve ser xlDelimited). O valor padrão é False.

Os valores de retorno possíveis são xlDelimited - Padrão. Indica que o arquivo é delimitado por caracteres delimitadores, xlFixedWidth - Indica que os dados no arquivo são organizados em colunas com largura fixa.

Other (XlTextParsingType) - True para que o caractere especificado pelo argumento OtherChar seja o delimitador (DataType deve ser xlDelimited). O valor padrão é False.

Os valores de retorno possíveis são xlDelimited - Padrão. Indica que o arquivo é delimitado por caracteres delimitadores, xlFixedWidth - Indica que os dados no arquivo são organizados em colunas com largura fixa.

OtherChar (String) - Obrigatório se outro for true. Especifica o caractere delimitador quando outro é verdadeiro. Se mais de um caractere for especificado, somente o primeiro caractere da cadeia de caracteres será usado; os caracteres restantes será ignorado.

FieldInfo (XlColumnDataType) - Uma matriz com informações de análise para colunas de dados individuais. A interpretação depende do valor de DataType. Quando os dados forem delimitados, esse argumento será uma matriz de matrizes de dois elementos, com cada matriz de dois elementos especificando as opções de conversão para uma coluna em particular. O primeiro elemento é o número da coluna (baseado em 1), e o segundo elemento é uma das constantes XlColumnDataType que especificam como a coluna é analisada.

Aqui você pode encontrar os valores possíveis para XlColumnDataType

TextVisualLayout - O layout visual do texto

DecimalSeparator (String) - O separador decimal que o Microsoft Excel usa ao reconhecer números. A configuração padrão é a configuração do sistema.

ThousandsSeparator (String) - O separador de milhares que o Excel usa ao reconhecer números. A configuração padrão é a configuração do sistema.

TrailingMinusNumbers (Boolean) - Especifique True se os números com um caractere de menos no final devem ser tratados como números negativos. Se for False ou se for omitido, os números com um caractere de menos no final serão tratados como texto.

Local (Boolean) - Especifique true se as configurações regionais do computador devem ser usadas para separadores, números e formatação de dados.

OpenXML

Abre um arquivo de dados XML. Retorna um objeto Workbook .

OpenXML (Filename, Stylesheets, LoadOption)


Dim strFilename As String: strFilename = 
Dim wbOpenXML As Workbook
Set wbOpenXML = Workbooks.OpenXML(Filename:=strFilename)

Arguments

O seguinte argumento é necessário

Filename (String) - O nome do arquivo a ser aberto.

Optional arguments

Os seguintes argumentos são opcionais

Stylesheets (String) - Um único valor ou uma matriz de valores que especifica quais instruções de processamento de folha de estilo XSLT (Transformação em XSL) devem ser aplicadas.

LoadOption (XlXmlLoadOption) - Especifica como o Excel abre o arquivo de dados XML. Pode ser uma das constantes XlXmlLoadOption .


Os valores possíveis são

xlXmlLoadImportToList Coloca o conteúdo do arquivo de dados XML em uma lista XML.
xlXmlLoadMapXml Exibe o esquema do arquivo de dados XML no painel de tarefas estrutura XML .
xlXmlLoadOpenXml Abre o arquivo de dados XML. O conteúdo do arquivo será simplificado.
xlXmlLoadPromptUser Solicita ao usuário que escolha como abrir o arquivo.