ExcelScript.Workbook interface

Referência

Pacote:: ExcelScript

A pasta de trabalho é o objeto de nível superior que contém objetos de pasta de trabalho relacionados, como planilhas, tabelas e intervalos.

Comentários

Exemplos

/**
 * This script adds a new worksheet to the workbook, then switches to it.
 */
function main(workbook: ExcelScript.Workbook) {
  // Add a new worksheet with the default name.
  let worksheet = workbook.addWorksheet();

  // Switch focus to the new worksheet.
  worksheet.activate();
}

Métodos

addBinding(range, bindingType, id)	Adiciona uma nova associação a um intervalo específico.
addBindingFromNamedItem(name, bindingType, id)	Adiciona uma nova associação com base em um item nomeado na pasta de trabalho. Se o item nomeado fizer referência a várias áreas, o `InvalidReference` erro será retornado.
addBindingFromSelection(bindingType, id)	Adiciona uma nova associação com base na seleção atual. Se a seleção tiver várias áreas, o `InvalidReference` erro será retornado.
addComment(cellAddress, content, contentType)	Cria um novo comentário com o conteúdo fornecido na célula especificada. Um `InvalidArgument` erro será gerado se o intervalo fornecido for maior que uma célula.
addCustomXmlPart(xml)	Adiciona uma nova parte XML personalizada à pasta de trabalho.
addNamedItem(name, reference, comment)	Adiciona um novo nome à coleção do escopo fornecido.
addNamedItemFormulaLocal(name, formula, comment)	Adiciona um novo nome à coleção de escopo fornecido usando a localidade do usuário para a fórmula.
addPivotTable(name, source, destination)	Adicione uma Tabela Dinâmica com base nos dados de origem especificados e insira-os na célula superior esquerda do intervalo de destino.
addPivotTableStyle(name, makeUniqueName)	Cria um em branco `PivotTableStyle` com o nome especificado.
addPredefinedCellStyle(name)	Adiciona um novo estilo para o conjunto.
addSlicer(slicerSource, sourceField, slicerDestination)	Adiciona uma nova segmentação de dados à pasta de trabalho.
addSlicerStyle(name, makeUniqueName)	Cria um estilo de segmentação em branco com o nome especificado.
addTable(address, hasHeaders)	Cria uma nova tabela. O objeto de intervalo ou endereço de origem determina a planilha à qual a tabela será adicionada. Se a tabela não puder ser adicionada (por exemplo, porque o endereço é inválido ou a tabela se sobreporia a outra), será gerado um erro.
addTableStyle(name, makeUniqueName)	Cria um em branco `TableStyle` com o nome especificado.
addTimelineStyle(name, makeUniqueName)	Cria um em branco `TimelineStyle` com o nome especificado.
addWorksheet(name)	Adiciona uma nova planilha à pasta de trabalho. A planilha será adicionada ao final das planilhas existentes. Se você quiser ativar a planilha recém-adicionada, chame-a `.activate()` .
breakAllLinksToLinkedWorkbooks()	Quebra todos os links para as pastas de trabalho vinculadas. Depois que os links são quebrados, todas as fórmulas que referenciam links de pasta de trabalho são totalmente removidas e substituídas pelos valores recuperados mais recentemente.
getActiveCell()	Obtém a célula ativa no momento da pasta de trabalho.
getActiveChart()	Obtém o gráfico ativo no momento na pasta de trabalho. Se não houver um gráfico ativo, esse método retornará `undefined`.
getActiveSlicer()	Obtém a segmentação de dados ativa no momento na pasta de trabalho. Se não houver uma segmentação ativa, esse método retornará `undefined`.
getActiveWorksheet()	Obtém a planilha ativa no momento na pasta de trabalho.
getApplication()	Representa a instância de aplicativo do Excel que contém essa pasta de trabalho.
getAutoSave()	Especifica se a pasta de trabalho está no modo AutoSave.
getBinding(id)	Obtém um objeto de associação pela ID. Se o objeto de associação não existir, esse método retornará `undefined`.
getBindings()	Representa uma coleção de ligações que fazem parte da pasta de trabalho.
getCalculationEngineVersion()	Retorna um número sobre a versão do Mecanismo de Cálculo do Excel.
getChartDataPointTrack()	True se todos os gráficos na pasta de trabalho estiverem rastreando os pontos de dados reais aos quais eles estão anexados. False se os gráficos acompanharem o índice dos pontos de dados.
getComment(commentId)	Obtém um comentário da coleção com base em seu ID. Se o objeto de comentário não existir, esse método retornará `undefined`.
getCommentByCell(cellAddress)	Obtém o comentário da célula especificada. Se não houver nenhum comentário na célula, um erro será gerado.
getCommentByReplyId(replyId)	Obtém o comentário ao qual a resposta determinada está conectada.
getComments()	Representa uma coleção de comentários associados à pasta de trabalho.
getCustomXmlPart(id)	Obtém uma parte XML personalizada com base em sua ID. Se o `CustomXmlPart` não existir, esse método retornará `undefined`.
getCustomXmlPartByNamespace(namespaceUri)	Obtém uma nova coleção de partes XML personalizadas cujos namespaces correspondem ao namespace fornecido.
getCustomXmlParts()	Representa a coleção de partes XML personalizadas contidas por esta pasta de trabalho.
getCustomXmlPartsByNamespace(namespaceUri)	Obtém uma nova coleção de partes XML personalizadas cujos namespaces correspondem ao namespace fornecido.
getDefaultPivotTableStyle()	Obtém o estilo de Tabela Dinâmica padrão para o escopo do objeto pai.
getDefaultSlicerStyle()	Obtém o padrão `SlicerStyle` para o escopo do objeto pai.
getDefaultTableStyle()	Obtém o estilo de tabela padrão para o escopo do objeto pai.
getDefaultTimelineStyle()	Obtém o estilo padrão linha do tempo para o escopo do objeto pai.
getFirstWorksheet(visibleOnly)	Obtém a primeira planilha na coleção.
getIsDirty()	Especifica se foram feitas alterações desde que a pasta de trabalho foi salva pela última vez. Você pode definir essa propriedade como `true` se quiser fechar uma pasta de trabalho modificada sem salvá-la ou ser solicitada a salvá-la.
getLastWorksheet(visibleOnly)	Obtém a última planilha na coleção.
getLinkedWorkbookByUrl(key)	Obtém informações sobre uma pasta de trabalho vinculada por sua URL. Se a pasta de trabalho não existir, esse método retornará `undefined`.
getLinkedWorkbookRefreshMode()	Representa o modo de atualização dos links da pasta de trabalho. O modo é o mesmo para todos os links de pasta de trabalho presentes na pasta de trabalho.
getLinkedWorkbooks()	Retorna uma coleção de pastas de trabalho vinculadas. Em fórmulas, os links da pasta de trabalho podem ser usados para referenciar dados (valores e nomes de célula) fora da pasta de trabalho atual.
getName()	Obtém o nome da pasta de trabalho.
getNamedItem(name)	Obtém um `NamedItem` objeto usando seu nome. Se o objeto não existir, esse método retornará `undefined`.
getNames()	Representa uma coleção de itens nomeados com escopo de pasta de trabalho (intervalos e constantes nomeados).
getPivotTable(name)	Obtém uma Tabela Dinâmica por nome. Se a Tabela Dinâmica não existir, esse método retornará `undefined`.
getPivotTables()	Representa uma coleção de Tabelas Dinâmicas associadas à pasta de trabalho.
getPivotTableStyle(name)	Obtém um `PivotTableStyle` por nome. Se o `PivotTableStyle` não existir, esse método retornará `undefined`.
getPivotTableStyles()	Representa uma coleção de Tabelas Dinâmicas associadas à pasta de trabalho.
getPredefinedCellStyle(name)	Obtém um estilo por nome. Se o objeto style não existir, esse método retornará `undefined`.
getPredefinedCellStyles()	Representa uma coleção de estilos associados à pasta de trabalho.
getPreviouslySaved()	Especifica se a pasta de trabalho já foi salva localmente ou online.
getProperties()	Obtém as propriedades da pasta de trabalho.
getProtection()	Retorna o objeto de proteção para uma pasta de trabalho.
getQueries()	Retorna uma coleção de consultas Power Query que fazem parte da pasta de trabalho.
getQuery(key)	Obtém uma consulta da coleção com base em seu nome.
getReadOnly()	Retornará `true` se a pasta de trabalho estiver aberta no modo somente leitura.
getSelectedRange()	Obtém o intervalo único selecionado atualmente na pasta de trabalho. Se houver vários intervalos selecionados, esse método gerará um erro.
getSelectedRanges()	Obtém um ou mais intervalos atualmente selecionados da pasta de trabalho. Ao contrário `getSelectedRange()`de , esse método retorna um `RangeAreas` objeto que representa todos os intervalos selecionados.
getSlicer(key)	Obtém uma segmentação usando seu nome ou ID. Se a segmentação não existir, esse método retornará `undefined`.
getSlicers()	Representa uma coleção de segmentações associadas à pasta de trabalho.
getSlicerStyle(name)	Obtém um `SlicerStyle` por nome. Se o estilo de segmentação não existir, esse método retornará `undefined`.
getSlicerStyles()	Representa uma coleção de SlicerStyles associados à pasta de trabalho.
getTable(key)	Obtém uma tabela pelo nome ou ID. Se a tabela não existir, esse método retornará `undefined`.
getTables()	Representa uma coleção de tabelas associadas à pasta de trabalho.
getTableStyle(name)	Obtém um `TableStyle` por nome. Se o estilo de tabela não existir, esse método retornará `undefined`.
getTableStyles()	Representa uma coleção de TableStyles associadas à pasta de trabalho.
getTimelineStyle(name)	Obtém um `TimelineStyle` por nome. Se o estilo linha do tempo não existir, esse método retornará `undefined`.
getTimelineStyles()	Representa uma coleção de TimelineStyles associados à pasta de trabalho.
getUsePrecisionAsDisplayed()	True se os cálculos dessa pasta de trabalho forem efetuados usando apenas a precisão dos números conforme forem exibidos. Os dados perderão permanentemente a precisão ao alternar essa propriedade de `false` para `true`.
getWorksheet(key)	Obtém um objeto de planilha usando o nome ou ID dele. Se a planilha não existir, esse método retornará `undefined`.
getWorksheets()	Representa uma coleção de planilhas associadas à pasta de trabalho.
refreshAllDataConnections()	Faz uma solicitação para atualizar todas as conexões de dados.
refreshAllLinksToLinkedWorkbooks()	Faz uma solicitação para atualizar todos os links da pasta de trabalho.
refreshAllPivotTables()	Atualiza todas as tabelas dinâmicas da coleção.
setChartDataPointTrack(chartDataPointTrack)	True se todos os gráficos na pasta de trabalho estiverem rastreando os pontos de dados reais aos quais eles estão anexados. False se os gráficos acompanharem o índice dos pontos de dados.
setDefaultPivotTableStyle(newDefaultStyle)	Define o estilo de Tabela Dinâmica padrão para uso no escopo do objeto pai.
setDefaultSlicerStyle(newDefaultStyle)	Define o estilo de segmentação padrão para uso no escopo do objeto pai.
setDefaultTableStyle(newDefaultStyle)	Define o estilo de tabela padrão para uso no escopo do objeto pai.
setDefaultTimelineStyle(newDefaultStyle)	Define o estilo padrão linha do tempo para uso no escopo do objeto pai.
setIsDirty(isDirty)	Especifica se foram feitas alterações desde que a pasta de trabalho foi salva pela última vez. Você pode definir essa propriedade como `true` se quiser fechar uma pasta de trabalho modificada sem salvá-la ou ser solicitada a salvá-la.
setLinkedWorkbookRefreshMode(linkedWorkbookRefreshMode)	Representa o modo de atualização dos links da pasta de trabalho. O modo é o mesmo para todos os links de pasta de trabalho presentes na pasta de trabalho.
setUsePrecisionAsDisplayed(usePrecisionAsDisplayed)	True se os cálculos dessa pasta de trabalho forem efetuados usando apenas a precisão dos números conforme forem exibidos. Os dados perderão permanentemente a precisão ao alternar essa propriedade de `false` para `true`.

Detalhes do método

addBinding(range, bindingType, id)

Adiciona uma nova associação a um intervalo específico.

addBinding(
            range: Range | string,
            bindingType: BindingType,
            id: string
        ): Binding;

Parâmetros

range: ExcelScript.Range | string

Intervalo para vincular a associação. Pode ser um Range objeto ou uma cadeia de caracteres. Se for uma cadeia de caracteres, deve conter o endereço completo, incluindo o nome da planilha

bindingType: ExcelScript.BindingType

Tipo de associação. Consulte ExcelScript.BindingType.

id: string

Nome da associação.

Retornos

ExcelScript.Binding

addBindingFromNamedItem(name, bindingType, id)

Adiciona uma nova associação com base em um item nomeado na pasta de trabalho. Se o item nomeado fizer referência a várias áreas, o InvalidReference erro será retornado.

addBindingFromNamedItem(
            name: string,
            bindingType: BindingType,
            id: string
        ): Binding;

Parâmetros

name: string

Nome do qual deseja criar a associação.

bindingType: ExcelScript.BindingType

Tipo de associação. Consulte ExcelScript.BindingType.

id: string

Nome da associação.

Retornos

ExcelScript.Binding

addBindingFromSelection(bindingType, id)

Adiciona uma nova associação com base na seleção atual. Se a seleção tiver várias áreas, o InvalidReference erro será retornado.

addBindingFromSelection(bindingType: BindingType, id: string): Binding;

Parâmetros

bindingType: ExcelScript.BindingType

Tipo de associação. Consulte ExcelScript.BindingType.

id: string

Nome da associação.

Retornos

ExcelScript.Binding

addComment(cellAddress, content, contentType)

Cria um novo comentário com o conteúdo fornecido na célula especificada. Um InvalidArgument erro será gerado se o intervalo fornecido for maior que uma célula.

addComment(
            cellAddress: Range | string,
            content: CommentRichContent | string,
            contentType?: ContentType
        ): Comment;

Parâmetros

cellAddress: ExcelScript.Range | string

A célula à qual o comentário é adicionado. Isso pode ser um Range objeto ou uma cadeia de caracteres. Se for uma cadeia de caracteres, ela deve conter o endereço completo, incluindo o nome da planilha. Um InvalidArgument erro será gerado se o intervalo fornecido for maior que uma célula.

content: ExcelScript.CommentRichContent | string

O conteúdo do comentário. Isso pode ser uma cadeia de caracteres ou CommentRichContent um objeto. Cadeias de caracteres são usadas para texto simples. CommentRichContent objetos permitem outros recursos de comentário, como menções.

contentType: ExcelScript.ContentType

Opcional. O tipo de conteúdo contido no comentário. O valor padrão é enumerar ContentType.Plain.

Retornos

ExcelScript.Comment

addCustomXmlPart(xml)

Adiciona uma nova parte XML personalizada à pasta de trabalho.

addCustomXmlPart(xml: string): CustomXmlPart;

Parâmetros

xml: string

Conteúdo XML. Deve ser um fragmento XML válido.

Retornos

ExcelScript.CustomXmlPart

addNamedItem(name, reference, comment)

Adiciona um novo nome à coleção do escopo fornecido.

addNamedItem(
            name: string,
            reference: Range | string,
            comment?: string
        ): NamedItem;

Parâmetros

name: string

O nome do item nomeado.

reference: ExcelScript.Range | string

A fórmula ou o intervalo ao qual o nome fará referência.

comment: string

Opcional. O comentário associado ao item nomeado.

Retornos

ExcelScript.NamedItem

Exemplos

/**
 * This script creates a named formula and uses it in another part of the workbook.
 */
function main(workbook: ExcelScript.Workbook) {
  // Create a named item for a formula.
  // This formula is the sum of the cells F2:F21 on Sheet1.
  const namedItem: ExcelScript.NamedItem = workbook.addNamedItem(
    "GrandTotal", 
    "=SUM(Sheet1!$F$2:$F$21)", 
    "The sum of table sums."
  );

  // Add this named formula to a new sheet in the workbook.
  const otherSheet = workbook.addWorksheet();
  otherSheet.getRange("A1").setFormula(namedItem.getFormula());

  // Switch to the new worksheet.
  otherSheet.activate();
}

addNamedItemFormulaLocal(name, formula, comment)

Adiciona um novo nome à coleção de escopo fornecido usando a localidade do usuário para a fórmula.

addNamedItemFormulaLocal(
            name: string,
            formula: string,
            comment?: string
        ): NamedItem;

Parâmetros

name: string

O nome do item nomeado.

formula: string

A fórmula na localidade do usuário à qual o nome se referirá.

comment: string

Opcional. O comentário associado ao item nomeado.

Retornos

ExcelScript.NamedItem

addPivotTable(name, source, destination)

Adicione uma Tabela Dinâmica com base nos dados de origem especificados e insira-os na célula superior esquerda do intervalo de destino.

addPivotTable(
            name: string,
            source: Range | string | Table,
            destination: Range | string
        ): PivotTable;

Parâmetros

name: string

O nome da nova Tabela Dinâmica.

source: ExcelScript.Range | string | ExcelScript.Table

Os dados de origem da nova Tabela Dinâmica podem ser um intervalo (ou um endereço de cadeia de caracteres, incluindo o nome da planilha) ou uma tabela.

destination: ExcelScript.Range | string

A célula no canto superior esquerdo do intervalo de destino do relatório de tabela dinâmica (o intervalo na planilha em que o relatório resultante será inserido).

Retornos

ExcelScript.PivotTable

Exemplos

/**
 * This script creates a PivotTable from an existing table and adds it to an existing worksheet.
 * This script assumes there is a table in the current worksheet with columns named "Type" and "Sales".
 * It also assumes there is a worksheet named "PivotSheet".
 */
function main(workbook: ExcelScript.Workbook) {
  // Create a PivotTable based on a table in the current worksheet.
  let sheet = workbook.getActiveWorksheet();
  let table = sheet.getTables()[0];
  let pivotTable = workbook.addPivotTable("My Pivot", table, "PivotSheet!A1");

  // Add fields to the PivotTable to show "Sales" per "Type".
  pivotTable.addRowHierarchy(pivotTable.getHierarchy("Type"));
  pivotTable.addDataHierarchy(pivotTable.getHierarchy("Sales"));
}

addPivotTableStyle(name, makeUniqueName)

Cria um em branco PivotTableStyle com o nome especificado.

addPivotTableStyle(
            name: string,
            makeUniqueName?: boolean
        ): PivotTableStyle;

Parâmetros

name: string

O nome exclusivo para o novo estilo de Tabela Dinâmica. Gerará um InvalidArgument erro se o nome já estiver em uso.

makeUniqueName: boolean

Opcional. Padrão para false. Se true, adicionará números ao nome para torná-lo exclusivo, se necessário.

Retornos

ExcelScript.PivotTableStyle

addPredefinedCellStyle(name)

Adiciona um novo estilo para o conjunto.

addPredefinedCellStyle(name: string): void;

Parâmetros

name: string

Nome do estilo a ser adicionado.

Retornos

void

addSlicer(slicerSource, sourceField, slicerDestination)

Adiciona uma nova segmentação de dados à pasta de trabalho.

addSlicer(
            slicerSource: string | PivotTable | Table,
            sourceField: string | PivotField | number | TableColumn,
            slicerDestination?: string | Worksheet
        ): Slicer;

Parâmetros

slicerSource: string | ExcelScript.PivotTable | ExcelScript.Table

A fonte de dados na qual a nova segmentação será baseada. Pode ser um PivotTable objeto, um Table objeto ou uma cadeia de caracteres. Quando um objeto PivotTable é passado, a fonte de dados é a fonte do PivotTable objeto. Quando um Table objeto é passado, a fonte de dados é o Table objeto. Quando uma cadeia de caracteres é passada, ela é interpretada como o nome ou a ID de uma tabela ou tabela dinâmica.

sourceField: string | ExcelScript.PivotField | number | ExcelScript.TableColumn

O campo na fonte de dados a ser filtrado. Pode ser um PivotField objeto, um TableColumn objeto, a ID de um PivotField ou o nome ou ID de um TableColumn.

slicerDestination: string | ExcelScript.Worksheet

Opcional. A planilha na qual a nova segmentação será criada. Pode ser um Worksheet objeto ou o nome ou ID de uma planilha. Esse parâmetro poderá ser omitido se a coleção slicer for recuperada de uma planilha.

Retornos

ExcelScript.Slicer

Exemplos

/**
 * This script adds a slicer for an existing PivotTable.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the PivotTable named "Farm Pivot".
  const farmPivot = workbook.getPivotTable("Farm Pivot");

  // Create the slicer. 
  // Note that this assumes "Type" is already added as a hierarchy to the PivotTable.
  const fruitSlicer: ExcelScript.Slicer = workbook.addSlicer(
    farmPivot, /* The table or PivotTale to be sliced. */
    farmPivot.getHierarchy("Type").getFields()[0] /* What source field to use as the slicer options. */
  );

  // Select the items to display.
  fruitSlicer.selectItems(["Lemon", "Lime"]);

  // Set the left margin of the slicer.
  fruitSlicer.setLeft(400);
}

addSlicerStyle(name, makeUniqueName)

Cria um estilo de segmentação em branco com o nome especificado.

addSlicerStyle(name: string, makeUniqueName?: boolean): SlicerStyle;

Parâmetros

name: string

O nome exclusivo para o novo estilo de segmentação. Gerará uma exceção InvalidArgument se o nome já estiver em uso.

makeUniqueName: boolean

Opcional. Padrão para false. Se true, adicionará números ao nome para torná-lo exclusivo, se necessário.

Retornos

ExcelScript.SlicerStyle

addTable(address, hasHeaders)

Cria uma nova tabela. O objeto de intervalo ou endereço de origem determina a planilha à qual a tabela será adicionada. Se a tabela não puder ser adicionada (por exemplo, porque o endereço é inválido ou a tabela se sobreporia a outra), será gerado um erro.

addTable(address: Range | string, hasHeaders: boolean): Table;

Parâmetros

address: ExcelScript.Range | string

Um Range objeto ou um endereço de cadeia de caracteres ou um nome do intervalo que representa a fonte de dados. Se o endereço não contiver o nome de uma planilha, a folha ativa no momento será usada.

hasHeaders: boolean

Um valor booliano que indica se os dados importados têm rótulos de coluna. Se a origem não contiver cabeçalhos (ou seja, quando essa propriedade definida como false), o Excel gerará automaticamente um cabeçalho e deslocará os dados para baixo por uma linha.

Retornos

ExcelScript.Table

Exemplos

/**
 * This sample converts the information in the first worksheet
 * into a table with headers.
*/
function main(workbook: ExcelScript.Workbook) {
  // This assumes there is one contiguous range in the first worksheet.
  const dataRange = workbook.getFirstWorksheet().getUsedRange();
  
  // Add a table at the workbook level.
  workbook.addTable(dataRange.getAddress(), true);
}

addTableStyle(name, makeUniqueName)

Cria um em branco TableStyle com o nome especificado.

addTableStyle(name: string, makeUniqueName?: boolean): TableStyle;

Parâmetros

name: string

O nome exclusivo para o novo estilo de tabela. Gerará um InvalidArgument erro se o nome já estiver em uso.

makeUniqueName: boolean

Opcional. Padrão para false. Se true, adicionará números ao nome para torná-lo exclusivo, se necessário.

Retornos

ExcelScript.TableStyle

addTimelineStyle(name, makeUniqueName)

Cria um em branco TimelineStyle com o nome especificado.

addTimelineStyle(name: string, makeUniqueName?: boolean): TimelineStyle;

Parâmetros

name: string

O nome exclusivo do novo estilo linha do tempo. Gerará um InvalidArgument erro se o nome já estiver em uso.

makeUniqueName: boolean

Opcional. Padrão para false. Se true, adicionará números ao nome para torná-lo exclusivo, se necessário.

Retornos

ExcelScript.TimelineStyle

addWorksheet(name)

Adiciona uma nova planilha à pasta de trabalho. A planilha será adicionada ao final das planilhas existentes. Se você quiser ativar a planilha recém-adicionada, chame-a .activate() .

addWorksheet(name?: string): Worksheet;

Parâmetros

name: string

Opcional. O nome da planilha a ser adicionada. Se especificado, o nome deve ser exclusivo. Se não especificado, o Excel determina o nome da nova planilha.

Retornos

ExcelScript.Worksheet

Exemplos

/**
 * This script adds a new worksheet named "Data" to the workbook.
 * If a worksheet with that name already exists, the script logs a note.
 */
function main(workbook: ExcelScript.Workbook) {
  // Check if the "Data" worksheet already exists.
  if (workbook.getWorksheet("Data")) {
    console.log("The Data worksheet is already in the workbook.");
  } else {
    // Add a new worksheet.
    let worksheet = workbook.addWorksheet("Data");
  }
}

breakAllLinksToLinkedWorkbooks()

Quebra todos os links para as pastas de trabalho vinculadas. Depois que os links são quebrados, todas as fórmulas que referenciam links de pasta de trabalho são totalmente removidas e substituídas pelos valores recuperados mais recentemente.

breakAllLinksToLinkedWorkbooks(): void;

Retornos

void

getActiveCell()

Obtém a célula ativa no momento da pasta de trabalho.

getActiveCell(): Range;

Retornos

ExcelScript.Range

Exemplos

/**
 * This script logs the value of the current active cell. 
 * If multiple cells are selected, the top-leftmost cell will be logged.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the current active cell in the workbook.
  let cell = workbook.getActiveCell();
  console.log(`The current cell's value is ${cell.getValue()}`);
}

getActiveChart()

Obtém o gráfico ativo no momento na pasta de trabalho. Se não houver um gráfico ativo, esse método retornará undefined.

getActiveChart(): Chart;

Retornos

ExcelScript.Chart

getActiveSlicer()

Obtém a segmentação de dados ativa no momento na pasta de trabalho. Se não houver uma segmentação ativa, esse método retornará undefined.

getActiveSlicer(): Slicer;

Retornos

ExcelScript.Slicer

getActiveWorksheet()

Obtém a planilha ativa no momento na pasta de trabalho.

getActiveWorksheet(): Worksheet;

Retornos

ExcelScript.Worksheet

getApplication()

Representa a instância de aplicativo do Excel que contém essa pasta de trabalho.

getApplication(): Application;

Retornos

ExcelScript.Application

getAutoSave()

Especifica se a pasta de trabalho está no modo AutoSave.

getAutoSave(): boolean;

Retornos

boolean

getBinding(id)

Obtém um objeto de associação pela ID. Se o objeto de associação não existir, esse método retornará undefined.

getBinding(id: string): Binding | undefined;

Parâmetros

id: string

ID do objeto Binding a recuperar.

Retornos

ExcelScript.Binding | undefined

getBindings()

Representa uma coleção de ligações que fazem parte da pasta de trabalho.

getBindings(): Binding[];

Retornos

ExcelScript.Binding[]

getCalculationEngineVersion()

Retorna um número sobre a versão do Mecanismo de Cálculo do Excel.

getCalculationEngineVersion(): number;

Retornos

number

getChartDataPointTrack()

True se todos os gráficos na pasta de trabalho estiverem rastreando os pontos de dados reais aos quais eles estão anexados. False se os gráficos acompanharem o índice dos pontos de dados.

getChartDataPointTrack(): boolean;

Retornos

boolean

getComment(commentId)

Obtém um comentário da coleção com base em seu ID. Se o objeto de comentário não existir, esse método retornará undefined.

getComment(commentId: string): Comment | undefined;

Parâmetros

commentId: string

O identificador do comentário.

Retornos

ExcelScript.Comment | undefined

getCommentByCell(cellAddress)

Obtém o comentário da célula especificada. Se não houver nenhum comentário na célula, um erro será gerado.

getCommentByCell(cellAddress: Range | string): Comment;

Parâmetros

cellAddress: ExcelScript.Range | string

A célula na qual o comentário está. Isso pode ser um Range objeto ou uma cadeia de caracteres. Se for uma cadeia de caracteres, ela deve conter o endereço completo, incluindo o nome da planilha. Um InvalidArgument erro será gerado se o intervalo fornecido for maior que uma célula.

Retornos

ExcelScript.Comment

getCommentByReplyId(replyId)

Obtém o comentário ao qual a resposta determinada está conectada.

getCommentByReplyId(replyId: string): Comment;

Parâmetros

replyId: string

O identificador da resposta de comentário.

Retornos

ExcelScript.Comment

getComments()

Representa uma coleção de comentários associados à pasta de trabalho.

getComments(): Comment[];

Retornos

ExcelScript.Comment[]

getCustomXmlPart(id)

Obtém uma parte XML personalizada com base em sua ID. Se o CustomXmlPart não existir, esse método retornará undefined.

getCustomXmlPart(id: string): CustomXmlPart | undefined;

Parâmetros

id: string

ID do objeto a ser recuperado.

Retornos

ExcelScript.CustomXmlPart | undefined

getCustomXmlPartByNamespace(namespaceUri)

Aviso

Essa API foi preterida.

Use getCustomXmlPartsByNamespace instead.

Obtém uma nova coleção de partes XML personalizadas cujos namespaces correspondem ao namespace fornecido.

getCustomXmlPartByNamespace(namespaceUri: string): CustomXmlPart[];

Parâmetros

namespaceUri: string

Este deve ser um URI de esquema totalmente qualificado; por exemplo, "http://schemas.contoso.com/review/1.0".

Retornos

ExcelScript.CustomXmlPart[]

getCustomXmlParts()

Representa a coleção de partes XML personalizadas contidas por esta pasta de trabalho.

getCustomXmlParts(): CustomXmlPart[];

Retornos

ExcelScript.CustomXmlPart[]

getCustomXmlPartsByNamespace(namespaceUri)

Obtém uma nova coleção de partes XML personalizadas cujos namespaces correspondem ao namespace fornecido.

getCustomXmlPartsByNamespace(namespaceUri: string): CustomXmlPart[];

Parâmetros

namespaceUri: string

Este deve ser um URI de esquema totalmente qualificado; por exemplo, "http://schemas.contoso.com/review/1.0".

Retornos

ExcelScript.CustomXmlPart[]

getDefaultPivotTableStyle()

Obtém o estilo de Tabela Dinâmica padrão para o escopo do objeto pai.

getDefaultPivotTableStyle(): PivotTableStyle;

Retornos

ExcelScript.PivotTableStyle

getDefaultSlicerStyle()

Obtém o padrão SlicerStyle para o escopo do objeto pai.

getDefaultSlicerStyle(): SlicerStyle;

Retornos

ExcelScript.SlicerStyle

getDefaultTableStyle()

Obtém o estilo de tabela padrão para o escopo do objeto pai.

getDefaultTableStyle(): TableStyle;

Retornos

ExcelScript.TableStyle

getDefaultTimelineStyle()

Obtém o estilo padrão linha do tempo para o escopo do objeto pai.

getDefaultTimelineStyle(): TimelineStyle;

Retornos

ExcelScript.TimelineStyle

getFirstWorksheet(visibleOnly)

Obtém a primeira planilha na coleção.

getFirstWorksheet(visibleOnly?: boolean): Worksheet;

Parâmetros

visibleOnly: boolean

Opcional. Se true, considerar apenas planilhas visíveis, ignorando todas as ocultas.

Retornos

ExcelScript.Worksheet

getIsDirty()

Especifica se foram feitas alterações desde que a pasta de trabalho foi salva pela última vez. Você pode definir essa propriedade como true se quiser fechar uma pasta de trabalho modificada sem salvá-la ou ser solicitada a salvá-la.

getIsDirty(): boolean;

Retornos

boolean

getLastWorksheet(visibleOnly)

Obtém a última planilha na coleção.

getLastWorksheet(visibleOnly?: boolean): Worksheet;

Parâmetros

visibleOnly: boolean

Opcional. Se true, considerar apenas planilhas visíveis, ignorando todas as ocultas.

Retornos

ExcelScript.Worksheet

getLinkedWorkbookByUrl(key)

Obtém informações sobre uma pasta de trabalho vinculada por sua URL. Se a pasta de trabalho não existir, esse método retornará undefined.

getLinkedWorkbookByUrl(key: string): LinkedWorkbook | undefined;

Parâmetros

key: string

A URL da pasta de trabalho vinculada.

Retornos

ExcelScript.LinkedWorkbook | undefined

getLinkedWorkbookRefreshMode()

Representa o modo de atualização dos links da pasta de trabalho. O modo é o mesmo para todos os links de pasta de trabalho presentes na pasta de trabalho.

getLinkedWorkbookRefreshMode(): WorkbookLinksRefreshMode;

Retornos

ExcelScript.WorkbookLinksRefreshMode

Exemplos

/**
 * This script refreshes all the links to external workbooks, 
 * if the linked workbook refresh mode is set to manual.
 * To learn about linked workbooks, see https://support.microsoft.com/office/create-an-external-reference-link-to-a-cell-range-in-another-workbook-c98d1803-dd75-4668-ac6a-d7cca2a9b95f.
 */
function main(workbook: ExcelScript.Workbook) {
  // Check the refresh mode.
  if (workbook.getLinkedWorkbookRefreshMode() === ExcelScript.WorkbookLinksRefreshMode.manual) {
    console.log("Refreshing workbook links");

    // Trigger a refresh of linked workbook content.
    workbook.refreshAllLinksToLinkedWorkbooks();
  }
}

getLinkedWorkbooks()

Retorna uma coleção de pastas de trabalho vinculadas. Em fórmulas, os links da pasta de trabalho podem ser usados para referenciar dados (valores e nomes de célula) fora da pasta de trabalho atual.

getLinkedWorkbooks(): LinkedWorkbook[];

Retornos

ExcelScript.LinkedWorkbook[]

getName()

Obtém o nome da pasta de trabalho.

getName(): string;

Retornos

string

Exemplos

/**
 * This script logs the name of the workbook without the ".xlsx" extension.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the workbook's name.
  let name = workbook.getName();

  // Remove the file extension.
  name = name.substring(0, name.lastIndexOf(".xlsx"));

  // Display the name in the console.
  console.log(name);
}

getNamedItem(name)

Obtém um NamedItem objeto usando seu nome. Se o objeto não existir, esse método retornará undefined.

getNamedItem(name: string): NamedItem | undefined;

Parâmetros

name: string

Nome nameditem.

Retornos

ExcelScript.NamedItem | undefined

getNames()

Representa uma coleção de itens nomeados com escopo de pasta de trabalho (intervalos e constantes nomeados).

getNames(): NamedItem[];

Retornos

ExcelScript.NamedItem[]

Exemplos

/**
 * This script looks for every named range with "Review" in the name 
 * and marks the range with a yellow fill.
 */
function main(workbook: ExcelScript.Workbook) {
  // Look at every named item in the workbook.
  workbook.getNames().forEach((namedItem) => {
    // Find names containing "Review".
    if (namedItem.getName().includes("Review")) {
      // Only change the fill color if the named item is a range (not a formula).
      let itemType: ExcelScript.NamedItemType = namedItem.getType();
      if (itemType === ExcelScript.NamedItemType.range) {
        // Set the range's fill color to yellow.
        namedItem.getRange().getFormat().getFill().setColor("yellow");
      }
    }
  });
}

getPivotTable(name)

Obtém uma Tabela Dinâmica por nome. Se a Tabela Dinâmica não existir, esse método retornará undefined.

getPivotTable(name: string): PivotTable | undefined;

Parâmetros

name: string

Nome da Tabela Dinâmica a ser recuperada.

Retornos

ExcelScript.PivotTable | undefined

getPivotTables()

Representa uma coleção de Tabelas Dinâmicas associadas à pasta de trabalho.

getPivotTables(): PivotTable[];

Retornos

ExcelScript.PivotTable[]

getPivotTableStyle(name)

Obtém um PivotTableStyle por nome. Se o PivotTableStyle não existir, esse método retornará undefined.

getPivotTableStyle(name: string): PivotTableStyle | undefined;

Parâmetros

name: string

Nome do estilo tabela dinâmica a ser recuperado.

Retornos

ExcelScript.PivotTableStyle | undefined

getPivotTableStyles()

Representa uma coleção de Tabelas Dinâmicas associadas à pasta de trabalho.

getPivotTableStyles(): PivotTableStyle[];

Retornos

ExcelScript.PivotTableStyle[]

getPredefinedCellStyle(name)

Obtém um estilo por nome. Se o objeto style não existir, esse método retornará undefined.

getPredefinedCellStyle(name: string): PredefinedCellStyle | undefined;

Parâmetros

name: string

Nome do estilo a ser recuperado.

Retornos

ExcelScript.PredefinedCellStyle | undefined

getPredefinedCellStyles()

Representa uma coleção de estilos associados à pasta de trabalho.

getPredefinedCellStyles(): PredefinedCellStyle[];

Retornos

ExcelScript.PredefinedCellStyle[]

getPreviouslySaved()

Especifica se a pasta de trabalho já foi salva localmente ou online.

getPreviouslySaved(): boolean;

Retornos

boolean

getProperties()

Obtém as propriedades da pasta de trabalho.

getProperties(): DocumentProperties;

Retornos

ExcelScript.DocumentProperties

getProtection()

Retorna o objeto de proteção para uma pasta de trabalho.

getProtection(): WorkbookProtection;

Retornos

ExcelScript.WorkbookProtection

Exemplos

/**
 * This script protects the workbook with a password, if it isn't already protected.
 * The password is provided by the user through a prompt.
 */
function main(workbook: ExcelScript.Workbook, password?: string) {
  // Get the workbook-level protection object.
  const protection = workbook.getProtection();

  // Check if the workbook is already protected.
  if (!protection.getProtected()) {
      // Protect the workbook with the given password.
      // If the optional password was omitted, 
      // no password will be needed to unprotect the workbook.
    protection.protect(password);
  }
}

getQueries()

Retorna uma coleção de consultas Power Query que fazem parte da pasta de trabalho.

getQueries(): Query[];

Retornos

ExcelScript.Query[]

getQuery(key)

Obtém uma consulta da coleção com base em seu nome.

getQuery(key: string): Query;

Parâmetros

key: string

O nome do caso de consulta insensibilidade de caso.

Retornos

ExcelScript.Query

getReadOnly()

Retornará true se a pasta de trabalho estiver aberta no modo somente leitura.

getReadOnly(): boolean;

Retornos

boolean

getSelectedRange()

Obtém o intervalo único selecionado atualmente na pasta de trabalho. Se houver vários intervalos selecionados, esse método gerará um erro.

getSelectedRange(): Range;

Retornos

ExcelScript.Range

getSelectedRanges()

Obtém um ou mais intervalos atualmente selecionados da pasta de trabalho. Ao contrário getSelectedRange()de , esse método retorna um RangeAreas objeto que representa todos os intervalos selecionados.

getSelectedRanges(): RangeAreas;

Retornos

ExcelScript.RangeAreas

getSlicer(key)

Obtém uma segmentação usando seu nome ou ID. Se a segmentação não existir, esse método retornará undefined.

getSlicer(key: string): Slicer | undefined;

Parâmetros

key: string

Nome ou ID da segmentação a ser recuperada.

Retornos

ExcelScript.Slicer | undefined

getSlicers()

Representa uma coleção de segmentações associadas à pasta de trabalho.

getSlicers(): Slicer[];

Retornos

ExcelScript.Slicer[]

getSlicerStyle(name)

Obtém um SlicerStyle por nome. Se o estilo de segmentação não existir, esse método retornará undefined.

getSlicerStyle(name: string): SlicerStyle | undefined;

Parâmetros

name: string

Nome do estilo de segmentação a ser recuperado.

Retornos

ExcelScript.SlicerStyle | undefined

getSlicerStyles()

Representa uma coleção de SlicerStyles associados à pasta de trabalho.

getSlicerStyles(): SlicerStyle[];

Retornos

ExcelScript.SlicerStyle[]

getTable(key)

Obtém uma tabela pelo nome ou ID. Se a tabela não existir, esse método retornará undefined.

getTable(key: string): Table | undefined;

Parâmetros

key: string

Nome ou ID da tabela a ser recuperada.

Retornos

ExcelScript.Table | undefined

getTables()

Representa uma coleção de tabelas associadas à pasta de trabalho.

getTables(): Table[];

Retornos

ExcelScript.Table[]

getTableStyle(name)

Obtém um TableStyle por nome. Se o estilo de tabela não existir, esse método retornará undefined.

getTableStyle(name: string): TableStyle | undefined;

Parâmetros

name: string

Nome do estilo de tabela a ser recuperado.

Retornos

ExcelScript.TableStyle | undefined

getTableStyles()

Representa uma coleção de TableStyles associadas à pasta de trabalho.

getTableStyles(): TableStyle[];

Retornos

ExcelScript.TableStyle[]

getTimelineStyle(name)

Obtém um TimelineStyle por nome. Se o estilo linha do tempo não existir, esse método retornará undefined.

getTimelineStyle(name: string): TimelineStyle | undefined;

Parâmetros

name: string

Nome do estilo linha do tempo a ser recuperado.

Retornos

ExcelScript.TimelineStyle | undefined

getTimelineStyles()

Representa uma coleção de TimelineStyles associados à pasta de trabalho.

getTimelineStyles(): TimelineStyle[];

Retornos

ExcelScript.TimelineStyle[]

getUsePrecisionAsDisplayed()

True se os cálculos dessa pasta de trabalho forem efetuados usando apenas a precisão dos números conforme forem exibidos. Os dados perderão permanentemente a precisão ao alternar essa propriedade de false para true.

getUsePrecisionAsDisplayed(): boolean;

Retornos

boolean

getWorksheet(key)

Obtém um objeto de planilha usando o nome ou ID dele. Se a planilha não existir, esse método retornará undefined.

getWorksheet(key: string): Worksheet | undefined;

Parâmetros

key: string

O nome ou ID da planilha.

Retornos

ExcelScript.Worksheet | undefined

Exemplos

/**
 * This script switches the active view to a worksheet named "Data", if it exists.
 */
function main(workbook: ExcelScript.Workbook) {
  // Check if the "Data" worksheet exists.
  let dataWorksheet = workbook.getWorksheet("Data");
  if (dataWorksheet) {
    // Switch to the "Data" worksheet.
    dataWorksheet.activate();
  } else {
    console.log(`No worksheet named "Data" in this workbook.`);
  }
}

getWorksheets()

Representa uma coleção de planilhas associadas à pasta de trabalho.

getWorksheets(): Worksheet[];

Retornos

ExcelScript.Worksheet[]

Exemplos

/**
 * This script logs the names of all the worksheets in the workbook.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get all the worksheets in the workbook. 
  let sheets = workbook.getWorksheets();

  // Get a list of all the worksheet names.
  let names = sheets.map ((sheet) => sheet.getName());

  // Write in the console all the worksheet names and the total count.
  console.log(names);
  console.log(`Total worksheets inside of this workbook: ${sheets.length}`);
}

refreshAllDataConnections()

Faz uma solicitação para atualizar todas as conexões de dados.

refreshAllDataConnections(): void;

Retornos

void

refreshAllLinksToLinkedWorkbooks()

Faz uma solicitação para atualizar todos os links da pasta de trabalho.

refreshAllLinksToLinkedWorkbooks(): void;

Retornos

void

refreshAllPivotTables()

Atualiza todas as tabelas dinâmicas da coleção.

refreshAllPivotTables(): void;

Retornos

void

setChartDataPointTrack(chartDataPointTrack)

True se todos os gráficos na pasta de trabalho estiverem rastreando os pontos de dados reais aos quais eles estão anexados. False se os gráficos acompanharem o índice dos pontos de dados.

setChartDataPointTrack(chartDataPointTrack: boolean): void;

Parâmetros

chartDataPointTrack: boolean

Retornos

void

setDefaultPivotTableStyle(newDefaultStyle)

Define o estilo de Tabela Dinâmica padrão para uso no escopo do objeto pai.

setDefaultPivotTableStyle(
            newDefaultStyle: PivotTableStyle | string
        ): void;

Parâmetros

newDefaultStyle: ExcelScript.PivotTableStyle | string

O PivotTableStyle objeto, ou nome do PivotTableStyle objeto, que deve ser o novo padrão.

Retornos

void

setDefaultSlicerStyle(newDefaultStyle)

Define o estilo de segmentação padrão para uso no escopo do objeto pai.

setDefaultSlicerStyle(newDefaultStyle: SlicerStyle | string): void;

Parâmetros

newDefaultStyle: ExcelScript.SlicerStyle | string

O SlicerStyle objeto, ou nome do SlicerStyle objeto, que deve ser o novo padrão.

Retornos

void

setDefaultTableStyle(newDefaultStyle)

Define o estilo de tabela padrão para uso no escopo do objeto pai.

setDefaultTableStyle(newDefaultStyle: TableStyle | string): void;

Parâmetros

newDefaultStyle: ExcelScript.TableStyle | string

O TableStyle objeto, ou nome do TableStyle objeto, que deve ser o novo padrão.

Retornos

void

setDefaultTimelineStyle(newDefaultStyle)

Define o estilo padrão linha do tempo para uso no escopo do objeto pai.

setDefaultTimelineStyle(newDefaultStyle: TimelineStyle | string): void;

Parâmetros

newDefaultStyle: ExcelScript.TimelineStyle | string

O TimelineStyle objeto, ou nome do TimelineStyle objeto, que deve ser o novo padrão.

Retornos

void

setIsDirty(isDirty)

setIsDirty(isDirty: boolean): void;

Parâmetros

isDirty: boolean

Retornos

void

setLinkedWorkbookRefreshMode(linkedWorkbookRefreshMode)

Representa o modo de atualização dos links da pasta de trabalho. O modo é o mesmo para todos os links de pasta de trabalho presentes na pasta de trabalho.

setLinkedWorkbookRefreshMode(
            linkedWorkbookRefreshMode: WorkbookLinksRefreshMode
        ): void;

Parâmetros

linkedWorkbookRefreshMode: ExcelScript.WorkbookLinksRefreshMode

Retornos

void

setUsePrecisionAsDisplayed(usePrecisionAsDisplayed)

setUsePrecisionAsDisplayed(usePrecisionAsDisplayed: boolean): void;

Parâmetros

usePrecisionAsDisplayed: boolean

Retornos

void

Share via

ExcelScript.Workbook interface

Comentários

Exemplos

Métodos

Detalhes do método

addBinding(range, bindingType, id)

Parâmetros

Retornos

addBindingFromNamedItem(name, bindingType, id)

Parâmetros

Retornos

addBindingFromSelection(bindingType, id)

Parâmetros

Retornos

addComment(cellAddress, content, contentType)

Parâmetros

Retornos

addCustomXmlPart(xml)

Parâmetros

Retornos

addNamedItem(name, reference, comment)

Parâmetros

Retornos

Exemplos

addNamedItemFormulaLocal(name, formula, comment)

Parâmetros

Retornos

addPivotTable(name, source, destination)

Parâmetros

Retornos

Exemplos

addPivotTableStyle(name, makeUniqueName)

Parâmetros

Retornos

addPredefinedCellStyle(name)

Parâmetros

Retornos

addSlicer(slicerSource, sourceField, slicerDestination)

Parâmetros

Retornos

Exemplos

addSlicerStyle(name, makeUniqueName)

Parâmetros

Retornos

addTable(address, hasHeaders)

Parâmetros

Retornos

Exemplos

addTableStyle(name, makeUniqueName)

Parâmetros

Retornos

addTimelineStyle(name, makeUniqueName)

Parâmetros

Retornos

addWorksheet(name)

Parâmetros

Retornos

Exemplos

breakAllLinksToLinkedWorkbooks()

Retornos

getActiveCell()

Retornos

Exemplos

getActiveChart()

Retornos

getActiveSlicer()

Retornos

getActiveWorksheet()

Retornos

getApplication()

Retornos

getAutoSave()

Retornos

getBinding(id)

Parâmetros

Retornos

getBindings()

Retornos

getCalculationEngineVersion()