Word.TableCell class

Пакет:

word

Представляет ячейку таблицы в документе Word.

Extends

OfficeExtension.ClientObject

Комментарии

[ Набор API: WordApi 1.3 ]

Примеры

// 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}`);
});

Свойства

body	Body Возвращает объект ячейки.
cellIndex	Получает индекс ячейки в строке.
column	TableColumn Возвращает объект , представляющий столбец таблицы, содержащий эту ячейку.
columnWidth	Задает ширину столбца ячейки в точках. Применим к однородным таблицам.
context	Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
horizontalAlignment	Задает горизонтальное выравнивание ячейки. Значение может быть left,centered ,right или .justified
parentRow	Получает родительскую строку ячейки.
parentTable	Возвращает родительскую таблицу ячейки.
rowIndex	Получает индекс строки ячейки в таблице.
shading	ShadingUniversal Возвращает объект , представляющий заливку ячейки таблицы.
shadingColor	Задает цвет заливки ячейки. Цвет задается в формате "#RRGGBB" или по имени.
value	Задает текст ячейки.
verticalAlignment	Задает вертикальное выравнивание ячейки. Значение может быть top, centerили bottom.
width	Возвращает ширину ячейки в точках.

Методы

autoSum()	Вставляет поле = (формула), которое вычисляет и отображает сумму значений в ячейках таблицы выше или слева от ячейки, указанной в выражении.
delete(shiftCells)	Удаляет ячейку таблицы и при необходимости управляет смещением остальных ячеек.
deleteColumn()	Удаляет столбец, содержащий данную ячейку. Применим к однородным таблицам.
deleteRow()	Удаляет строку, содержащую данную ячейку.
formula(options)	Вставляет поле = (формула), содержащее указанную формулу, в ячейку таблицы.
getBorder(borderLocation)	Возвращает стиль указанной границы.
getBorder(borderLocation)	Возвращает стиль указанной границы.
getCellPadding(cellPaddingLocation)	Возвращает размер поля ячейки в точках.
getCellPadding(cellPaddingLocation)	Возвращает размер поля ячейки в точках.
getNext()	Возвращает следующую ячейку. Выдает ошибку, ItemNotFound если эта ячейка является последней.
getNextOrNullObject()	Возвращает следующую ячейку. Если эта ячейка является последней, то этот метод вернет объект со свойством isNullObjecttrue. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
insertColumns(insertLocation, columnCount, values)	Добавляет столбцы слева или справа от ячейки, используя столбец этой ячейки в качестве шаблона. Применим к однородным таблицам. Строковые значения (если они указаны) добавляются в новые строки.
insertRows(insertLocation, rowCount, values)	Вставляет строки над ячейкой или под ней, используя строку этой ячейки в качестве шаблона. Строковые значения (если они указаны) добавляются в новые строки.
load(options)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
merge(mergeTo)	Объединяет эту ячейку таблицы с указанной ячейкой таблицы.
select()	Выбирает ячейку таблицы.
set(properties, options)	Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.
set(properties)	Задает несколько свойств объекта одновременно на основе существующего загруженного объекта.
setCellPadding(cellPaddingLocation, cellPadding)	Задает размер поля ячейки в точках.
setCellPadding(cellPaddingLocation, cellPadding)	Задает размер поля ячейки в точках.
split(rowCount, columnCount)	Разбивает ячейку на указанное количество строк и столбцов.
toJSON()	Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный Word.TableCell объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Word.Interfaces.TableCellData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.
track()	Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением для context.trackedObjects.add(thisObject). Если вы используете этот объект в вызовах .sync и вне последовательного выполнения пакета .run и получаете ошибку InvalidObjectPath при задании свойства или вызове метода для объекта, необходимо добавить объект в отслеживаемую коллекцию объектов при первом создании объекта. Если этот объект является частью коллекции, следует также отслеживать родительскую коллекцию.
untrack()	Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращенным для context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вызов потребуется выполнить context.sync() до того, как выпуск памяти вступит в силу.

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

body

Body Возвращает объект ячейки.

readonly body: Word.Body;

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

Word.Body

Комментарии

[ Набор API: WordApi 1.3 ]

cellIndex

Получает индекс ячейки в строке.

readonly cellIndex: number;

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

number

Комментарии

[ Набор API: WordApi 1.3 ]

column

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

readonly column: Word.TableColumn;

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

Word.TableColumn

Комментарии

[ Набор API: WordApiDesktop 1.4 ]

columnWidth

Задает ширину столбца ячейки в точках. Применим к однородным таблицам.

columnWidth: number;

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

number

Комментарии

[ Набор API: WordApi 1.3 ]

context

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

context: RequestContext;

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

Word.RequestContext

horizontalAlignment

Задает горизонтальное выравнивание ячейки. Значение может быть left,centered ,right или .justified

horizontalAlignment: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified";

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

Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"

Комментарии

[ Набор API: WordApi 1.3 ]

Примеры

// 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}`);
});

parentRow

Получает родительскую строку ячейки.

readonly parentRow: Word.TableRow;

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

Word.TableRow

Комментарии

[ Набор API: WordApi 1.3 ]

parentTable

Возвращает родительскую таблицу ячейки.

readonly parentTable: Word.Table;

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

Word.Table

Комментарии

[ Набор API: WordApi 1.3 ]

rowIndex

Получает индекс строки ячейки в таблице.

readonly rowIndex: number;

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

number

Комментарии

[ Набор API: WordApi 1.3 ]

shading

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

readonly shading: Word.ShadingUniversal;

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

Word.ShadingUniversal

Комментарии

[ Набор API: WordApiDesktop 1.4 ]

shadingColor

Задает цвет заливки ячейки. Цвет задается в формате "#RRGGBB" или по имени.

shadingColor: string;

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

string

Комментарии

[ Набор API: WordApi 1.3 ]

value

Задает текст ячейки.

value: string;

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

string

Комментарии

[ Набор API: WordApi 1.3 ]

verticalAlignment

Задает вертикальное выравнивание ячейки. Значение может быть top, centerили bottom.

verticalAlignment: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom";

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

Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"

Комментарии

[ Набор API: WordApi 1.3 ]

Примеры

// 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}`);
});

width

Возвращает ширину ячейки в точках.

readonly width: number;

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

number

Комментарии

[ Набор API: WordApi 1.3 ]

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

autoSum()

Вставляет поле = (формула), которое вычисляет и отображает сумму значений в ячейках таблицы выше или слева от ячейки, указанной в выражении.

autoSum(): void;

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

void

Комментарии

[ Набор API: WordApiDesktop 1.4 ]

delete(shiftCells)

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

delete(shiftCells: any): void;

Параметры

shiftCells

any

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

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

void

Комментарии

[ Набор API: WordApiDesktop 1.4 ]

deleteColumn()

Удаляет столбец, содержащий данную ячейку. Применим к однородным таблицам.

deleteColumn(): void;

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

void

Комментарии

[ Набор API: WordApi 1.3 ]

deleteRow()

Удаляет строку, содержащую данную ячейку.

deleteRow(): void;

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

void

Комментарии

[ Набор API: WordApi 1.3 ]

formula(options)

Вставляет поле = (формула), содержащее указанную формулу, в ячейку таблицы.

formula(options?: Word.TableCellFormulaOptions): void;

Параметры

options

Word.TableCellFormulaOptions

Необязательный параметр. Объект , указывающий параметры формулы.

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

void

Комментарии

[ Набор API: WordApiDesktop 1.4 ]

getBorder(borderLocation)

Возвращает стиль указанной границы.

getBorder(borderLocation: Word.BorderLocation): Word.TableBorder;

Параметры

borderLocation

Word.BorderLocation

Расположение границы.

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

Word.TableBorder

Комментарии

[ Набор API: WordApi 1.3 ]

getBorder(borderLocation)

Возвращает стиль указанной границы.

getBorder(borderLocation: "Top" | "Left" | "Bottom" | "Right" | "InsideHorizontal" | "InsideVertical" | "Inside" | "Outside" | "All"): Word.TableBorder;

Параметры

borderLocation

"Top" | "Left" | "Bottom" | "Right" | "InsideHorizontal" | "InsideVertical" | "Inside" | "Outside" | "All"

Расположение границы.

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

Word.TableBorder

Комментарии

[ Набор API: WordApi 1.3 ]

Примеры

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

// Gets border details about the first of the first table in the document.
await Word.run(async (context) => {
  const firstTable: Word.Table = context.document.body.tables.getFirst();
  const firstCell: Word.TableCell = firstTable.getCell(0, 0);
  const borderLocation = "Left";
  const border: Word.TableBorder = firstCell.getBorder(borderLocation);
  border.load(["type", "color", "width"]);
  await context.sync();

  console.log(`Details about the ${borderLocation} border of the first table's first cell:`, `- Color: ${border.color}`, `- Type: ${border.type}`, `- Width: ${border.width} points`);
});

getCellPadding(cellPaddingLocation)

Возвращает размер поля ячейки в точках.

getCellPadding(cellPaddingLocation: Word.CellPaddingLocation): OfficeExtension.ClientResult<number>;

Параметры

cellPaddingLocation

Word.CellPaddingLocation

Расположение заполнений ячейки должно быть top, left, bottomили right.

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

OfficeExtension.ClientResult<number>

Комментарии

[ Набор API: WordApi 1.3 ]

getCellPadding(cellPaddingLocation)

Возвращает размер поля ячейки в точках.

getCellPadding(cellPaddingLocation: "Top" | "Left" | "Bottom" | "Right"): OfficeExtension.ClientResult<number>;

Параметры

cellPaddingLocation

"Top" | "Left" | "Bottom" | "Right"

Расположение заполнений ячейки должно быть top, left, bottomили right.

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

OfficeExtension.ClientResult<number>

Комментарии

[ Набор API: WordApi 1.3 ]

Примеры

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

// Gets cell padding 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 firstCell: Word.TableCell = firstTable.getCell(0, 0);
  const cellPaddingLocation = "Left";
  const cellPadding = firstCell.getCellPadding(cellPaddingLocation);
  await context.sync();

  console.log(
    `Cell padding details about the ${cellPaddingLocation} border of the first table's first cell: ${cellPadding.value} points`
  );
});

getNext()

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

getNext(): Word.TableCell;

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

Word.TableCell

Комментарии

[ Набор API: WordApi 1.3 ]

getNextOrNullObject()

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

getNextOrNullObject(): Word.TableCell;

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

Word.TableCell

Комментарии

[ Набор API: WordApi 1.3 ]

insertColumns(insertLocation, columnCount, values)

Добавляет столбцы слева или справа от ячейки, используя столбец этой ячейки в качестве шаблона. Применим к однородным таблицам. Строковые значения (если они указаны) добавляются в новые строки.

insertColumns(insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After", columnCount: number, values?: string[][]): void;

Параметры

insertLocation

before | after | "Before" | "After"

Он должен иметь значение before или after.

columnCount

number

Количество добавляемых столбцов.

values

string[][]

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

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

void

Комментарии

[ Набор API: WordApi 1.3 ]

insertRows(insertLocation, rowCount, values)

Вставляет строки над ячейкой или под ней, используя строку этой ячейки в качестве шаблона. Строковые значения (если они указаны) добавляются в новые строки.

insertRows(insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After", rowCount: number, values?: string[][]): Word.TableRowCollection;

Параметры

insertLocation

before | after | "Before" | "After"

Он должен иметь значение before или after.

rowCount

number

Количество добавляемых строк.

values

string[][]

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

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

Word.TableRowCollection

Комментарии

[ Набор API: WordApi 1.3 ]

load(options)

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

load(options?: Word.Interfaces.TableCellLoadOptions): Word.TableCell;

Параметры

options

Word.Interfaces.TableCellLoadOptions

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

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

Word.TableCell

load(propertyNames)

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

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

Параметры

propertyNames

string | string[]

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

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

Word.TableCell

load(propertyNamesAndPaths)

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

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Word.TableCell;

Параметры

propertyNamesAndPaths

{ select?: string; expand?: string; }

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

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

Word.TableCell

merge(mergeTo)

Объединяет эту ячейку таблицы с указанной ячейкой таблицы.

merge(mergeTo: Word.TableCell): void;

Параметры

mergeTo

Word.TableCell

Ячейка для объединения.

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

void

Комментарии

[ Набор API: WordApiDesktop 1.4 ]

select()

Выбирает ячейку таблицы.

select(): void;

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

void

Комментарии

[ Набор API: WordApiDesktop 1.4 ]

set(properties, options)

Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.

set(properties: Interfaces.TableCellUpdateData, options?: OfficeExtension.UpdateOptions): void;

Параметры

properties

Word.Interfaces.TableCellUpdateData

Объект JavaScript со свойствами, структурированными изоморфно по свойствам объекта, для которого вызывается метод .

options

OfficeExtension.UpdateOptions

Предоставляет возможность подавления ошибок, если объект свойств пытается задать какие-либо свойства, доступные только для чтения.

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

void

set(properties)

Задает несколько свойств объекта одновременно на основе существующего загруженного объекта.

set(properties: Word.TableCell): void;

Параметры

properties

Word.TableCell

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

void

setCellPadding(cellPaddingLocation, cellPadding)

Задает размер поля ячейки в точках.

setCellPadding(cellPaddingLocation: Word.CellPaddingLocation, cellPadding: number): void;

Параметры

cellPaddingLocation

Word.CellPaddingLocation

Расположение заполнений ячейки должно быть top, left, bottomили right.

cellPadding

number

Заполнение ячейки.

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

void

Комментарии

[ Набор API: WordApi 1.3 ]

setCellPadding(cellPaddingLocation, cellPadding)

Задает размер поля ячейки в точках.

setCellPadding(cellPaddingLocation: "Top" | "Left" | "Bottom" | "Right", cellPadding: number): void;

Параметры

cellPaddingLocation

"Top" | "Left" | "Bottom" | "Right"

Расположение заполнений ячейки должно быть top, left, bottomили right.

cellPadding

number

Заполнение ячейки.

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

void

Комментарии

[ Набор API: WordApi 1.3 ]

split(rowCount, columnCount)

Разбивает ячейку на указанное количество строк и столбцов.

split(rowCount: number, columnCount: number): void;

Параметры

rowCount

number

Количество строк для разделения. Должен быть делителем числа базовых строк.

columnCount

number

Количество столбцов для разделения.

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

void

Комментарии

[ Набор API: WordApi 1.4 ]

toJSON()

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

toJSON(): Word.Interfaces.TableCellData;

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

Word.Interfaces.TableCellData

track()

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

track(): Word.TableCell;

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

Word.TableCell

untrack()

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

untrack(): Word.TableCell;

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

Word.TableCell