Office.TableBinding interface

Пакет:
office

Представляет привязку в двух измерениях строк и столбцов, куда при желании можно добавить заголовки.

Extends
Office.Binding

Комментарии

Объект TableBinding наследует свойствоtype, свойство idgetDataAsync, метод и setDataAsync метод от объекта Office.Binding.

При работе с Excel обратите внимание, что после установки привязки таблицы каждая новая строка, добавляемая пользователем в таблицу, автоматически включается в привязку, а значение rowCount увеличивается.

Свойства

columnCount

Получает количество столбцов в TableBinding в виде целочисленного значения.
hasHeaders

True, если в таблице есть заголовки; в противном случае false.
rowCount

Получает количество строк в TableBinding в виде целочисленного значения.

Методы

addColumnsAsync(tableData, options, callback)

Добавляет указанные данные в таблицу в виде дополнительных столбцов.
addColumnsAsync(tableData, callback)

Добавляет указанные данные в таблицу в виде дополнительных столбцов.
addRowsAsync(rows, options, callback)

Добавляет указанные данные в таблицу в виде дополнительных строк.
addRowsAsync(rows, callback)

Добавляет указанные данные в таблицу в виде дополнительных строк.
clearFormatsAsync(options, callback)

Очищает форматирование в привязанной таблице.
clearFormatsAsync(callback)

Очищает форматирование в привязанной таблице.
deleteAllDataValuesAsync(options, callback)

Удаляет из таблицы все строки без заголовков и их значения, соответствующее изменению для приложения Office.
deleteAllDataValuesAsync(callback)

Удаляет из таблицы все строки без заголовков и их значения, соответствующее изменению для приложения Office.
getFormatsAsync(cellReference, formats, options, callback)

Получает форматирование указанных элементов таблицы.
getFormatsAsync(cellReference, formats, callback)

Получает форматирование указанных элементов таблицы.
setFormatsAsync(cellFormat, options, callback)

Задает форматирование указанных элементов и данных в таблице.
setFormatsAsync(cellFormat, callback)

Задает форматирование указанных элементов и данных в таблице.
setTableOptionsAsync(tableOptions, options, callback)

Обновляет параметры форматирования привязанной таблицы.
setTableOptionsAsync(tableOptions, callback)

Обновляет параметры форматирования привязанной таблицы.

Сведения о свойстве

columnCount

Получает количество столбцов в TableBinding в виде целочисленного значения.

columnCount: number;

Значение свойства

number

Примеры

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, если в таблице есть заголовки; в противном случае false.

hasHeaders: boolean;

Значение свойства

boolean

Примеры

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

Получает количество строк в TableBinding в виде целочисленного значения.

rowCount: number;

Значение свойства

number

Комментарии

При вставке пустой таблицы путем выделения одной строки в Excel на компьютере и в Excel в Интернете (с помощью команды "Таблица" на вкладке "Вставка") оба приложения Office создают одну строку заголовков, за которой следует одна пустая строка. Однако если сценарий надстройки создает привязку для этой вставленной таблицы (например, с помощью метода Office.Bindings.addFromSelectionAsync), а затем проверяет значение свойства rowCount, возвращаемое значение будет отличаться в зависимости от того, открыта ли электронная таблица в Excel на настольном компьютере или в Excel в Интернете.

  • В классической версии Excel (например, в Windows и Mac) функция rowCount возвращает 0 (пустая строка, идущая после заголовков, не учитывается).

  • В Excel в Интернете функция rowCount возвращает значение 1 (учитывается пустая строка, идущая после заголовков).

Чтобы избежать разницы в сценарии, проверьте значение rowCount == 1, если да, проверьте все ли строки являются незаполненными.

Примеры

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;
}

Сведения о методе

addColumnsAsync(tableData, options, callback)

Добавляет указанные данные в таблицу в виде дополнительных столбцов.

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

Параметры

tableData

Office.TableData | any[][]

Массив массивов ("матрица") или объект TableData, содержащий один или несколько столбцов данных для добавления в таблицу. Обязательно.

options
Office.AsyncContextOptions

Предоставляет возможность сохранения контекстных данных любого типа без изменений для использования в обратном вызове.

callback

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

Необязательный параметр. Функция, вызываемая при возврате обратного вызова, единственный параметр которой имеет тип Office.AsyncResult.

Возвращаемое значение

void

Комментарии

Чтобы добавить один или несколько столбцов, указывающих значения данных и заголовков, передайте объект TableData в качестве параметра data. Чтобы добавить один или несколько столбцов только с данными, передайте в качестве параметра data массив массивов ("матрицу").

Успех или неудача операции addColumnsAsync является атомарным. То есть либо вся операция добавления столбцов выполняется успешно, либо происходит полный откат (и свойство AsyncResult.status, возвращенное в обратный вызов, будет содержать сведения об ошибке).

  • Каждая строка массива, передаваемого в качестве аргумента данных, должна состоять из такого же количества строк, что и обновляемая таблица. В противном случае вся операция завершится ошибкой.

  • Каждая строка и ячейка массива должны быть успешно добавлены в таблицу в новых столбцах. Если какая-либо строка или ячейка по какой-то причине не добавляется, вся операция завершается ошибкой.

  • Если в качестве аргумента данных передается объект TableData, количество строк заголовка должно соответствовать числу строк обновляемой таблицы.

Дополнительное примечание касательно Excel в Интернете: общее количество ячеек в объекте TableData, передаваемом в параметр data, не может превышать 20 000 за один вызов этого метода.

Примеры

// 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)

Добавляет указанные данные в таблицу в виде дополнительных столбцов.

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

Параметры

tableData

Office.TableData | any[][]

Массив массивов ("матрица") или объект TableData, содержащий один или несколько столбцов данных для добавления в таблицу. Обязательно.

callback

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

Необязательный параметр. Функция, вызываемая при возврате обратного вызова, единственный параметр которой имеет тип Office.AsyncResult.

Возвращаемое значение

void

Комментарии

Чтобы добавить один или несколько столбцов, указывающих значения данных и заголовков, передайте объект TableData в качестве параметра data. Чтобы добавить один или несколько столбцов только с данными, передайте в качестве параметра data массив массивов ("матрицу").

Успех или неудача операции addColumnsAsync является атомарным. То есть либо вся операция добавления столбцов выполняется успешно, либо происходит полный откат (и свойство AsyncResult.status, возвращенное в обратный вызов, будет содержать сведения об ошибке).

  • Каждая строка массива, передаваемого в качестве аргумента данных, должна состоять из такого же количества строк, что и обновляемая таблица. В противном случае вся операция завершится ошибкой.

  • Каждая строка и ячейка массива должны быть успешно добавлены в таблицу в новых столбцах. Если какая-либо строка или ячейка по какой-то причине не добавляется, вся операция завершается ошибкой.

  • Если в качестве аргумента данных передается объект TableData, количество строк заголовка должно соответствовать числу строк обновляемой таблицы.

Дополнительное примечание касательно Excel в Интернете: общее количество ячеек в объекте TableData, передаваемом в параметр data, не может превышать 20 000 за один вызов этого метода.

addRowsAsync(rows, options, callback)

Добавляет указанные данные в таблицу в виде дополнительных строк.

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

Параметры

rows

Office.TableData | any[][]

Массив массивов ("matrix") или объект TableData, содержащий одну или несколько строк данных для добавления в таблицу. Обязательно.

options
Office.AsyncContextOptions

Предоставляет возможность сохранения контекстных данных любого типа без изменений для использования в обратном вызове.

callback

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

Необязательный параметр. Функция, вызываемая при возврате обратного вызова, единственный параметр которой имеет тип Office.AsyncResult.

Возвращаемое значение

void

Комментарии

Успех или неудача операции addRowsAsync является атомарным. То есть либо вся операция добавления столбцов выполняется успешно, либо происходит полный откат (и свойство AsyncResult.status, возвращенное в обратный вызов, будет содержать сведения об ошибке).

  • Каждая строка в массиве, передаваемая в качестве аргумента данных, должна иметь такое же количество столбцов, что и обновляемая таблица. В противном случае вся операция завершится ошибкой.

  • Каждый столбец и ячейка в массиве должны быть успешно добавлены в таблицу в новых строках. Если по какой-либо причине не удастся задать какой-либо столбец или ячейку, вся операция завершится ошибкой.

  • Если в качестве аргумента данных передается объект TableData, количество строк заголовка должно соответствовать числу строк обновляемой таблицы.

Дополнительное примечание касательно Excel в Интернете: общее количество ячеек в объекте TableData, передаваемом в параметр data, не может превышать 20 000 за один вызов этого метода.

Примеры

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

addRowsAsync(rows, callback)

Добавляет указанные данные в таблицу в виде дополнительных строк.

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

Параметры

rows

Office.TableData | any[][]

Массив массивов ("matrix") или объект TableData, содержащий одну или несколько строк данных для добавления в таблицу. Обязательно.

callback

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

Необязательный параметр. Функция, вызываемая при возврате обратного вызова, единственный параметр которой имеет тип Office.AsyncResult.

Возвращаемое значение

void

Комментарии

Успех или неудача операции addRowsAsync является атомарным. То есть либо вся операция добавления столбцов выполняется успешно, либо происходит полный откат (и свойство AsyncResult.status, возвращенное в обратный вызов, будет содержать сведения об ошибке).

  • Каждая строка в массиве, передаваемая в качестве аргумента данных, должна иметь такое же количество столбцов, что и обновляемая таблица. В противном случае вся операция завершится ошибкой.

  • Каждый столбец и ячейка в массиве должны быть успешно добавлены в таблицу в новых строках. Если по какой-либо причине не удастся задать какой-либо столбец или ячейку, вся операция завершится ошибкой.

  • Если в качестве аргумента данных передается объект TableData, количество строк заголовка должно соответствовать числу строк обновляемой таблицы.

Дополнительное примечание касательно Excel в Интернете: общее количество ячеек в объекте TableData, передаваемом в параметр data, не может превышать 20 000 за один вызов этого метода.

clearFormatsAsync(options, callback)

Очищает форматирование в привязанной таблице.

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

Параметры

options
Office.AsyncContextOptions

Предоставляет возможность сохранения контекстных данных любого типа без изменений для использования в обратном вызове.

callback

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

Необязательный параметр. Функция, вызываемая при возврате обратного вызова, единственный параметр которой имеет тип Office.AsyncResult.

Возвращаемое значение

void

Комментарии

Дополнительные сведения см. в статье Форматирование таблиц в надстройках для Excel .

Примеры

// 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)

Очищает форматирование в привязанной таблице.

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

Параметры

callback

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

Необязательный параметр. Функция, вызываемая при возврате обратного вызова, единственный параметр которой имеет тип Office.AsyncResult.

Возвращаемое значение

void

Комментарии

Дополнительные сведения см. в статье Форматирование таблиц в надстройках для Excel .

deleteAllDataValuesAsync(options, callback)

Удаляет из таблицы все строки без заголовков и их значения, соответствующее изменению для приложения Office.

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

Параметры

options
Office.AsyncContextOptions

Предоставляет возможность сохранения контекстных данных любого типа без изменений для использования в обратном вызове.

callback

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

Необязательный параметр. Функция, вызываемая при возврате обратного вызова, единственный параметр которой имеет тип Office.AsyncResult.

Возвращаемое значение

void

Комментарии

В Excel, если в таблице нет строки заголовка, этот метод удалит всю таблицу.

Примеры

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

deleteAllDataValuesAsync(callback)

Удаляет из таблицы все строки без заголовков и их значения, соответствующее изменению для приложения Office.

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

Параметры

callback

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

Необязательный параметр. Функция, вызываемая при возврате обратного вызова, единственный параметр которой имеет тип Office.AsyncResult.

Возвращаемое значение

void

Комментарии

В Excel, если в таблице нет строки заголовка, этот метод удалит всю таблицу.

getFormatsAsync(cellReference, formats, options, callback)

Получает форматирование указанных элементов таблицы.

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

Параметры

cellReference

any

Литерал объекта, содержащий пары имя-значение, определяющие диапазон ячеек для получения форматирования.

formats

any[]

Массив, определяющий свойства формата, которые нужно получить.

options
Office.AsyncContextOptions

Предоставляет возможность сохранения контекстных данных любого типа без изменений для использования в обратном вызове.

callback

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

Необязательный параметр. Функция, вызываемая при возврате обратного вызова, единственный параметр которой имеет тип Office.AsyncResult. Свойством value результата является массив, содержащий один или несколько объектов JavaScript с указанием форматирования соответствующих ячеек.

Возвращаемое значение

void

Комментарии

Возвращаемая структура формата

Каждый объект JavaScript в массиве возвращаемых значений имеет такую форму: {cells:{ cell_range }, format:{ format_definition }}

Свойство cells: задает диапазон, который требуется отформатировать, с помощью одного из следующих значений.

Поддерживаемые диапазоны в свойстве ячеек

cells Параметры диапазона Описание
{row: n} Диапазон, который представляет собой отсчитываемую от нуля n-ю строку данных таблицы.
{column: n} Указывает диапазон, который является n-м столбцом данных, отсчитывающим от нуля, в таблице.
{row: i, column: j} Указывает единственную ячейку, которая является i-й строкой и j-м столбцом таблицы.
Office.Table.All Указывает всю таблицу, включая заголовки столбцов, данные и итоги (если они имеются)
Office.Table.Data Указывает только данные в таблице (без заголовков и итогов).
Office.Table.Headers Указывает только строку заголовков.

Свойство format: задает значения, соответствующие подмножеству параметров, доступных в диалоговом окне "Формат ячеек" в Excel (откройте контекстное меню (щелкните правой кнопкой мыши или нажмите и удерживайте), затем выберите "Формат ячеек" или"Формат>ячеекдома").>

getFormatsAsync(cellReference, formats, callback)

Получает форматирование указанных элементов таблицы.

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

Параметры

cellReference

any

Литерал объекта, содержащий пары имя-значение, определяющие диапазон ячеек для получения форматирования.

formats

any[]

Массив, определяющий свойства формата, которые нужно получить.

callback

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

Необязательный параметр. Функция, вызываемая при возврате обратного вызова, единственный параметр которой имеет тип Office.AsyncResult. Свойством value результата является массив, содержащий один или несколько объектов JavaScript с указанием форматирования соответствующих ячеек.

Возвращаемое значение

void

Комментарии

Возвращаемая структура формата

Каждый объект JavaScript в массиве возвращаемых значений имеет такую форму: {cells:{ cell_range }, format:{ format_definition }}

Свойство cells: задает диапазон, который требуется отформатировать, с помощью одного из следующих значений.

Поддерживаемые диапазоны в свойстве ячеек

cells Параметры диапазона Описание
{row: n} Диапазон, который представляет собой отсчитываемую от нуля n-ю строку данных таблицы.
{column: n} Указывает диапазон, который является n-м столбцом данных, отсчитывающим от нуля, в таблице.
{row: i, column: j} Указывает единственную ячейку, которая является i-й строкой и j-м столбцом таблицы.
Office.Table.All Указывает всю таблицу, включая заголовки столбцов, данные и итоги (если они имеются)
Office.Table.Data Указывает только данные в таблице (без заголовков и итогов).
Office.Table.Headers Указывает только строку заголовков.

Свойство format: задает значения, соответствующие подмножеству параметров, доступных в диалоговом окне "Формат ячеек" в Excel (откройте контекстное меню (щелкните правой кнопкой мыши или нажмите и удерживайте), затем выберите "Формат ячеек" или"Формат>ячеекдома").>

setFormatsAsync(cellFormat, options, callback)

Задает форматирование указанных элементов и данных в таблице.

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

Параметры

cellFormat

any[]

Массив, содержащий один или несколько объектов JavaScript, указывающих целевые ячейки и форматирование, которое необходимо к ним применить.

options
Office.AsyncContextOptions

Предоставляет возможность сохранения контекстных данных любого типа без изменений для использования в обратном вызове.

callback

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

Необязательный параметр. Функция, вызываемая при возврате обратного вызова, единственный параметр которой имеет тип Office.AsyncResult.

Возвращаемое значение

void

Комментарии

Указание параметра cellFormat

Используйте параметр cellFormat для установки или изменения значений форматирования ячеек, таких как ширина, высота, шрифт, фон, выравнивание и т. д. Значение, которое вы передаете в качестве параметра cellFormat, представляет собой массив, содержащий список одного или нескольких объектов JavaScript, которые указывают, для каких ячеек использовать (cells:), и форматы (format:), которые к ним применить.

Каждый объект JavaScript в массиве cellFormat имеет следующую форму: {cells:{ cell_range }, format:{ format_definition }}

Свойство cells: задает диапазон, который требуется отформатировать, с помощью одного из следующих значений.

Поддерживаемые диапазоны в свойстве ячеек

cells Параметры диапазона Описание
{row: n} Диапазон, который представляет собой отсчитываемую от нуля n-ю строку данных таблицы.
{column: n} Указывает диапазон, который является n-м столбцом данных, отсчитывающим от нуля, в таблице.
{row: i, column: j} Указывает единственную ячейку, которая является i-й строкой и j-м столбцом таблицы.
Office.Table.All Указывает всю таблицу, включая заголовки столбцов, данные и итоги (если они имеются)
Office.Table.Data Указывает только данные в таблице (без заголовков и итогов).
Office.Table.Headers Указывает только строку заголовков.

Свойство format: задает значения, соответствующие подмножеству параметров, доступных в диалоговом окне "Формат ячеек" в Excel (откройте контекстное меню (щелкните правой кнопкой мыши или нажмите и удерживайте), затем выберите "Формат ячеек" или"Формат>ячеекдома").>

Значение format: свойства указывается в виде списка одной или нескольких пар "имя - значение" в литерале объекта JavaScript. Имя свойства обозначает имя устанавливаемого свойства, а значение — значение этого свойства. Вы можете указать несколько значений формата, например цвет и размер шрифта.

Ниже приводятся три примера значений свойства 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"}

Числовые форматы можно задать, указав строку "код" формата числа в свойстве numberFormat: . Строки формата чисел, которые можно указывать, соответствуют параметрам Excel, доступным в категории Дополнительный на вкладке Число диалогового окна Формат ячеек. В этом примере показано, как отформатировать число в виде процентного значения с двумя десятичными знаками:

format: {numberFormat:"0.00%"}

Дополнительные сведения см. в статье "Создание пользовательского числового формата".

Чтобы задать форматирование таблиц при записи данных, используйте необязательные параметры tableOptions и cellFormat методов or Document.setSelectedDataAsyncTableBinding.setDataAsync .

Настройка форматирования с помощью необязательных Document.setSelectedDataAsync параметров методов and TableBinding.setDataAsync работает только для настройки форматирования при первой записи данных. Чтобы изменить форматирование после записи данных, используйте указанные ниже способы.

  • Чтобы обновить форматирование ячеек, например цвет и стиль шрифта, используйте TableBinding.setFormatsAsync метод (этот метод).

  • Чтобы обновить параметры таблицы, такие как чередование строк и кнопки фильтрации, используйте этот TableBinding.setTableOptions метод.

  • Чтобы очистить форматирование, используйте этот TableBinding.clearFormats метод.

Дополнительные сведения и примеры см. в статье "Как форматировать таблицы в надстройках для Excel".

Примеры

// 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)

Задает форматирование указанных элементов и данных в таблице.

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

Параметры

cellFormat

any[]

Массив, содержащий один или несколько объектов JavaScript, указывающих целевые ячейки и форматирование, которое необходимо к ним применить.

callback

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

Необязательный параметр. Функция, вызываемая при возврате обратного вызова, единственный параметр которой имеет тип Office.AsyncResult.

Возвращаемое значение

void

Комментарии

Указание параметра cellFormat

Используйте параметр cellFormat для установки или изменения значений форматирования ячеек, таких как ширина, высота, шрифт, фон, выравнивание и т. д. Значение, которое вы передаете в качестве параметра cellFormat, представляет собой массив, содержащий список одного или нескольких объектов JavaScript, которые указывают, для каких ячеек использовать (cells:), и форматы (format:), которые к ним применить.

Каждый объект JavaScript в массиве cellFormat имеет следующую форму: {cells:{ cell_range }, format:{ format_definition }}

Свойство cells: задает диапазон, который требуется отформатировать, с помощью одного из следующих значений.

Поддерживаемые диапазоны в свойстве ячеек

cells Параметры диапазона Описание
{row: n} Диапазон, который представляет собой отсчитываемую от нуля n-ю строку данных таблицы.
{column: n} Указывает диапазон, который является n-м столбцом данных, отсчитывающим от нуля, в таблице.
{row: i, column: j} Указывает единственную ячейку, которая является i-й строкой и j-м столбцом таблицы.
Office.Table.All Указывает всю таблицу, включая заголовки столбцов, данные и итоги (если они имеются)
Office.Table.Data Указывает только данные в таблице (без заголовков и итогов).
Office.Table.Headers Указывает только строку заголовков.

Свойство format: задает значения, соответствующие подмножеству параметров, доступных в диалоговом окне "Формат ячеек" в Excel (откройте контекстное меню (щелкните правой кнопкой мыши или нажмите и удерживайте), затем выберите "Формат ячеек" или"Формат>ячеекдома").>

Значение format: свойства указывается в виде списка одной или нескольких пар "имя - значение" в литерале объекта JavaScript. Имя свойства обозначает имя устанавливаемого свойства, а значение — значение этого свойства. Вы можете указать несколько значений формата, например цвет и размер шрифта.

Ниже приводятся три примера значений свойства 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"}

Числовые форматы можно задать, указав строку "код" формата числа в свойстве numberFormat: . Строки формата чисел, которые можно указывать, соответствуют параметрам Excel, доступным в категории Дополнительный на вкладке Число диалогового окна Формат ячеек. В этом примере показано, как отформатировать число в виде процентного значения с двумя десятичными знаками:

format: {numberFormat:"0.00%"}

Дополнительные сведения см. в статье "Создание пользовательского числового формата".

Чтобы задать форматирование таблиц при записи данных, используйте необязательные параметры tableOptions и cellFormat методов or Document.setSelectedDataAsyncTableBinding.setDataAsync .

Настройка форматирования с помощью необязательных Document.setSelectedDataAsync параметров методов and TableBinding.setDataAsync работает только для настройки форматирования при первой записи данных. Чтобы изменить форматирование после записи данных, используйте указанные ниже способы.

  • Чтобы обновить форматирование ячеек, например цвет и стиль шрифта, используйте TableBinding.setFormatsAsync метод (этот метод).

  • Чтобы обновить параметры таблицы, такие как чередование строк и кнопки фильтрации, используйте этот TableBinding.setTableOptions метод.

  • Чтобы очистить форматирование, используйте этот TableBinding.clearFormats метод.

Дополнительные сведения и примеры см. в статье "Как форматировать таблицы в надстройках для Excel".

setTableOptionsAsync(tableOptions, options, callback)

Обновляет параметры форматирования привязанной таблицы.

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

Параметры

tableOptions

any

Литерал объекта, содержащий список пар "имя-значение" для свойств, определяющих применяемые параметры таблицы.

options
Office.AsyncContextOptions

Предоставляет возможность сохранения контекстных данных любого типа без изменений для использования в обратном вызове.

callback

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

Необязательный параметр. Функция, вызываемая при возврате обратного вызова, единственный параметр которой имеет тип Office.AsyncResult.

Возвращаемое значение

void

Комментарии

Набор требований: Нет в наборе

В функции обратного вызова, переданной методу goToByIdAsync, вы можете использовать свойства объекта AsyncResult, чтобы получить следующие сведения.

Property Использовать
AsyncResult.value Всегда возвращает undefined , так как при настройке форматов нет данных или объектов, которые можно было бы извлечь.
AsyncResult.status Определяет, удалось ли выполнить операцию.
AsyncResult.error Доступ к объекту Error, который предоставляет сведения об ошибке, если операция завершилась неудачно.
AsyncResult.asyncContext Определите элемент любого типа, возвращаемый в объекте AsyncResult без изменений.

Примеры

// 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)

Обновляет параметры форматирования привязанной таблицы.

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

Параметры

tableOptions

any

Литерал объекта, содержащий список пар "имя-значение" для свойств, определяющих применяемые параметры таблицы.

callback

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

Необязательный параметр. Функция, вызываемая при возврате обратного вызова, единственный параметр которой имеет тип Office.AsyncResult.

Возвращаемое значение

void

Комментарии

Набор требований: Нет в наборе

В функции обратного вызова, переданной методу goToByIdAsync, вы можете использовать свойства объекта AsyncResult, чтобы получить следующие сведения.

Property Использовать
AsyncResult.value Всегда возвращает undefined , так как при настройке форматов нет данных или объектов, которые можно было бы извлечь.
AsyncResult.status Определяет, удалось ли выполнить операцию.
AsyncResult.error Доступ к объекту Error, который предоставляет сведения об ошибке, если операция завершилась неудачно.
AsyncResult.asyncContext Определите элемент любого типа, возвращаемый в объекте AsyncResult без изменений.