Word.TableCell class

Ссылка

Пакет:: word

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

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

Свойства

body	Возвращает объект тела ячейки.
cellIndex	Получает индекс ячейки в строке.
columnWidth	Задает ширину столбца ячейки в точках. Применим к однородным таблицам.
context	Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
horizontalAlignment	Задает горизонтальное выравнивание ячейки. Значение может быть "Слева", "По центру", "Справа" или "Оправдано".
parentRow	Получает родительскую строку ячейки.
parentTable	Возвращает родительскую таблицу ячейки.
rowIndex	Получает индекс строки ячейки в таблице.
shadingColor	Задает цвет заливки ячейки. Цвет задается в формате "#RRGGBB" или по имени.
value	Задает текст ячейки.
verticalAlignment	Задает вертикальное выравнивание ячейки. Это может быть значение "Top", "Center" или "Bottom".
width	Возвращает ширину ячейки в точках.

Методы

deleteColumn()	Удаляет столбец, содержащий данную ячейку. Применим к однородным таблицам.
deleteRow()	Удаляет строку, содержащую данную ячейку.
getBorder(borderLocation)	Возвращает стиль указанной границы.
getBorder(borderLocationString)	Возвращает стиль указанной границы.
getCellPadding(cellPaddingLocation)	Возвращает размер поля ячейки в точках.
getCellPadding(cellPaddingLocationString)	Возвращает размер поля ячейки в точках.
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()`.
set(properties, options)	Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.
set(properties)	Задает несколько свойств объекта одновременно на основе существующего загруженного объекта.
setCellPadding(cellPaddingLocation, cellPadding)	Задает размер поля ячейки в точках.
setCellPadding(cellPaddingLocationString, 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

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

readonly body: Word.Body;

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

Word.Body

cellIndex

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

readonly cellIndex: number;

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

number

columnWidth

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

columnWidth: number;

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

number

context

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

context: RequestContext;

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

Word.RequestContext

horizontalAlignment

Задает горизонтальное выравнивание ячейки. Значение может быть "Слева", "По центру", "Справа" или "Оправдано".

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

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

Примеры

// 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

parentTable

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

readonly parentTable: Word.Table;

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

Word.Table

rowIndex

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

readonly rowIndex: number;

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

number

shadingColor

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

shadingColor: string;

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

string

value

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

value: string;

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

string

verticalAlignment

Задает вертикальное выравнивание ячейки. Это может быть значение "Top", "Center" или "Bottom".

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

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

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

Примеры

// 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

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

deleteColumn()

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

deleteColumn(): void;

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

void

deleteRow()

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

deleteRow(): void;

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

void

getBorder(borderLocation)

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

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

Параметры

borderLocation: Word.BorderLocation

Обязательно. Расположение границы.

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

Word.TableBorder

getBorder(borderLocationString)

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

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

Параметры

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

Обязательно. Расположение границы.

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

Word.TableBorder

Примеры

// 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

Обязательно. Расположение заполнений ячейки должно быть "Сверху", "Слева", "Внизу" или "Справа".

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

OfficeExtension.ClientResult<number>

getCellPadding(cellPaddingLocationString)

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

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

Параметры

cellPaddingLocationString: "Top" | "Left" | "Bottom" | "Right"

Обязательно. Расположение заполнений ячейки должно быть "Сверху", "Слева", "Внизу" или "Справа".

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

OfficeExtension.ClientResult<number>

Примеры

// 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

getNextOrNullObject()

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

getNextOrNullObject(): Word.TableCell;

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

Word.TableCell

insertColumns(insertLocation, columnCount, values)

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

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

Параметры

insertLocation: before | after | "Before" | "After"

Обязательно. Он должен быть "До" или "После".

columnCount: number

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

values: string[][]

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

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

void

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"

Обязательно. Он должен быть "До" или "После".

rowCount: number

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

values: string[][]

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

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

Word.TableRowCollection

load(options)

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

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

Параметры

options: Word.Interfaces.TableCellLoadOptions

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

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

Word.TableCell

load(propertyNames)

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

Параметры

propertyNames: string | string[]

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

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

Word.TableCell

load(propertyNamesAndPaths)

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

Параметры

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

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

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

Word.TableCell

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

Обязательно. Расположение заполнений ячейки должно быть "Сверху", "Слева", "Внизу" или "Справа".

cellPadding: number

Обязательно. Заполнение ячейки.

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

void

setCellPadding(cellPaddingLocationString, cellPadding)

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

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

Параметры

cellPaddingLocationString: "Top" | "Left" | "Bottom" | "Right"

Обязательно. Расположение заполнений ячейки должно быть "Сверху", "Слева", "Внизу" или "Справа".

cellPadding: number

Обязательно. Заполнение ячейки.

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

void

split(rowCount, columnCount)

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

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

Параметры

rowCount: number

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

columnCount: number

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

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

void

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

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

Word.TableCell class

Комментарии

Примеры

Свойства

Методы

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

body

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

Комментарии

cellIndex

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

Комментарии

columnWidth

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

Комментарии

context

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

horizontalAlignment

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

Комментарии

Примеры

parentRow

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

Комментарии

parentTable

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

Комментарии

rowIndex

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

Комментарии

shadingColor

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

Комментарии

value

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

Комментарии

verticalAlignment

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

Комментарии

Примеры

width

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

Комментарии

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

deleteColumn()

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

Комментарии

deleteRow()

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

Комментарии

getBorder(borderLocation)

Параметры

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

Комментарии

getBorder(borderLocationString)

Параметры

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

Комментарии

Примеры

getCellPadding(cellPaddingLocation)

Параметры

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

Комментарии

getCellPadding(cellPaddingLocationString)

Параметры

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

Комментарии

Примеры

getNext()

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

Комментарии

getNextOrNullObject()

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

Комментарии

insertColumns(insertLocation, columnCount, values)

Параметры

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

Комментарии

insertRows(insertLocation, rowCount, values)