Excel.TableRowCollection class

Представляет коллекцию всех строк, включенных в таблицу.

Обратите внимание, что в отличие от диапазонов или столбцов, которые будут корректировать добавление новых строк или столбцов перед ними, TableRow объект представляет физическое расположение строки таблицы, но не данных. Это означает, что при сортировке данных или добавлении новых строк строка таблицы будет по-прежнему указывать на индекс, для которого она была создана.

Свойства

context	Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office.
count	Возвращает количество строк в таблице.
items	Получает загруженные дочерние элементы в этой коллекции.

Методы

add(index, values, alwaysInsert)	Добавляет одну или несколько строк в таблицу. Возвращается объект, находящийся над новыми строками. Обратите внимание, что в отличие от диапазонов или столбцов, которые будут корректировать добавление новых строк или столбцов перед ними, `TableRow` объект представляет физическое расположение строки таблицы, но не данных. Это означает, что при сортировке данных или добавлении новых строк строка таблицы будет по-прежнему указывать на индекс, для которого она была создана.
addAsJson(index, values, alwaysInsert)	Добавляет одну или несколько строк в таблицу. Возвращаемый объект будет представлять собой верхнюю строку только что добавленной строки или строк. В отличие от `add()`, `addAsJson()` принимает любой тип значения ячейки, например тип данных изображения или сущности. Обратите внимание, что в отличие от диапазонов или столбцов, которые будут корректировать добавление новых строк или столбцов перед ними, `TableRow` объект представляет физическое расположение строки таблицы, но не данных. Это означает, что при сортировке данных или добавлении новых строк строка таблицы будет по-прежнему указывать на индекс, для которого она была создана.
deleteRows(rows)	Удаление нескольких строк из таблицы. Эти строки не обязательно должны быть последовательными. Этот метод выдает ошибку, `InvalidArgument` если выбранная строка уже удалена или не существует. Этот метод выдаст ошибку, `InsertDeleteConflict` если к таблице, к которой вызывается метод, применен фильтр.
deleteRowsAt(index, count)	Удаление указанного количества строк из таблицы, начиная с заданного индекса. Этот метод выдаст ошибку, `InsertDeleteConflict` если к таблице, к которой вызывается метод, применен фильтр.
getCount()	Получает количество строк в таблице.
getItemAt(index)	Получает строку на основании ее позиции в коллекции. Обратите внимание, что в отличие от диапазонов или столбцов, которые будут корректировать добавление новых строк или столбцов перед ними, `TableRow` объект представляет физическое расположение строки таблицы, но не данных. Это означает, что при сортировке данных или добавлении новых строк строка таблицы будет по-прежнему указывать на индекс, для которого она была создана.
load(options)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNames)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNamesAndPaths)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
toJSON()	Переопределяет метод JavaScript `toJSON()` , чтобы обеспечить более полезные выходные данные при передаче объекта API в `JSON.stringify()`. (`JSON.stringify`, в свою очередь, вызывает `toJSON` метод переданного ему объекта.) В то время как исходный `Excel.TableRowCollection` объект является объектом API, `toJSON` метод возвращает простой объект JavaScript (типизированный как `Excel.Interfaces.TableRowCollectionData`), который содержит массив «items» с неглубокими копиями любых загруженных свойств из элементов коллекции.

context

Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office.

context: RequestContext;

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

Excel.RequestContext

count

Возвращает количество строк в таблице.

readonly count: number;

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

number

items

Получает загруженные дочерние элементы в этой коллекции.

readonly items: Excel.TableRow[];

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

Excel.TableRow[]

add(index, values, alwaysInsert)

Добавляет одну или несколько строк в таблицу. Возвращается объект, находящийся над новыми строками.

Обратите внимание, что в отличие от диапазонов или столбцов, которые будут корректировать добавление новых строк или столбцов перед ними, TableRow объект представляет физическое расположение строки таблицы, но не данных. Это означает, что при сортировке данных или добавлении новых строк строка таблицы будет по-прежнему указывать на индекс, для которого она была создана.

add(index?: number, values?: Array<Array<boolean | string | number>> | boolean | string | number, alwaysInsert?: boolean): Excel.TableRow;

Параметры

index: number

Необязательный параметр. Определяет относительную позицию новой строки. Если задано значение null или -1, столбец добавляется в конце. Все строки ниже вставляемой строки сдвигаются вниз. Используется нулевой индекс.

values: Array<Array<boolean | string | number>> | boolean | string | number

Необязательный параметр. Двумерный массив неформатированных значений строки таблицы.

alwaysInsert: boolean

Необязательный параметр. Указывает, будут ли вставляться новые строки в таблицу при добавлении новых строк. В trueслучае , новые строки будут вставлены в таблицу. Если false, новые строки будут добавлены под таблицей. Значение по умолчанию — true.

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

Excel.TableRow

Примеры

await Excel.run(async (context) => { 
    const tables = context.workbook.tables;
    const values = [["Sample", "Values", "For", "New", "Row"]];
    const row = tables.getItem("Table1").rows.add(null, values);
    row.load('index');
    await context.sync();
    
    console.log(row.index);
});

addAsJson(index, values, alwaysInsert)

Добавляет одну или несколько строк в таблицу. Возвращаемый объект будет представлять собой верхнюю строку только что добавленной строки или строк. В отличие от add(), addAsJson() принимает любой тип значения ячейки, например тип данных изображения или сущности.

Обратите внимание, что в отличие от диапазонов или столбцов, которые будут корректировать добавление новых строк или столбцов перед ними, TableRow объект представляет физическое расположение строки таблицы, но не данных. Это означает, что при сортировке данных или добавлении новых строк строка таблицы будет по-прежнему указывать на индекс, для которого она была создана.

addAsJson(index?: number, values?: CellValue[][], alwaysInsert?: boolean): Excel.TableRow;

Параметры

index: number

Необязательный параметр. Определяет относительную позицию новой строки. Если задано значение null или -1, столбец добавляется в конце. Все строки ниже вставляемой строки сдвигаются вниз. Используется нулевой индекс.

values: Excel.CellValue[][]

Необязательный параметр. Двумерный массив значений ячеек строки таблицы.

alwaysInsert: boolean

Необязательный параметр. Указывает, будут ли вставляться новые строки в таблицу при добавлении новых строк. В trueслучае , новые строки будут вставлены в таблицу. Если false, новые строки будут добавлены под таблицей. Значение по умолчанию — true.

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

Excel.TableRow

deleteRows(rows)

Удаление нескольких строк из таблицы. Эти строки не обязательно должны быть последовательными. Этот метод выдает ошибку, InvalidArgument если выбранная строка уже удалена или не существует. Этот метод выдаст ошибку, InsertDeleteConflict если к таблице, к которой вызывается метод, применен фильтр.

deleteRows(rows: number[] | TableRow[]): void;

Параметры

rows: number[] | Excel.TableRow[]

Массив индексов строк или объектов строк, которые нужно удалить из таблицы.

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

void

deleteRowsAt(index, count)

Удаление указанного количества строк из таблицы, начиная с заданного индекса. Этот метод выдаст ошибку, InsertDeleteConflict если к таблице, к которой вызывается метод, применен фильтр.

deleteRowsAt(index: number, count?: number): void;

Параметры

index: number

Значение индекса удаляемой строки. Примечание. Индексы строк обновляются при каждом удалении предыдущей строки в таблице после каждой операции удаления. Убедитесь, что индекс строки, которую требуется удалить, не изменился между определением значения и временем выполнения операции.

count: number

Количество строк для удаления. По умолчанию будет удалена одна строка.

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

void

getCount()

Получает количество строк в таблице.

getCount(): OfficeExtension.ClientResult<number>;

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

OfficeExtension.ClientResult<number>

getItemAt(index)

Получает строку на основании ее позиции в коллекции.

Обратите внимание, что в отличие от диапазонов или столбцов, которые будут корректировать добавление новых строк или столбцов перед ними, TableRow объект представляет физическое расположение строки таблицы, но не данных. Это означает, что при сортировке данных или добавлении новых строк строка таблицы будет по-прежнему указывать на индекс, для которого она была создана.

getItemAt(index: number): Excel.TableRow;

Параметры

index: number

Значение индекса получаемого объекта. Используется нулевой индекс.

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

Excel.TableRow

Примеры

await Excel.run(async (context) => {
    const tablerow = context.workbook.tables.getItem('Table1').rows.getItemAt(0);
    tablerow.load('values');
    await context.sync();
    console.log(tablerow.values);
});

load(options)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(options?: Excel.Interfaces.TableRowCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.TableRowCollection;

Параметры

options: Excel.Interfaces.TableRowCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

Предоставляет параметры для загружаемых свойств объекта.

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

Excel.TableRowCollection

load(propertyNames)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(propertyNames?: string | string[]): Excel.TableRowCollection;

Параметры

propertyNames: string | string[]

Строка с разделителями-запятыми или массив строк, которые определяют свойства для загрузки.

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

Excel.TableRowCollection

Примеры

await Excel.run(async (context) => { 
    const tablerows = context.workbook.tables.getItem('Table1').rows;
    tablerows.load('items');
    await context.sync();
    
    console.log("tablerows Count: " + tablerows.count);
    for (let i = 0; i < tablerows.items.length; i++) {
        console.log(tablerows.items[i].index);
    }
});

load(propertyNamesAndPaths)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.TableRowCollection;

Параметры

propertyNamesAndPaths: OfficeExtension.LoadOption

propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и строка propertyNamesAndPaths.expand через запятую, указывающая свойства навигации для загрузки.

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

Excel.TableRowCollection

toJSON()

Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringify, в свою очередь, вызывает toJSON метод переданного ему объекта.) В то время как исходный Excel.TableRowCollection объект является объектом API, toJSON метод возвращает простой объект JavaScript (типизированный как Excel.Interfaces.TableRowCollectionData), который содержит массив «items» с неглубокими копиями любых загруженных свойств из элементов коллекции.

toJSON(): Excel.Interfaces.TableRowCollectionData;

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

Excel.Interfaces.TableRowCollectionData

Комментарии

Используется

Свойства

Методы

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

context

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

count

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

Комментарии

items

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

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

add(index, values, alwaysInsert)

Параметры

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

Комментарии

Примеры

addAsJson(index, values, alwaysInsert)

Параметры

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

Комментарии

deleteRows(rows)

Параметры

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

Комментарии

deleteRowsAt(index, count)

Параметры

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

Комментарии

getCount()

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

Комментарии

getItemAt(index)

Параметры

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

Комментарии

Примеры

load(options)

Параметры

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

load(propertyNames)

Параметры

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

Примеры

load(propertyNamesAndPaths)

Параметры

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

toJSON()

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

Обратная связь