PowerPoint.TableRowCollection class

Представляет коллекцию строк таблицы.

Extends

Комментарии

Набор API: PowerPointApi 1.9

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

Свойства

context

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

items

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

Методы

add(index, count)

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

deleteRows(rows)

Удаляет указанные строки из коллекции.

getCount()

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

getItemAt(index)

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

load(options)

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

load(propertyNames)

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

load(propertyNamesAndPaths)

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

toJSON()

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

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

context

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

context: RequestContext;

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

items

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

readonly items: PowerPoint.TableRow[];

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

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

add(index, count)

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

add(index?: number | null | undefined, count?: number | undefined): void;

Параметры

index

number | null | undefined

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

count

number | undefined

Необязательный параметр. Количество добавляемых строк. Если значение не определено или 0, добавляется только одна строка.

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

void

Комментарии

Набор API: PowerPointApi 1.9

deleteRows(rows)

Удаляет указанные строки из коллекции.

deleteRows(rows: PowerPoint.TableRow[]): void;

Параметры

rows

PowerPoint.TableRow[]

Массив объектов, TableRow представляющих удаляемую строку.

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

void

Комментарии

Набор API: PowerPointApi 1.9

getCount()

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

getCount(): OfficeExtension.ClientResult<number>;

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

Количество строк в коллекции.

Комментарии

Набор API: PowerPointApi 1.9

getItemAt(index)

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

getItemAt(index: number): PowerPoint.TableRow;

Параметры

index

number

Значение индекса извлекаемой строки в виде отсчитываемого от нуля индекса.

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

Объект строки.

Комментарии

Набор API: PowerPointApi 1.9

load(options)

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

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

Параметры

options

PowerPoint.Interfaces.TableRowCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions

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

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

load(propertyNames)

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

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

Параметры

propertyNames

string | string[]

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

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

load(propertyNamesAndPaths)

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

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

Параметры

propertyNamesAndPaths
OfficeExtension.LoadOption

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

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

toJSON()

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

toJSON(): PowerPoint.Interfaces.TableRowCollectionData;

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