Office.TableBinding interface

Referência

Pacote:: office

Representa uma associação em duas dimensões de linhas e colunas, opcionalmente com cabeçalhos.

Extends: Office.Binding

Comentários

O objeto TableBinding herda a id propriedade, type a propriedade, getDataAsync o método e setDataAsync o método do objeto Office.Binding .

Para o Excel, observe que, depois de estabelecer uma associação de tabela, cada nova linha que um usuário adiciona à tabela será incluída automaticamente na associação e o rowCount aumenta.

Propriedades

columnCount	Obtém o número de colunas no TableBinding, como um valor inteiro.
hasHeaders	True, se a tabela tiver cabeçalhos; caso contrário, false.
rowCount	Obtém o número de linhas no TableBinding, como um valor inteiro.

Métodos

addColumnsAsync(tableData, options, callback)	Adiciona os dados especificados à tabela como colunas adicionais.
addColumnsAsync(tableData, callback)	Adiciona os dados especificados à tabela como colunas adicionais.
addRowsAsync(rows, options, callback)	Adiciona os dados especificados à tabela como linhas adicionais.
addRowsAsync(rows, callback)	Adiciona os dados especificados à tabela como linhas adicionais.
clearFormatsAsync(options, callback)	Limpa a formatação na tabela associada.
clearFormatsAsync(callback)	Limpa a formatação na tabela associada.
deleteAllDataValuesAsync(options, callback)	Exclui todas as linhas que não são cabeçalho e seus valores na tabela, mudando adequadamente para o aplicativo do Office.
deleteAllDataValuesAsync(callback)	Exclui todas as linhas que não são cabeçalho e seus valores na tabela, mudando adequadamente para o aplicativo do Office.
getFormatsAsync(cellReference, formats, options, callback)	Obtém a formatação em itens especificados na tabela.
getFormatsAsync(cellReference, formats, callback)	Obtém a formatação em itens especificados na tabela.
setFormatsAsync(cellFormat, options, callback)	Define a formatação em itens e dados especificados na tabela.
setFormatsAsync(cellFormat, callback)	Define a formatação em itens e dados especificados na tabela.
setTableOptionsAsync(tableOptions, options, callback)	Atualiza as opções de formatação de tabela na tabela associada.
setTableOptionsAsync(tableOptions, callback)	Atualiza as opções de formatação de tabela na tabela associada.

Detalhes da propriedade

columnCount

Obtém o número de colunas no TableBinding, como um valor inteiro.

columnCount: number;

Valor da propriedade

number

Exemplos

function showBindingColumnCount() {
    Office.context.document.bindings.getByIdAsync("myBinding", function (asyncResult) {
        write("Column: " + asyncResult.value.columnCount);
    });
}
// Function that writes to a div with id='message' on the page.
function write(message){
    document.getElementById('message').innerText += message; 
}

hasHeaders

True, se a tabela tiver cabeçalhos; caso contrário, false.

hasHeaders: boolean;

Valor da propriedade

boolean

Exemplos

function showBindingHasHeaders() {
    Office.context.document.bindings.getByIdAsync("myBinding", function (asyncResult) {
        write("Binding has headers: " + asyncResult.value.hasHeaders);
    });
}
// Function that writes to a div with id='message' on the page.
function write(message){
    document.getElementById('message').innerText += message; 
}

rowCount

Obtém o número de linhas no TableBinding, como um valor inteiro.

rowCount: number;

Valor da propriedade

number

Comentários

Ao inserir uma tabela vazia selecionando uma única linha no Excel na área de trabalho e Excel na Web (usando Tabela na guia Inserir), ambos os aplicativos do Office criam uma única linha de cabeçalhos seguida por uma única linha em branco. No entanto, se o script do suplemento criar uma associação para essa tabela recém-inserida (por exemplo, usando o método Office.Bindings.addFromSelectionAsync) e verificar o valor da propriedade rowCount, o valor retornado será diferente dependendo se a planilha estiver aberta no Excel na área de trabalho ou Excel na Web.

No Excel na área de trabalho (ou seja, Windows e Mac), rowCount retornará 0 (a linha em branco após os cabeçalhos não é contada).
Em Excel na Web, rowCount retornará 1 (a linha em branco após os cabeçalhos é contada).

Você pode contornar essa diferença no script verificando se rowCount == 1 e, em seguida, verificando se a linha contém todas as cadeias de caracteres vazias.

Exemplos

function showBindingRowCount() {
    Office.context.document.bindings.getByIdAsync("myBinding", function (asyncResult) {
        write("Rows: " + asyncResult.value.rowCount);
    });
}
// Function that writes to a div with id='message' on the page.
function write(message){
    document.getElementById('message').innerText += message; 
}

Detalhes do método

addColumnsAsync(tableData, options, callback)

Adiciona os dados especificados à tabela como colunas adicionais.

addColumnsAsync(tableData: TableData | any[][], options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<void>) => void): void;

Parâmetros

tableData: Office.TableData | any[][]

Uma matriz de matrizes ("matriz") ou um objeto TableData que contém uma ou mais colunas de dados a serem adicionadas à tabela. Obrigatório.

options: Office.AsyncContextOptions

Fornece uma opção para preservar dados de contexto de qualquer tipo, inalterados, para uso em um retorno de chamada.

callback: (result: Office.AsyncResult<void>) => void

Opcional. Uma função que é invocada quando o retorno de chamada retorna, cujo único parâmetro é do tipo Office.AsyncResult.

Retornos

void

Comentários

Para adicionar uma ou mais colunas especificando os valores dos dados e cabeçalhos, passe um objeto TableData como o parâmetro de dados. Para adicionar uma ou mais colunas especificando somente os dados, passe uma matriz de matrizes ("matrix") como parâmetro data.

O sucesso ou falha de uma operação addColumnsAsync é atômico. Ou seja, toda a operação de adição de colunas deve ter êxito ou ela será completamente revertida (e a propriedade AsyncResult.status retornada para o retorno de chamada relatará a falha):

Cada linha na matriz que você passa como o argumento de dados deve ter o mesmo número de linhas que a tabela que está sendo atualizada. Caso contrário, toda a operação falhará.
Cada linha e célula na matriz devem adicionar com êxito essa linha ou célula à tabela nas colunas recém-adicionadas. Se qualquer linha ou célula falhar em ser definida por qualquer motivo, toda a operação falhará.
Se você passar um objeto TableData como o argumento de dados, o número de linhas de cabeçalho deverá corresponder ao da tabela que está sendo atualizada.

Observação adicional para Excel na Web: o número total de células no objeto TableData passado para o parâmetro de dados não pode exceder 20.000 em uma única chamada para esse método.

Exemplos

// The following example adds a single column with three rows to a bound table with the id "myTable"
// by passing a TableData object as the data argument of the addColumnsAsync method. To succeed,
// the table being updated must have three rows.

// Add a column to a binding of type table by passing a TableData object.
function addColumns() {
    const myTable = new Office.TableData();
    myTable.headers = [["Cities"]];
    myTable.rows = [["Berlin"], ["Roma"], ["Tokyo"]];

    Office.context.document.bindings.getByIdAsync("myTable", function (result) {
        result.value.addColumnsAsync(myTable);
    });
}

// The following example adds a single column with three rows to a bound table with the id myTable
// by passing an array of arrays ("matrix") as the data argument of the addColumnsAsync method.
// To succeed, the table being updated must have three rows.

// Add a column to a binding of type table by passing an array of arrays.
function addColumns() {
    const myTable = [["Berlin"], ["Roma"], ["Tokyo"]];

    Office.context.document.bindings.getByIdAsync("myTable", function (result) {
        result.value.addColumnsAsync(myTable);
    });
}

addColumnsAsync(tableData, callback)

Adiciona os dados especificados à tabela como colunas adicionais.

addColumnsAsync(tableData: TableData | any[][], callback?: (result: AsyncResult<void>) => void): void;

Parâmetros

tableData: Office.TableData | any[][]

Uma matriz de matrizes ("matriz") ou um objeto TableData que contém uma ou mais colunas de dados a serem adicionadas à tabela. Obrigatório.

callback: (result: Office.AsyncResult<void>) => void

Opcional. Uma função que é invocada quando o retorno de chamada retorna, cujo único parâmetro é do tipo Office.AsyncResult.

Retornos

void

Comentários

Cada linha na matriz que você passa como o argumento de dados deve ter o mesmo número de linhas que a tabela que está sendo atualizada. Caso contrário, toda a operação falhará.
Cada linha e célula na matriz devem adicionar com êxito essa linha ou célula à tabela nas colunas recém-adicionadas. Se qualquer linha ou célula falhar em ser definida por qualquer motivo, toda a operação falhará.
Se você passar um objeto TableData como o argumento de dados, o número de linhas de cabeçalho deverá corresponder ao da tabela que está sendo atualizada.

Observação adicional para Excel na Web: o número total de células no objeto TableData passado para o parâmetro de dados não pode exceder 20.000 em uma única chamada para esse método.

addRowsAsync(rows, options, callback)

Adiciona os dados especificados à tabela como linhas adicionais.

addRowsAsync(rows: TableData | any[][], options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<void>) => void): void;

Parâmetros

rows: Office.TableData | any[][]

Uma matriz de matrizes ("matriz") ou um objeto TableData que contém uma ou mais linhas de dados a serem adicionadas à tabela. Obrigatório.

options: Office.AsyncContextOptions

Fornece uma opção para preservar dados de contexto de qualquer tipo, inalterados, para uso em um retorno de chamada.

callback: (result: Office.AsyncResult<void>) => void

Opcional. Uma função que é invocada quando o retorno de chamada retorna, cujo único parâmetro é do tipo Office.AsyncResult.

Retornos

void

Comentários

O sucesso ou falha de uma operação addRowsAsync é atômico. Ou seja, toda a operação de adição de colunas deve ter êxito ou ela será completamente revertida (e a propriedade AsyncResult.status retornada para o retorno de chamada relatará a falha):

Cada linha na matriz que você passa como o argumento de dados deve ter o mesmo número de colunas que a tabela que está sendo atualizada. Caso contrário, toda a operação falhará.
Cada coluna e célula na matriz devem adicionar com êxito essa coluna ou célula à tabela nas linhas recém-adicionadas. Se alguma coluna ou célula não for definida por qualquer motivo, toda a operação falhará.
Se você passar um objeto TableData como o argumento de dados, o número de linhas de cabeçalho deverá corresponder ao da tabela que está sendo atualizada.

Observação adicional para Excel na Web: o número total de células no objeto TableData passado para o parâmetro de dados não pode exceder 20.000 em uma única chamada para esse método.

Exemplos

function addRowsToTable() {
    Office.context.document.bindings.getByIdAsync("myBinding", function (asyncResult) {
        const binding = asyncResult.value;
        binding.addRowsAsync([["6", "k"], ["7", "j"]]);
    });
}

addRowsAsync(rows, callback)

Adiciona os dados especificados à tabela como linhas adicionais.

addRowsAsync(rows: TableData | any[][], callback?: (result: AsyncResult<void>) => void): void;

Parâmetros

rows: Office.TableData | any[][]

Uma matriz de matrizes ("matriz") ou um objeto TableData que contém uma ou mais linhas de dados a serem adicionadas à tabela. Obrigatório.

callback: (result: Office.AsyncResult<void>) => void

Opcional. Uma função que é invocada quando o retorno de chamada retorna, cujo único parâmetro é do tipo Office.AsyncResult.

Retornos

void

Comentários

Cada linha na matriz que você passa como o argumento de dados deve ter o mesmo número de colunas que a tabela que está sendo atualizada. Caso contrário, toda a operação falhará.
Cada coluna e célula na matriz devem adicionar com êxito essa coluna ou célula à tabela nas linhas recém-adicionadas. Se alguma coluna ou célula não for definida por qualquer motivo, toda a operação falhará.
Se você passar um objeto TableData como o argumento de dados, o número de linhas de cabeçalho deverá corresponder ao da tabela que está sendo atualizada.

Observação adicional para Excel na Web: o número total de células no objeto TableData passado para o parâmetro de dados não pode exceder 20.000 em uma única chamada para esse método.

clearFormatsAsync(options, callback)

Limpa a formatação na tabela associada.

clearFormatsAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<void>) => void): void;

Parâmetros

options: Office.AsyncContextOptions

Fornece uma opção para preservar dados de contexto de qualquer tipo, inalterados, para uso em um retorno de chamada.

callback: (result: Office.AsyncResult<void>) => void

Opcional. Uma função que é invocada quando o retorno de chamada retorna, cujo único parâmetro é do tipo Office.AsyncResult.

Retornos

void

Comentários

Consulte Formatar tabelas em suplementos para Excel para obter mais informações.

Exemplos

// The following example shows how to clear the formatting of the bound table with an ID of "myBinding":
Office.select("bindings#myBinding").clearFormatsAsync();

clearFormatsAsync(callback)

Limpa a formatação na tabela associada.

clearFormatsAsync(callback?: (result: AsyncResult<void>) => void): void;

Parâmetros

callback: (result: Office.AsyncResult<void>) => void

Opcional. Uma função que é invocada quando o retorno de chamada retorna, cujo único parâmetro é do tipo Office.AsyncResult.

Retornos

void

Comentários

Consulte Formatar tabelas em suplementos para Excel para obter mais informações.

deleteAllDataValuesAsync(options, callback)

Exclui todas as linhas que não são cabeçalho e seus valores na tabela, mudando adequadamente para o aplicativo do Office.

deleteAllDataValuesAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<void>) => void): void;

Parâmetros

options: Office.AsyncContextOptions

Fornece uma opção para preservar dados de contexto de qualquer tipo, inalterados, para uso em um retorno de chamada.

callback: (result: Office.AsyncResult<void>) => void

Opcional. Uma função que é invocada quando o retorno de chamada retorna, cujo único parâmetro é do tipo Office.AsyncResult.

Retornos

void

Comentários

No Excel, se a tabela não tiver nenhuma linha de cabeçalho, esse método excluirá a tabela em si.

Exemplos

function deleteAllRowsFromTable() {
    Office.context.document.bindings.getByIdAsync("myBinding", function (asyncResult) {
        const binding = asyncResult.value;
        binding.deleteAllDataValuesAsync();
    });
}

deleteAllDataValuesAsync(callback)

Exclui todas as linhas que não são cabeçalho e seus valores na tabela, mudando adequadamente para o aplicativo do Office.

deleteAllDataValuesAsync(callback?: (result: AsyncResult<void>) => void): void;

Parâmetros

callback: (result: Office.AsyncResult<void>) => void

Opcional. Uma função que é invocada quando o retorno de chamada retorna, cujo único parâmetro é do tipo Office.AsyncResult.

Retornos

void

Comentários

No Excel, se a tabela não tiver nenhuma linha de cabeçalho, esse método excluirá a tabela em si.

getFormatsAsync(cellReference, formats, options, callback)

Obtém a formatação em itens especificados na tabela.

getFormatsAsync(cellReference?: any, formats?: any[], options?: Office.AsyncContextOptions, callback?: (result: AsyncResult< Array<{ cells: any, format: any}>>) => void): void;

Parâmetros

cellReference: any

Um literal de objeto que contém pares de valor de nome que especificam o intervalo de células para obter formatação.

formats: any[]

Uma matriz que especifica as propriedades de formato a serem obtidos.

options: Office.AsyncContextOptions

Fornece uma opção para preservar dados de contexto de qualquer tipo, inalterados, para uso em um retorno de chamada.

callback: (result: Office.AsyncResult< Array<{ cells: any, format: any}>>) => void

Opcional. Uma função que é invocada quando o retorno de chamada retorna, cujo único parâmetro é do tipo Office.AsyncResult. A value propriedade do resultado é uma matriz que contém um ou mais objetos JavaScript especificando a formatação de suas células correspondentes.

Retornos

void

Comentários

Estrutura de formato retornado

Cada objeto JavaScript na matriz de valor retornado tem este formulário: {cells:{ cell_range }, format:{ format_definition }}

A cells: propriedade especifica o intervalo desejado usando um dos valores a seguir.

Intervalos com suporte na propriedade das células

`cells` configurações de intervalo	Descrição
`{row: n}`	Especifica o intervalo que é a linha nth de dados baseada em zero na tabela.
`{column: n}`	Especifica o intervalo que é a coluna nth de dados baseada em zero na tabela.
`{row: i, column: j}`	Especifica a célula única que é a linha ith e a coluna jth da tabela.
`Office.Table.All`	Especifica a tabela inteira, incluindo cabeçalhos de coluna, dados e totais (se houver).
`Office.Table.Data`	Especifica apenas os dados na tabela (sem cabeçalhos e totais).
`Office.Table.Headers`	Especifica somente a linha de cabeçalho.

A format: propriedade especifica valores que correspondem a um subconjunto das configurações disponíveis na caixa de diálogo Formatar Células no Excel (clique com o botão direito do mouse e selecione Formatar Células ouCélulas de Formato>Inicial>).

getFormatsAsync(cellReference, formats, callback)

Obtém a formatação em itens especificados na tabela.

getFormatsAsync(cellReference?: any, formats?: any[], callback?: (result: AsyncResult< Array<{ cells: any, format: any}>>) => void): void;

Parâmetros

cellReference: any

Um literal de objeto que contém pares de valor de nome que especificam o intervalo de células para obter formatação.

formats: any[]

Uma matriz que especifica as propriedades de formato a serem obtidos.

callback: (result: Office.AsyncResult< Array<{ cells: any, format: any}>>) => void

Retornos

void

Comentários

Estrutura de formato retornado

Cada objeto JavaScript na matriz de valor retornado tem este formulário: {cells:{ cell_range }, format:{ format_definition }}

A cells: propriedade especifica o intervalo desejado usando um dos valores a seguir.

Intervalos com suporte na propriedade das células

`cells` configurações de intervalo	Descrição
`{row: n}`	Especifica o intervalo que é a linha nth de dados baseada em zero na tabela.
`{column: n}`	Especifica o intervalo que é a coluna nth de dados baseada em zero na tabela.
`{row: i, column: j}`	Especifica a célula única que é a linha ith e a coluna jth da tabela.
`Office.Table.All`	Especifica a tabela inteira, incluindo cabeçalhos de coluna, dados e totais (se houver).
`Office.Table.Data`	Especifica apenas os dados na tabela (sem cabeçalhos e totais).
`Office.Table.Headers`	Especifica somente a linha de cabeçalho.

setFormatsAsync(cellFormat, options, callback)

Define a formatação em itens e dados especificados na tabela.

setFormatsAsync(cellFormat: any[], options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<void>) => void): void;

Parâmetros

cellFormat: any[]

Uma matriz que contém um ou mais objetos JavaScript que especificam quais células devem ser alvo e a formatação a ser aplicada a elas.

options: Office.AsyncContextOptions

Fornece uma opção para preservar dados de contexto de qualquer tipo, inalterados, para uso em um retorno de chamada.

callback: (result: Office.AsyncResult<void>) => void

Opcional. Uma função que é invocada quando o retorno de chamada retorna, cujo único parâmetro é do tipo Office.AsyncResult.

Retornos

void

Comentários

Especificando o parâmetro cellFormat

Use o parâmetro cellFormat para definir ou alterar valores de formatação de células, como largura, altura, fonte, plano de fundo, alinhamento e assim por diante. O valor que você passa como o parâmetro cellFormat é uma matriz que contém uma lista de um ou mais objetos JavaScript que especificam quais células devem ser direcionadas (cells:) e os formatos (format:) a serem aplicados a eles.

Cada objeto JavaScript na matriz cellFormat tem este formulário: {cells:{ cell_range }, format:{ format_definition }}

A cells: propriedade especifica o intervalo desejado usando um dos valores a seguir.

Intervalos com suporte na propriedade das células

`cells` configurações de intervalo	Descrição
`{row: n}`	Especifica o intervalo que é a linha nth de dados baseada em zero na tabela.
`{column: n}`	Especifica o intervalo que é a coluna nth de dados baseada em zero na tabela.
`{row: i, column: j}`	Especifica a célula única que é a linha ith e a coluna jth da tabela.
`Office.Table.All`	Especifica a tabela inteira, incluindo cabeçalhos de coluna, dados e totais (se houver).
`Office.Table.Data`	Especifica apenas os dados na tabela (sem cabeçalhos e totais).
`Office.Table.Headers`	Especifica somente a linha de cabeçalho.

Especifique o valor da format: propriedade como uma lista de um ou mais pares de valor em um literal de objeto JavaScript. O nome da propriedade especifica o nome da propriedade de formatação para definir, e valor especifica o valor da propriedade. Você pode especificar vários valores para um determinado formato, como cor e tamanho da fonte.

Aqui estão três exemplos de valor da propriedade format::

//Set cells: font color to green and size to 15 points.

format: {fontColor : "green", fontSize : 15}

//Set cells: border to dotted blue.

format: {borderStyle: "dotted", borderColor: "blue"}

//Set cells: background to red and alignment to centered.

format: {backgroundColor: "red", alignHorizontal: "center"}

Você pode especificar formatos de número especificando a cadeia de caracteres "code" de formatação de número na numberFormat: propriedade. As cadeias de caracteres de formato de número que podem ser especificadas correspondem àquelas que você pode definir no Excel usando a categoria Personalizado na guia Número da caixa de diálogo Formatar Células. Este exemplo mostra como formatar um número como um percentual com duas casas decimais:

format: {numberFormat:"0.00%"}

Para obter mais detalhes, confira como Create um formato de número personalizado.

Para definir a formatação em tabelas ao gravar dados, use os parâmetros opcionais tableOptions e cellFormat dos Document.setSelectedDataAsync métodos ou TableBinding.setDataAsync .

Definir a formatação com os parâmetros opcionais dos Document.setSelectedDataAsync métodos e TableBinding.setDataAsync funciona apenas para definir a formatação ao gravar dados pela primeira vez. Para fazer alterações de formatação após a gravação de dados, use os métodos a seguir.

Para atualizar a formatação de células, como cor e estilo de fonte, use o TableBinding.setFormatsAsync método (este método).
Para atualizar opções de tabela, como linhas agrupadas e botões de filtro, use o TableBinding.setTableOptions método.
Para limpar a formatação, use o TableBinding.clearFormats método.

Para obter mais detalhes e exemplos, consulte Como formatar tabelas em suplementos para Excel.

Exemplos

// Specifying a single target
// The following example shows a cellFormat value that sets the font color of the header row to red.
Office.select("bindings#myBinding").setFormatsAsync(
    [{cells: Office.Table.Headers, format: {fontColor: "red"}}], 
    function (asyncResult){});

// Specifying multiple targets
// The setFormatsAsync method can support formatting multiple targets within the bound table in a 
// single function call. To do that, you pass a list of objects in the cellFormat array 
// for each target that you want to format.
// For example, the following line of code will set the font color of the first row yellow, 
// and the fourth cell in the third row to have a white border and bold text.
Office.select("bindings#myBinding").setFormatsAsync(
    [{cells: {row: 1}, format: {fontColor: "yellow"}}, 
        {cells: {row: 3, column: 4}, format: {borderColor: "white", fontStyle: "bold"}}], 
    function (asyncResult){});

// Additional remarks for Excel Online
// The number of formatting groups passed to the cellFormat parameter can't exceed 100. 
// A single formatting group consists of a set of formatting applied to a specified range of cells. 
// For example, the following call passes two formatting groups to cellFormat.
Office.select("bindings#myBinding").setFormatsAsync(
    [{cells: {row: 1}, format: {fontColor: "yellow"}}, 
        {cells: {row: 3, column: 4}, format: {borderColor: "white", fontStyle: "bold"}}], 
    function (asyncResult){});

setFormatsAsync(cellFormat, callback)

Define a formatação em itens e dados especificados na tabela.

setFormatsAsync(cellFormat: any[], callback?: (result: AsyncResult<void>) => void): void;

Parâmetros

cellFormat: any[]

Uma matriz que contém um ou mais objetos JavaScript que especificam quais células devem ser alvo e a formatação a ser aplicada a elas.

callback: (result: Office.AsyncResult<void>) => void

Opcional. Uma função que é invocada quando o retorno de chamada retorna, cujo único parâmetro é do tipo Office.AsyncResult.

Retornos

void

Comentários

Especificando o parâmetro cellFormat

Cada objeto JavaScript na matriz cellFormat tem este formulário: {cells:{ cell_range }, format:{ format_definition }}

A cells: propriedade especifica o intervalo desejado usando um dos valores a seguir.

Intervalos com suporte na propriedade das células

`cells` configurações de intervalo	Descrição
`{row: n}`	Especifica o intervalo que é a linha nth de dados baseada em zero na tabela.
`{column: n}`	Especifica o intervalo que é a coluna nth de dados baseada em zero na tabela.
`{row: i, column: j}`	Especifica a célula única que é a linha ith e a coluna jth da tabela.
`Office.Table.All`	Especifica a tabela inteira, incluindo cabeçalhos de coluna, dados e totais (se houver).
`Office.Table.Data`	Especifica apenas os dados na tabela (sem cabeçalhos e totais).
`Office.Table.Headers`	Especifica somente a linha de cabeçalho.

Aqui estão três exemplos de valor da propriedade format::

//Set cells: font color to green and size to 15 points.

format: {fontColor : "green", fontSize : 15}

//Set cells: border to dotted blue.

format: {borderStyle: "dotted", borderColor: "blue"}

//Set cells: background to red and alignment to centered.

format: {backgroundColor: "red", alignHorizontal: "center"}

format: {numberFormat:"0.00%"}

Para obter mais detalhes, confira como Create um formato de número personalizado.

Para definir a formatação em tabelas ao gravar dados, use os parâmetros opcionais tableOptions e cellFormat dos Document.setSelectedDataAsync métodos ou TableBinding.setDataAsync .

Para atualizar a formatação de células, como cor e estilo de fonte, use o TableBinding.setFormatsAsync método (este método).
Para atualizar opções de tabela, como linhas agrupadas e botões de filtro, use o TableBinding.setTableOptions método.
Para limpar a formatação, use o TableBinding.clearFormats método.

Para obter mais detalhes e exemplos, consulte Como formatar tabelas em suplementos para Excel.

setTableOptionsAsync(tableOptions, options, callback)

Atualiza as opções de formatação de tabela na tabela associada.

setTableOptionsAsync(tableOptions: any, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<void>) => void): void;

Parâmetros

tableOptions: any

Um literal de objeto que contém uma lista de pares nome-valor da propriedade que definem as opções de tabela a serem aplicadas.

options: Office.AsyncContextOptions

Fornece uma opção para preservar dados de contexto de qualquer tipo, inalterados, para uso em um retorno de chamada.

callback: (result: Office.AsyncResult<void>) => void

Opcional. Uma função que é invocada quando o retorno de chamada retorna, cujo único parâmetro é do tipo Office.AsyncResult.

Retornos

void

Comentários

Conjunto de requisitos: não em um conjunto

Na função de retorno de chamada passada para o método goToByIdAsync, você pode usar as propriedades do objeto AsyncResult para retornar as informações a seguir.

Propriedade	Usar
`AsyncResult.value`	Sempre retorna `undefined` porque não há dados ou objeto a ser recuperado ao definir formatos.
`AsyncResult.status`	Determinar o sucesso ou falha da operação.
`AsyncResult.error`	Acessar um objeto Error que fornecerá informações de erro se a operação tiver falhado.
`AsyncResult.asyncContext`	Defina um item de qualquer tipo retornado no objeto AsyncResult sem ser alterado.

Exemplos

// The following example shows how to:
// 1. Create an object literal that specifies the table formatting options to update on the bound table.
// 2. Call setTableOptions on a previously bound table (with an id of myBinding) passing the object
//    with formatting setting as the tableOptions parameter.
function updateTableFormatting(){
    const tableOptions = {bandedRows: true, filterButton: false, style: "TableStyleMedium3"}; 

    Office.select("bindings#myBinding").setTableOptionsAsync(tableOptions, function(asyncResult){});
}

setTableOptionsAsync(tableOptions, callback)

Atualiza as opções de formatação de tabela na tabela associada.

setTableOptionsAsync(tableOptions: any, callback?: (result: AsyncResult<void>) => void): void;

Parâmetros

tableOptions: any

Um literal de objeto que contém uma lista de pares nome-valor da propriedade que definem as opções de tabela a serem aplicadas.

callback: (result: Office.AsyncResult<void>) => void

Opcional. Uma função que é invocada quando o retorno de chamada retorna, cujo único parâmetro é do tipo Office.AsyncResult.

Retornos

void

Comentários

Conjunto de requisitos: não em um conjunto

Na função de retorno de chamada passada para o método goToByIdAsync, você pode usar as propriedades do objeto AsyncResult para retornar as informações a seguir.

Propriedade	Usar
`AsyncResult.value`	Sempre retorna `undefined` porque não há dados ou objeto a ser recuperado ao definir formatos.
`AsyncResult.status`	Determinar o sucesso ou falha da operação.
`AsyncResult.error`	Acessar um objeto Error que fornecerá informações de erro se a operação tiver falhado.
`AsyncResult.asyncContext`	Defina um item de qualquer tipo retornado no objeto AsyncResult sem ser alterado.

Office.TableBinding interface

Comentários

Propriedades

Métodos

Detalhes da propriedade

columnCount

Valor da propriedade

Exemplos

hasHeaders

Valor da propriedade

Exemplos

rowCount

Valor da propriedade

Comentários

Exemplos

Detalhes do método

addColumnsAsync(tableData, options, callback)

Parâmetros

Retornos

Comentários

Exemplos

addColumnsAsync(tableData, callback)

Parâmetros

Retornos

Comentários

addRowsAsync(rows, options, callback)

Parâmetros

Retornos

Comentários

Exemplos

addRowsAsync(rows, callback)

Parâmetros

Retornos

Comentários

clearFormatsAsync(options, callback)

Parâmetros

Retornos

Comentários

Exemplos

clearFormatsAsync(callback)

Parâmetros

Retornos

Comentários

deleteAllDataValuesAsync(options, callback)

Parâmetros

Retornos

Comentários

Exemplos

deleteAllDataValuesAsync(callback)

Parâmetros

Retornos

Comentários

getFormatsAsync(cellReference, formats, options, callback)

Parâmetros

Retornos

Comentários

getFormatsAsync(cellReference, formats, callback)

Parâmetros

Retornos

Comentários

setFormatsAsync(cellFormat, options, callback)

Parâmetros

Retornos

Comentários

Exemplos

setFormatsAsync(cellFormat, callback)

Parâmetros

Retornos

Comentários

setTableOptionsAsync(tableOptions, options, callback)

Parâmetros

Retornos

Comentários

Exemplos

setTableOptionsAsync(tableOptions, callback)

Parâmetros

Retornos

Comentários

Comentários

Recursos adicionais