Word.TableCellCollection class

Пакет:: word

Содержит коллекцию Word документа. Объекты TableCell.

Extends: OfficeExtension.ClientObject

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/40-tables/manage-formatting.yaml

// Gets content alignment details about the first cell of the first table in the document.
await Word.run(async (context) => {
  const firstTable: Word.Table = context.document.body.tables.getFirst();
  const firstTableRow: Word.TableRow = firstTable.rows.getFirst();
  const firstCell: Word.TableCell = firstTableRow.cells.getFirst();
  firstCell.load(["horizontalAlignment", "verticalAlignment"]);
  await context.sync();

  console.log(`Details about the alignment of the first table's first cell:`, `- Horizontal alignment of the cell's content: ${firstCell.horizontalAlignment}`, `- Vertical alignment of the cell's content: ${firstCell.verticalAlignment}`);
});

Свойства

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

Методы

autoFit()	Изменяет ширину столбца таблицы в соответствии с шириной текста, не изменяя способ переноса текста в ячейки.
delete(shiftCells)	Удаляет ячейки таблицы и при необходимости управляет смещением остальных ячеек.
delete(shiftCells)	Удаляет ячейки таблицы и при необходимости управляет смещением остальных ячеек.
distributeHeight()	Настраивает высоту указанных ячеек таким образом, чтобы они были равными.
distributeWidth()	Настраивает ширину указанных ячеек таким образом, чтобы они были равными.
getFirst()	Возвращает первую ячейку таблицы в коллекции. Выдает ошибку, `ItemNotFound` если эта коллекция пуста.
getFirstOrNullObject()	Возвращает первую ячейку таблицы в коллекции. Если коллекция пуста, то этот метод вернет объект со свойством `isNullObject` .`true` Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
load(options)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNames)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNamesAndPaths)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
merge()	Объединяет указанные ячейки в одну ячейку.
setHeight(rowHeight, heightRule)	Задает высоту ячеек в таблице.
setHeight(rowHeight, heightRule)	Задает высоту ячеек в таблице.
setWidth(columnWidth, rulerStyle)	Задает ширину ячеек в таблице.
setWidth(columnWidth, rulerStyle)	Задает ширину ячеек в таблице.
split(options)	Разделяет этот диапазон ячеек таблицы.
toJSON()	Переопределяет метод JavaScript `toJSON()` , чтобы обеспечить более полезные выходные данные при передаче объекта API в `JSON.stringify()`. (`JSON.stringify`в свою очередь вызывает `toJSON` метод переданного ему объекта.) В то время как исходный `Word.TableCellCollection` объект является объектом API, `toJSON` метод возвращает обычный объект JavaScript (типизированный как `Word.Interfaces.TableCellCollectionData`), содержащий массив "items" с мелкими копиями всех загруженных свойств из элементов коллекции.
track()	Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением для context.trackedObjects.add(thisObject). Если вы используете этот объект в вызовах `.sync` и вне последовательного выполнения пакета .run и получаете ошибку InvalidObjectPath при задании свойства или вызове метода для объекта, необходимо добавить объект в отслеживаемую коллекцию объектов при первом создании объекта. Если этот объект является частью коллекции, следует также отслеживать родительскую коллекцию.
untrack()	Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращенным для context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вызов потребуется выполнить `context.sync()` до того, как выпуск памяти вступит в силу.

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

context

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

context: RequestContext;

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

Word.RequestContext

items

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

readonly items: Word.TableCell[];

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

Word.TableCell[]

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

autoFit()

Изменяет ширину столбца таблицы в соответствии с шириной текста, не изменяя способ переноса текста в ячейки.

autoFit(): void;

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

void

delete(shiftCells)

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

delete(shiftCells?: Word.DeleteCells): void;

Параметры

shiftCells: Word.DeleteCells

Необязательный параметр. Указывает способ сдвига оставшихся ячеек после удаления. Значение по умолчанию — shiftLeft.

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

void

delete(shiftCells)

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

delete(shiftCells?: "ShiftLeft" | "ShiftUp" | "EntireRow" | "EntireColumn"): void;

Параметры

shiftCells: "ShiftLeft" | "ShiftUp" | "EntireRow" | "EntireColumn"

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

void

distributeHeight()

Настраивает высоту указанных ячеек таким образом, чтобы они были равными.

distributeHeight(): void;

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

void

distributeWidth()

Настраивает ширину указанных ячеек таким образом, чтобы они были равными.

distributeWidth(): void;

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

void

getFirst()

Возвращает первую ячейку таблицы в коллекции. Выдает ошибку, ItemNotFound если эта коллекция пуста.

getFirst(): Word.TableCell;

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

Word.TableCell

getFirstOrNullObject()

Возвращает первую ячейку таблицы в коллекции. Если коллекция пуста, то этот метод вернет объект со свойством isNullObject .true Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.

getFirstOrNullObject(): Word.TableCell;

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

Word.TableCell

load(options)

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

load(options?: Word.Interfaces.TableCellCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TableCellCollection;

Параметры

options: Word.Interfaces.TableCellCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions

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

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

Word.TableCellCollection

load(propertyNames)

load(propertyNames?: string | string[]): Word.TableCellCollection;

Параметры

propertyNames: string | string[]

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

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

Word.TableCellCollection

load(propertyNamesAndPaths)

load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.TableCellCollection;

Параметры

propertyNamesAndPaths: OfficeExtension.LoadOption

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

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

Word.TableCellCollection

merge()

Объединяет указанные ячейки в одну ячейку.

merge(): void;

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

void

setHeight(rowHeight, heightRule)

Задает высоту ячеек в таблице.

setHeight(rowHeight: number, heightRule: Word.RowHeightRule): void;

Параметры

rowHeight: number

Высота заданной строки в точках.

heightRule: Word.RowHeightRule

Правило для определения высоты указанных строк.

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

void

setHeight(rowHeight, heightRule)

Задает высоту ячеек в таблице.

setHeight(rowHeight: number, heightRule: "Auto" | "AtLeast" | "Exactly"): void;

Параметры

rowHeight: number

Высота заданной строки в точках.

heightRule: "Auto" | "AtLeast" | "Exactly"

Правило для определения высоты указанных строк.

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

void

setWidth(columnWidth, rulerStyle)

Задает ширину ячеек в таблице.

setWidth(columnWidth: number, rulerStyle: Word.RulerStyle): void;

Параметры

columnWidth: number

Ширина заданной строки в точках.

rulerStyle: Word.RulerStyle

Применяемый стиль линейки.

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

void

setWidth(columnWidth, rulerStyle)

Задает ширину ячеек в таблице.

setWidth(columnWidth: number, rulerStyle: "None" | "Proportional" | "FirstColumn" | "SameWidth"): void;

Параметры

columnWidth: number

Ширина заданной строки в точках.

rulerStyle: "None" | "Proportional" | "FirstColumn" | "SameWidth"

Применяемый стиль линейки.

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

void

split(options)

Разделяет этот диапазон ячеек таблицы.

split(options?: Word.TableCellCollectionSplitOptions): void;

Параметры

options: Word.TableCellCollectionSplitOptions

Необязательный параметр. Параметры для разделения ячеек таблицы.

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

void

toJSON()

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

toJSON(): Word.Interfaces.TableCellCollectionData;

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

Word.Interfaces.TableCellCollectionData

track()

Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением для context.trackedObjects.add(thisObject). Если вы используете этот объект в вызовах .sync и вне последовательного выполнения пакета .run и получаете ошибку InvalidObjectPath при задании свойства или вызове метода для объекта, необходимо добавить объект в отслеживаемую коллекцию объектов при первом создании объекта. Если этот объект является частью коллекции, следует также отслеживать родительскую коллекцию.

track(): Word.TableCellCollection;

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

Word.TableCellCollection

untrack()

Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращенным для context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вызов потребуется выполнить context.sync() до того, как выпуск памяти вступит в силу.

untrack(): Word.TableCellCollection;

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

Word.TableCellCollection

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

Были ли сведения на этой странице полезными?

Поделиться через

Word.TableCellCollection class

Комментарии

Примеры

Свойства

Методы

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

context

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

items

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

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

autoFit()

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

Комментарии

delete(shiftCells)

Параметры

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

Комментарии

delete(shiftCells)

Параметры

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

Комментарии

distributeHeight()

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

Комментарии

distributeWidth()

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

Комментарии

getFirst()

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

Комментарии

getFirstOrNullObject()

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

Комментарии

load(options)

Параметры

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

load(propertyNames)

Параметры

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

load(propertyNamesAndPaths)

Параметры

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

merge()

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

Комментарии

setHeight(rowHeight, heightRule)

Параметры

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

Комментарии

setHeight(rowHeight, heightRule)

Параметры

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

Комментарии

setWidth(columnWidth, rulerStyle)

Параметры

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

Комментарии

setWidth(columnWidth, rulerStyle)

Параметры

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

Комментарии

split(options)

Параметры

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

Комментарии

toJSON()

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

track()

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

untrack()

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

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