Excel.Workbook interface

Workbook é o objeto de nível superior que contém objetos de pasta de trabalho relacionados, como planilhas, tabelas, intervalos, etc. Para saber mais sobre o modelo de objeto de pasta de trabalho, leia trabalhar com pastas de trabalho usando a API JavaScript do Excel.

Propriedades

application

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

autoSave

Especifica se a pasta de trabalho está no modo de salvamento automático.

bindings

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

calculationEngineVersion

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

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 acompanham o índice dos pontos de dados.

comments

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

customXmlParts

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

dataConnections

Representa todas as conexões de dados na pasta de trabalho.

isDirty

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

name

Obtém o nome da pasta de trabalho.

names

Representa uma coleção de itens denominados de escopo da pasta de trabalho (chamados intervalos e constantes).

pivotTables

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

pivotTableStyles

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

previouslySaved

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

properties

Obtém as propriedades da pasta de trabalho.

protection

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

readOnly

True se a pasta de trabalho estiver aberta no modo somente leitura.

slicers

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

slicerStyles

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

styles

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

tables

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

tableStyles

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

timelineStyles

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

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 mudar essa propriedade de false para true.

worksheets

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

Métodos

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 nenhum gráfico ativo, uma ItemNotFound exceção será lançada.

getActiveChartOrNullObject()

Obtém o gráfico ativo no momento na pasta de trabalho. Se não houver nenhum gráfico ativo, um objeto nulo será retornado.

getActiveSlicer()

Obtém a segmentação de dados ativa no momento na pasta de trabalho. Se não houver um slicer ativo, uma ItemNotFound exceção será lançada.

getActiveSlicerOrNullObject()

Obtém a segmentação de dados ativa no momento na pasta de trabalho. Se não houver segmentação de dados ativa, um objeto nulo será retornado.

getSelectedRange()

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

getSelectedRanges()

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

load(propertyNames)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

Detalhes da propriedade

application

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

readonly application: Application;

Valor da propriedade

autoSave

Especifica se a pasta de trabalho está no modo de salvamento automático.

readonly autoSave: boolean;

Valor da propriedade

boolean

bindings

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

readonly bindings: BindingCollection;

Valor da propriedade

calculationEngineVersion

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

readonly calculationEngineVersion: number;

Valor da propriedade

number

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 acompanham o índice dos pontos de dados.

chartDataPointTrack: boolean;

Valor da propriedade

boolean

comments

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

readonly comments: CommentCollection;

Valor da propriedade

customXmlParts

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

readonly customXmlParts: CustomXmlPartCollection;

Valor da propriedade

dataConnections

Representa todas as conexões de dados na pasta de trabalho.

readonly dataConnections: DataConnectionCollection;

Valor da propriedade

isDirty

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

isDirty: boolean;

Valor da propriedade

boolean

name

Obtém o nome da pasta de trabalho.

readonly name: string;

Valor da propriedade

string

names

Representa uma coleção de itens denominados de escopo da pasta de trabalho (chamados intervalos e constantes).

readonly names: NamedItemCollection;

Valor da propriedade

pivotTables

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

readonly pivotTables: PivotTableCollection;

Valor da propriedade

pivotTableStyles

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

readonly pivotTableStyles: PivotTableStyleCollection;

Valor da propriedade

previouslySaved

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

readonly previouslySaved: boolean;

Valor da propriedade

boolean

properties

Obtém as propriedades da pasta de trabalho.

readonly properties: DocumentProperties;

Valor da propriedade

Exemplos

async function main(context: Excel.RequestContext) {
    let titleValue = "Excel document properties API";
    let subjectValue = "Set and get document properties";
    let keywordsValue = "Set and get operations";
    let commentsValue = "This is an Excel document properties API code sample";
    let categoryValue = "Office Add-ins";
    let managerValue = "John";
    let companyValue = "Microsoft";

    let docProperties = context.workbook.properties;

    // Set the writeable document properties.
    docProperties.title = titleValue;
    docProperties.subject = subjectValue;
    docProperties.keywords = keywordsValue;
    docProperties.comments = commentsValue;
    docProperties.category = categoryValue;
    docProperties.manager = managerValue;
    docProperties.company = companyValue;

    await context.sync();

    console.log("Set the following document properties: title, subject, keywords, comments, category, manager, company.");
}

protection

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

readonly protection: WorkbookProtection;

Valor da propriedade

readOnly

True se a pasta de trabalho estiver aberta no modo somente leitura.

readonly readOnly: boolean;

Valor da propriedade

boolean

slicers

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

readonly slicers: SlicerCollection;

Valor da propriedade

slicerStyles

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

readonly slicerStyles: SlicerStyleCollection;

Valor da propriedade

styles

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

readonly styles: StyleCollection;

Valor da propriedade

Exemplos

async function main(context: Excel.RequestContext) {
    let styles = context.workbook.styles;

    // Add a new style to the style collection.
    // Styles is in the Home tab ribbon.
    styles.add("Diagonal Orientation Style");
          
    let newStyle = styles.getItem("Diagonal Orientation Style");
    
    // The "Diagonal Orientation Style" properties.
    newStyle.textOrientation = 38;
    newStyle.autoIndent = true;
    newStyle.includeProtection = true;
    newStyle.shrinkToFit = true;
    newStyle.locked = false;
    
    await context.sync();

    console.log("Successfully added a new style with diagonal orientation to the Home tab ribbon.");
}

tables

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

readonly tables: TableCollection;

Valor da propriedade

tableStyles

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

readonly tableStyles: TableStyleCollection;

Valor da propriedade

timelineStyles

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

readonly timelineStyles: TimelineStyleCollection;

Valor da propriedade

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 mudar essa propriedade de false para true.

usePrecisionAsDisplayed: boolean;

Valor da propriedade

boolean

worksheets

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

readonly worksheets: WorksheetCollection;

Valor da propriedade

Detalhes do método

getActiveCell()

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

getActiveCell(): Range;

Retornos

Exemplos

async function main(context: Excel.RequestContext) {

    let myWorkbook = context.workbook;
    let activeCell = myWorkbook.getActiveCell();
    activeCell.load("address");

    await context.sync();
    
    console.log("The active cell is " + activeCell.address);
}

getActiveChart()

Obtém o gráfico ativo no momento na pasta de trabalho. Se não houver nenhum gráfico ativo, uma ItemNotFound exceção será lançada.

getActiveChart(): Chart;

Retornos

getActiveChartOrNullObject()

Obtém o gráfico ativo no momento na pasta de trabalho. Se não houver nenhum gráfico ativo, um objeto nulo será retornado.

getActiveChartOrNullObject(): Chart;

Retornos

getActiveSlicer()

Obtém a segmentação de dados ativa no momento na pasta de trabalho. Se não houver um slicer ativo, uma ItemNotFound exceção será lançada.

getActiveSlicer(): Slicer;

Retornos

getActiveSlicerOrNullObject()

Obtém a segmentação de dados ativa no momento na pasta de trabalho. Se não houver segmentação de dados ativa, um objeto nulo será retornado.

getActiveSlicerOrNullObject(): Slicer;

Retornos

getSelectedRange()

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

getSelectedRange(): Range;

Retornos

getSelectedRanges()

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

getSelectedRanges(): RangeAreas;

Retornos

Exemplos

async function main(context: Excel.RequestContext) {

    let selectedRanges = context.workbook.getSelectedRanges();
    selectedRanges.format.fill.color = "lightblue";

    await context.sync();
})

load(propertyNames)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

load(propertyNames?: string | string[]): void;

Parâmetros

propertyNames
string | string[]

Uma cadeia de caracteres delimitada por vírgula ou uma matriz de cadeias de caracteres que especificam as propriedades a serem carregadas.

Retornos

void