Word.TableCellCollection class
Содержит коллекцию Word документа. объектов TableCell.
- Extends
Комментарии
Используется
Примеры
// 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 | Получает загруженные дочерние элементы в этой коллекции. |
Методы
| auto |
Изменяет ширину столбца таблицы в соответствии с шириной текста без изменения способа обтекания текстом в ячейках. |
| delete(shift |
Удаляет ячейки таблицы и при необходимости управляет сдвигом оставшихся ячеек. |
| delete(shift |
Удаляет ячейки таблицы и при необходимости управляет сдвигом оставшихся ячеек. |
| distribute |
Высота указанных ячеек изменяется таким образом, чтобы они были одинаковыми. |
| distribute |
Выравнивает ширину указанных ячеек. |
| get |
Возвращает первую ячейку таблицы в коллекции. Если эта коллекция пуста, возникает |
| get |
Возвращает первую ячейку таблицы в коллекции. Если эта коллекция пуста, то этот метод вернет объект со свойством |
| load(options) | Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| merge() | Объединяет указанные ячейки в одну. |
| set |
Высота ячеек в таблице. |
| set |
Высота ячеек в таблице. |
| set |
Ширина ячеек в таблице. |
| set |
Ширина ячеек в таблице. |
| split(options) | Разделяет этот диапазон ячеек таблицы. |
| toJSON() | Переопределяет метод JavaScript |
| track() | Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением от context.trackedObjects.add(thisObject). Если вы используете этот объект во всех |
| untrack() | Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращением от context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вам нужно позвонить |
Сведения о свойстве
context
Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office.
context: RequestContext;Значение свойства
items
Получает загруженные дочерние элементы в этой коллекции.
readonly items: 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"
Необязательный параметр. Сдвигает оставшиеся ячейки после удаления. Значение по умолчанию — shiftLeft.
Возвращаемое значение
void
Комментарии
distributeHeight()
Высота указанных ячеек изменяется таким образом, чтобы они были одинаковыми.
distributeHeight(): void;Возвращаемое значение
void
Комментарии
distributeWidth()
Выравнивает ширину указанных ячеек.
distributeWidth(): void;Возвращаемое значение
void
Комментарии
getFirst()
Возвращает первую ячейку таблицы в коллекции. Если эта коллекция пуста, возникает ItemNotFound ошибка.
getFirst(): Word.TableCell;Возвращаемое значение
Комментарии
getFirstOrNullObject()
Возвращает первую ячейку таблицы в коллекции. Если эта коллекция пуста, то этот метод вернет объект со свойством isNullObject , установленным в true. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
getFirstOrNullObject(): Word.TableCell;Возвращаемое значение
Комментарии
load(options)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(options?: Word.Interfaces.TableCellCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TableCellCollection;Параметры
Предоставляет параметры для загружаемых свойств объекта.
Возвращаемое значение
load(propertyNames)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames?: string | string[]): Word.TableCellCollection;Параметры
- propertyNames
-
string | string[]
Строка с разделителями-запятыми или массив строк, которые определяют свойства для загрузки.
Возвращаемое значение
load(propertyNamesAndPaths)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.TableCellCollection;Параметры
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и строка propertyNamesAndPaths.expand через запятую, указывающая свойства навигации для загрузки.
Возвращаемое значение
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;Параметры
Необязательный параметр. Параметры для разделения ячеек таблицы.
Возвращаемое значение
void
Комментарии
toJSON()
Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringify, в свою очередь, вызывает toJSON метод переданного ему объекта.) В то время как исходный Word.TableCellCollection объект является объектом API, toJSON метод возвращает простой объект JavaScript (типизированный как Word.Interfaces.TableCellCollectionData), который содержит массив «items» с неглубокими копиями любых загруженных свойств из элементов коллекции.
toJSON(): Word.Interfaces.TableCellCollectionData;Возвращаемое значение
track()
Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением от context.trackedObjects.add(thisObject). Если вы используете этот объект во всех .sync вызовах и вне последовательного выполнения пакета ".run" и получаете сообщение об ошибке "InvalidObjectPath" при установке свойства или вызове метода объекта, необходимо добавить объект в коллекцию отслеживаемых объектов при его первом создании. Если этот объект является частью семейства, следует также отслеживать родительскую коллекцию.
track(): Word.TableCellCollection;Возвращаемое значение
untrack()
Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращением от context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вам нужно позвонить context.sync() , прежде чем освобождение памяти вступит в силу.
untrack(): Word.TableCellCollection;