PowerPoint.TableColumnCollection class

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

Extends

Комментарии

Набор API: PowerPointApi 1.9

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

Свойства

context

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

items

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

Методы

add(index, count)

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

deleteColumns(columns)

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

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.TableColumnCollection объект является объектом API, toJSON метод возвращает простой объект JavaScript (типизированный как PowerPoint.Interfaces.TableColumnCollectionData), который содержит массив «items» с неглубокими копиями любых загруженных свойств из элементов коллекции.

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

context

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

context: RequestContext;

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

items

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

readonly items: PowerPoint.TableColumn[];

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

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

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

deleteColumns(columns)

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

deleteColumns(columns: PowerPoint.TableColumn[]): void;

Параметры

columns

PowerPoint.TableColumn[]

Массив TableColumn объектов, представляющих столбцы, которые нужно удалить.

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

void

Комментарии

Набор API: PowerPointApi 1.9

getCount()

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

getCount(): OfficeExtension.ClientResult<number>;

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

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

Комментарии

Набор API: PowerPointApi 1.9

getItemAt(index)

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

getItemAt(index: number): PowerPoint.TableColumn;

Параметры

index

number

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

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

Объект столбца.

Комментарии

Набор API: PowerPointApi 1.9

load(options)

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

load(options?: PowerPoint.Interfaces.TableColumnCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.TableColumnCollection;

Параметры

options

PowerPoint.Interfaces.TableColumnCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions

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

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

load(propertyNames)

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

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

Параметры

propertyNames

string | string[]

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

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

load(propertyNamesAndPaths)

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

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

Параметры

propertyNamesAndPaths
OfficeExtension.LoadOption

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

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

toJSON()

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

toJSON(): PowerPoint.Interfaces.TableColumnCollectionData;

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