PowerPoint.TableRowCollection class
Представляет коллекцию строк таблицы.
- Extends
Свойства
| context | Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office. |
| items | Получает загруженные дочерние элементы в этой коллекции. |
Методы
| add(index, count) | Добавляет одну или несколько строк в таблицу. |
| delete |
Удаляет указанные строки из коллекции. |
| get |
Получает количество строк в коллекции. |
| get |
Получает строку с использованием индекса, отсчитываемого от нуля, в коллекции. |
| load(options) | Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| toJSON() | Переопределяет метод JavaScript |
Сведения о свойстве
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
Необязательный параметр. Указывает отсчитываемый от нуля индекс, в котором добавляются новые строки. Существующие строки, начинающиеся с позиции индекса, сдвигаются вниз. Если значение индекса не определено, равно нулю, -1 или превышает количество строк в таблице, новые строки добавляются в конец таблицы.
- count
-
number | undefined
Необязательный параметр. Количество строк для сложения. Если значение не определено или равно 0, добавляется только одна строка.
Возвращаемое значение
void
Комментарии
deleteRows(rows)
Удаляет указанные строки из коллекции.
deleteRows(rows: PowerPoint.TableRow[]): void;Параметры
- rows
Массив TableRow объектов, представляющих строки, которые нужно удалить.
Возвращаемое значение
void
Комментарии
getCount()
Получает количество строк в коллекции.
getCount(): OfficeExtension.ClientResult<number>;Возвращаемое значение
OfficeExtension.ClientResult<number>
Количество строк в коллекции.
Комментарии
getItemAt(index)
Получает строку с использованием индекса, отсчитываемого от нуля, в коллекции.
getItemAt(index: number): PowerPoint.TableRow;Параметры
- index
-
number
Значение индекса извлекаемой строки, отсчитываемое от нуля.
Возвращаемое значение
Объект строки.
Комментарии
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;