Word.Table 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/table-cell-access.yaml

await Word.run(async (context) => {
  // Use a two-dimensional array to hold the initial table values.
  const data = [
    ["Tokyo", "Beijing", "Seattle"],
    ["Apple", "Orange", "Pineapple"]
  ];
  const table: Word.Table = context.document.body.insertTable(2, 3, "Start", data);
  table.styleBuiltIn = Word.BuiltInStyleName.gridTable5Dark_Accent2;
  table.styleFirstColumn = false;

  await context.sync();
});

Свойства

alignment	Задает выравнивание таблицы по столбцу страницы. Значение может быть "Слева", "По центру" или "Справа".
context	Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
fields	Возвращает коллекцию объектов полей в таблице.
font	Возвращает шрифт. Используйте эту связь, чтобы получать и задавать имя, размер, цвет и другие свойства шрифта.
headerRowCount	Указывает количество строк заголовков.
horizontalAlignment	Задает горизонтальное выравнивание каждой ячейки в таблице. Значение может быть "Слева", "По центру", "Справа" или "Оправдано".
isUniform	Указывает, однородны ли все строки таблицы.
nestingLevel	Возвращает уровень вложенности таблицы. Таблицам верхнего уровня соответствует значение 1.
parentBody	Возвращает родительский текст таблицы.
parentContentControl	Возвращает элемент управления содержимым, содержащий таблицу. Выдает ошибку ItemNotFound , если родительского элемента управления содержимым нет.
parentContentControlOrNullObject	Возвращает элемент управления содержимым, содержащий таблицу. Если родительского элемента управления содержимым нет, этот метод вернет объект со свойством isNullObjecttrue. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
parentTable	Возвращает таблицу, которая содержит данную таблицу. Выдает ошибку ItemNotFound , если она не содержится в таблице.
parentTableCell	Возвращает ячейку таблицы, содержащую данную таблицу. Выдает ошибку ItemNotFound , если она не содержится в ячейке таблицы.
parentTableCellOrNullObject	Возвращает ячейку таблицы, содержащую данную таблицу. Если он не содержится в ячейке таблицы, этот метод вернет объект со свойством , для него isNullObject задано значение true. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
parentTableOrNullObject	Возвращает таблицу, которая содержит данную таблицу. Если он не содержится в таблице, то этот метод вернет объект со свойством isNullObjecttrue. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
rowCount	Получает количество строк в таблице.
rows	Возвращает все строки таблицы.
shadingColor	Задает цвет заливки. Цвет задается в формате "#RRGGBB" или по имени.
style	Задает имя стиля для таблицы. Используйте это свойство для пользовательских стилей и локализованных имен стилей. Чтобы использовать встроенные стили, поддерживающие несколько языковых стандартов, применяйте свойство styleBuiltIn.
styleBandedColumns	Указывает, содержит ли таблица чередуемые столбцы.
styleBandedRows	Указывает, содержит ли таблица чередуемые строки.
styleBuiltIn	Задает встроенное имя стиля для таблицы. Используйте это свойство для встроенных стилей, поддерживающих несколько языковых стандартов. Чтобы использовать пользовательские стили или локализованные имена стилей, применяйте свойство style.
styleFirstColumn	Указывает, содержит ли таблица первый столбец со специальным стилем.
styleLastColumn	Указывает, содержит ли таблица последний столбец со специальным стилем.
styleTotalRow	Указывает, содержит ли таблица итоговую (последнюю) строку со специальным стилем.
tables	Возвращает дочерние таблицы, вложенные на один уровень ниже.
values	Задает текстовые значения в таблице в виде массива JavaScript 2D.
verticalAlignment	Задает вертикальное выравнивание каждой ячейки в таблице. Это может быть значение "Top", "Center" или "Bottom".
width	Задает ширину таблицы в точках.

Методы

addColumns(insertLocation, columnCount, values)	Добавляет столбцы в начале или в конце таблицы, используя первый или последний из имеющихся столбцов в качестве шаблона. Применим к однородным таблицам. Строковые значения (если они указаны) добавляются в новые строки.
addRows(insertLocation, rowCount, values)	Добавляет строки в начале или в конце таблицы, используя первую или последнюю из имеющихся строк в качестве шаблона. Строковые значения (если они указаны) добавляются в новые строки.
autoFitWindow()	Автоматически подбирает ширину столбцов таблицы в соответствии с шириной окна.
clear()	Очищает содержимое таблицы.
delete()	Удаляет всю таблицу.
deleteColumns(columnIndex, columnCount)	Удаляет определенные столбцы. Применим к однородным таблицам.
deleteRows(rowIndex, rowCount)	Удаляет определенные строки.
distributeColumns()	Равномерно распределяет ширину столбцов. Применим к однородным таблицам.
getBorder(borderLocation)	Возвращает стиль указанной границы.
getBorder(borderLocationString)	Возвращает стиль указанной границы.
getCell(rowIndex, cellIndex)	Возвращает ячейку таблицы в указанной строке и указанном столбце. Выдает ошибку ItemNotFound , если указанная ячейка таблицы не существует.
getCellOrNullObject(rowIndex, cellIndex)	Возвращает ячейку таблицы в указанной строке и указанном столбце. Если указанная ячейка таблицы не существует, этот метод вернет объект со свойством isNullObjecttrue. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
getCellPadding(cellPaddingLocation)	Возвращает размер поля ячейки в точках.
getCellPadding(cellPaddingLocationString)	Возвращает размер поля ячейки в точках.
getNext()	Возвращает следующую таблицу. Выдает ошибку, ItemNotFound если эта таблица является последней.
getNextOrNullObject()	Возвращает следующую таблицу. Если эта таблица является последней, то этот метод вернет объект со свойством isNullObjecttrue. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
getParagraphAfter()	Возвращает абзац после таблицы. Выдает ошибку ItemNotFound , если после таблицы нет абзаца.
getParagraphAfterOrNullObject()	Возвращает абзац после таблицы. Если после таблицы нет абзаца, этот метод вернет объект со свойством isNullObjecttrue. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
getParagraphBefore()	Возвращает абзац перед таблицей. Выдает ошибку ItemNotFound , если перед таблицей нет абзаца.
getParagraphBeforeOrNullObject()	Возвращает абзац перед таблицей. Если перед таблицей нет абзаца, этот метод вернет объект со свойством isNullObjecttrue. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
getRange(rangeLocation)	Возвращает диапазон, содержащий данную таблицу, либо диапазон в начале или в конце таблицы.
insertContentControl()	Вставляет в таблицу элемент управления содержимым.
insertParagraph(paragraphText, insertLocation)	Вставляет абзац в указанном расположении.
insertTable(rowCount, columnCount, insertLocation, values)	Вставляет таблицу с указанным количеством строк и столбцов.
load(options)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
mergeCells(topRow, firstCell, bottomRow, lastCell)	Объединяет ячейки, ограниченные включительно первой и последней ячейками.
search(searchText, searchOptions)	Выполняет поиск с указанным searchOptions в область объекта таблицы. Результат поиска — это коллекция объектов диапазона.
select(selectionMode)	Выбирает таблицу либо позицию в начале или в конце таблицы, а затем переходит к ней в Word.
select(selectionModeString)	Выбирает таблицу либо позицию в начале или в конце таблицы, а затем переходит к ней в Word.
set(properties, options)	Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.
set(properties)	Задает несколько свойств объекта одновременно на основе существующего загруженного объекта.
setCellPadding(cellPaddingLocation, cellPadding)	Задает размер поля ячейки в точках.
setCellPadding(cellPaddingLocationString, cellPadding)	Задает размер поля ячейки в точках.
toJSON()	Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный Word.Table объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Word.Interfaces.TableData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.
track()	Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением для context.trackedObjects.add(thisObject). Если вы используете этот объект в вызовах .sync и вне последовательного выполнения пакета .run и получаете ошибку InvalidObjectPath при задании свойства или вызове метода для объекта, необходимо добавить объект в отслеживаемую коллекцию объектов при первом создании объекта. Если этот объект является частью коллекции, следует также отслеживать родительскую коллекцию.
untrack()	Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращенным для context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вызов потребуется выполнить context.sync() до того, как выпуск памяти вступит в силу.

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

alignment

Задает выравнивание таблицы по столбцу страницы. Значение может быть "Слева", "По центру" или "Справа".

alignment: 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 alignment details about the first table in the document.
await Word.run(async (context) => {
  const firstTable: Word.Table = context.document.body.tables.getFirst();
  firstTable.load(["alignment", "horizontalAlignment", "verticalAlignment"]);
  await context.sync();

  console.log(`Details about the alignment of the first table:`, `- Alignment of the table within the containing page column: ${firstTable.alignment}`, `- Horizontal alignment of every cell in the table: ${firstTable.horizontalAlignment}`, `- Vertical alignment of every cell in the table: ${firstTable.verticalAlignment}`);
});

context

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

context: RequestContext;

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

Word.RequestContext

fields

Возвращает коллекцию объектов полей в таблице.

readonly fields: Word.FieldCollection;

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

Word.FieldCollection

Комментарии

[ Набор API: WordApi 1.4 ]

font

Возвращает шрифт. Используйте эту связь, чтобы получать и задавать имя, размер, цвет и другие свойства шрифта.

readonly font: Word.Font;

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

Word.Font

Комментарии

[ Набор API: WordApi 1.3 ]

headerRowCount

Указывает количество строк заголовков.

headerRowCount: number;

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

number

Комментарии

[ Набор API: WordApi 1.3 ]

horizontalAlignment

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

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 alignment details about the first table in the document.
await Word.run(async (context) => {
  const firstTable: Word.Table = context.document.body.tables.getFirst();
  firstTable.load(["alignment", "horizontalAlignment", "verticalAlignment"]);
  await context.sync();

  console.log(`Details about the alignment of the first table:`, `- Alignment of the table within the containing page column: ${firstTable.alignment}`, `- Horizontal alignment of every cell in the table: ${firstTable.horizontalAlignment}`, `- Vertical alignment of every cell in the table: ${firstTable.verticalAlignment}`);
});

isUniform

Указывает, однородны ли все строки таблицы.

readonly isUniform: boolean;

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

boolean

Комментарии

[ Набор API: WordApi 1.3 ]

nestingLevel

Возвращает уровень вложенности таблицы. Таблицам верхнего уровня соответствует значение 1.

readonly nestingLevel: number;

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

number

Комментарии

[ Набор API: WordApi 1.3 ]

parentBody

Возвращает родительский текст таблицы.

readonly parentBody: Word.Body;

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

Word.Body

Комментарии

[ Набор API: WordApi 1.3 ]

parentContentControl

Возвращает элемент управления содержимым, содержащий таблицу. Выдает ошибку ItemNotFound , если родительского элемента управления содержимым нет.

readonly parentContentControl: Word.ContentControl;

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

Word.ContentControl

Комментарии

[ Набор API: WordApi 1.3 ]

parentContentControlOrNullObject

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

readonly parentContentControlOrNullObject: Word.ContentControl;

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

Word.ContentControl

Комментарии

[ Набор API: WordApi 1.3 ]

parentTable

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

readonly parentTable: Word.Table;

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

Word.Table

Комментарии

[ Набор API: WordApi 1.3 ]

parentTableCell

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

readonly parentTableCell: Word.TableCell;

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

Word.TableCell

Комментарии

[ Набор API: WordApi 1.3 ]

parentTableCellOrNullObject

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

readonly parentTableCellOrNullObject: Word.TableCell;

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

Word.TableCell

Комментарии

[ Набор API: WordApi 1.3 ]

parentTableOrNullObject

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

readonly parentTableOrNullObject: Word.Table;

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

Word.Table

Комментарии

[ Набор API: WordApi 1.3 ]

rowCount

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

readonly rowCount: number;

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

number

Комментарии

[ Набор API: WordApi 1.3 ]

rows

Возвращает все строки таблицы.

readonly rows: Word.TableRowCollection;

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

Word.TableRowCollection

Комментарии

[ Набор 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 row 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();
  firstTableRow.load(["horizontalAlignment", "verticalAlignment"]);
  await context.sync();

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

shadingColor

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

shadingColor: string;

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

string

Комментарии

[ Набор API: WordApi 1.3 ]

style

Задает имя стиля для таблицы. Используйте это свойство для пользовательских стилей и локализованных имен стилей. Чтобы использовать встроенные стили, поддерживающие несколько языковых стандартов, применяйте свойство styleBuiltIn.

style: string;

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

string

Комментарии

[ Набор API: WordApi 1.3 ]

styleBandedColumns

Указывает, содержит ли таблица чередуемые столбцы.

styleBandedColumns: boolean;

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

boolean

Комментарии

[ Набор API: WordApi 1.3 ]

styleBandedRows

Указывает, содержит ли таблица чередуемые строки.

styleBandedRows: boolean;

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

boolean

Комментарии

[ Набор API: WordApi 1.3 ]

styleBuiltIn

Задает встроенное имя стиля для таблицы. Используйте это свойство для встроенных стилей, поддерживающих несколько языковых стандартов. Чтобы использовать пользовательские стили или локализованные имена стилей, применяйте свойство style.

styleBuiltIn: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6";

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

Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"

Комментарии

[ Набор API: WordApi 1.3 ]

styleFirstColumn

Указывает, содержит ли таблица первый столбец со специальным стилем.

styleFirstColumn: boolean;

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

boolean

Комментарии

[ Набор API: WordApi 1.3 ]

styleLastColumn

Указывает, содержит ли таблица последний столбец со специальным стилем.

styleLastColumn: boolean;

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

boolean

Комментарии

[ Набор API: WordApi 1.3 ]

styleTotalRow

Указывает, содержит ли таблица итоговую (последнюю) строку со специальным стилем.

styleTotalRow: boolean;

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

boolean

Комментарии

[ Набор API: WordApi 1.3 ]

tables

Возвращает дочерние таблицы, вложенные на один уровень ниже.

readonly tables: Word.TableCollection;

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

Word.TableCollection

Комментарии

[ Набор API: WordApi 1.3 ]

values

Задает текстовые значения в таблице в виде массива JavaScript 2D.

values: 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 alignment details about the first table in the document.
await Word.run(async (context) => {
  const firstTable: Word.Table = context.document.body.tables.getFirst();
  firstTable.load(["alignment", "horizontalAlignment", "verticalAlignment"]);
  await context.sync();

  console.log(`Details about the alignment of the first table:`, `- Alignment of the table within the containing page column: ${firstTable.alignment}`, `- Horizontal alignment of every cell in the table: ${firstTable.horizontalAlignment}`, `- Vertical alignment of every cell in the table: ${firstTable.verticalAlignment}`);
});

width

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

width: number;

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

number

Комментарии

[ Набор API: WordApi 1.3 ]

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

addColumns(insertLocation, columnCount, values)

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

addColumns(insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | "Start" | "End", columnCount: number, values?: string[][]): void;

Параметры

insertLocation

start | end | "Start" | "End"

Обязательно. Он должен быть "Start" или "End", соответствующий соответствующей стороне таблицы.

columnCount

number

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

values

string[][]

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

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

void

Комментарии

[ Набор API: WordApi 1.3 ]

addRows(insertLocation, rowCount, values)

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

addRows(insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | "Start" | "End", rowCount: number, values?: string[][]): Word.TableRowCollection;

Параметры

insertLocation

start | end | "Start" | "End"

Обязательно. Он должен быть "Start" или "End".

rowCount

number

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

values

string[][]

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

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

Word.TableRowCollection

Комментарии

[ Набор API: WordApi 1.3 ]

autoFitWindow()

Автоматически подбирает ширину столбцов таблицы в соответствии с шириной окна.

autoFitWindow(): void;

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

void

Комментарии

[ Набор API: WordApi 1.3 ]

clear()

Очищает содержимое таблицы.

clear(): void;

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

void

Комментарии

[ Набор API: WordApi 1.3 ]

delete()

Удаляет всю таблицу.

delete(): void;

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

void

Комментарии

[ Набор API: WordApi 1.3 ]

deleteColumns(columnIndex, columnCount)

Удаляет определенные столбцы. Применим к однородным таблицам.

deleteColumns(columnIndex: number, columnCount?: number): void;

Параметры

columnIndex

number

Обязательно. Первый удаляемый столбец.

columnCount

number

Необязательный параметр. Количество удаляемых столбцов. Значение по умолчанию 1.

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

void

Комментарии

[ Набор API: WordApi 1.3 ]

deleteRows(rowIndex, rowCount)

Удаляет определенные строки.

deleteRows(rowIndex: number, rowCount?: number): void;

Параметры

rowIndex

number

Обязательно. Первая удаляемая строка.

rowCount

number

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

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

void

Комментарии

[ Набор API: WordApi 1.3 ]

distributeColumns()

Равномерно распределяет ширину столбцов. Применим к однородным таблицам.

distributeColumns(): void;

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

void

Комментарии

[ Набор API: WordApi 1.3 ]

getBorder(borderLocation)

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

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

Параметры

borderLocation

Word.BorderLocation

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

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

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 table in the document.
await Word.run(async (context) => {
  const firstTable: Word.Table = context.document.body.tables.getFirst();
  const borderLocation = Word.BorderLocation.top;
  const border: Word.TableBorder = firstTable.getBorder(borderLocation);
  border.load(["type", "color", "width"]);
  await context.sync();

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

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

Комментарии

[ Набор API: WordApi 1.3 ]

getCell(rowIndex, cellIndex)

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

getCell(rowIndex: number, cellIndex: number): Word.TableCell;

Параметры

rowIndex

number

Обязательно. Индекс строки.

cellIndex

number

Обязательно. Индекс ячейки в строке.

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

Word.TableCell

Комментарии

[ Набор API: WordApi 1.3 ]

Примеры

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

// Gets the content of the first cell in the first table.
await Word.run(async (context) => {
  const firstCell: Word.Body = context.document.body.tables.getFirst().getCell(0, 0).body;
  firstCell.load("text");

  await context.sync();
  console.log("First cell's text is: " + firstCell.text);
});

getCellOrNullObject(rowIndex, cellIndex)

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

getCellOrNullObject(rowIndex: number, cellIndex: number): Word.TableCell;

Параметры

rowIndex

number

Обязательно. Индекс строки.

cellIndex

number

Обязательно. Индекс ячейки в строке.

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

Word.TableCell

Комментарии

[ Набор API: WordApi 1.3 ]

getCellPadding(cellPaddingLocation)

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

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

Параметры

cellPaddingLocation

Word.CellPaddingLocation

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

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

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 table in the document.
await Word.run(async (context) => {
  const firstTable: Word.Table = context.document.body.tables.getFirst();
  const cellPaddingLocation = Word.CellPaddingLocation.right;
  const cellPadding = firstTable.getCellPadding(cellPaddingLocation);
  await context.sync();

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

getCellPadding(cellPaddingLocationString)

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

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

Параметры

cellPaddingLocationString

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

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

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

OfficeExtension.ClientResult<number>

Комментарии

[ Набор API: WordApi 1.3 ]

getNext()

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

getNext(): Word.Table;

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

Word.Table

Комментарии

[ Набор API: WordApi 1.3 ]

getNextOrNullObject()

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

getNextOrNullObject(): Word.Table;

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

Word.Table

Комментарии

[ Набор API: WordApi 1.3 ]

getParagraphAfter()

Возвращает абзац после таблицы. Выдает ошибку ItemNotFound , если после таблицы нет абзаца.

getParagraphAfter(): Word.Paragraph;

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

Word.Paragraph

Комментарии

[ Набор API: WordApi 1.3 ]

getParagraphAfterOrNullObject()

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

getParagraphAfterOrNullObject(): Word.Paragraph;

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

Word.Paragraph

Комментарии

[ Набор API: WordApi 1.3 ]

getParagraphBefore()

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

getParagraphBefore(): Word.Paragraph;

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

Word.Paragraph

Комментарии

[ Набор API: WordApi 1.3 ]

getParagraphBeforeOrNullObject()

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

getParagraphBeforeOrNullObject(): Word.Paragraph;

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

Word.Paragraph

Комментарии

[ Набор API: WordApi 1.3 ]

getRange(rangeLocation)

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

getRange(rangeLocation?: Word.RangeLocation.whole | Word.RangeLocation.start | Word.RangeLocation.end | Word.RangeLocation.after | "Whole" | "Start" | "End" | "After"): Word.Range;

Параметры

rangeLocation

whole | start | end | after | "Whole" | "Start" | "End" | "After"

Необязательный параметр. Диапазон должен находиться в диапазоне "Whole", "Start", "End" или "After".

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

Word.Range

Комментарии

[ Набор API: WordApi 1.3 ]

insertContentControl()

Вставляет в таблицу элемент управления содержимым.

insertContentControl(): Word.ContentControl;

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

Word.ContentControl

Комментарии

[ Набор API: WordApi 1.3 ]

insertParagraph(paragraphText, insertLocation)

Вставляет абзац в указанном расположении.

insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Paragraph;

Параметры

paragraphText

string

Обязательно. Текст абзаца, который необходимо вставить.

insertLocation

before | after | "Before" | "After"

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

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

Word.Paragraph

Комментарии

[ Набор API: WordApi 1.3 ]

insertTable(rowCount, columnCount, insertLocation, values)

Вставляет таблицу с указанным количеством строк и столбцов.

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

Параметры

rowCount

number

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

columnCount

number

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

insertLocation

before | after | "Before" | "After"

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

values

string[][]

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

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

Word.Table

Комментарии

[ Набор API: WordApi 1.3 ]

load(options)

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

load(options?: Word.Interfaces.TableLoadOptions): Word.Table;

Параметры

options

Word.Interfaces.TableLoadOptions

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

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

Word.Table

load(propertyNames)

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

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

Параметры

propertyNames

string | string[]

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

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

Word.Table

load(propertyNamesAndPaths)

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

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

Параметры

propertyNamesAndPaths

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

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

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

Word.Table

mergeCells(topRow, firstCell, bottomRow, lastCell)

Объединяет ячейки, ограниченные включительно первой и последней ячейками.

mergeCells(topRow: number, firstCell: number, bottomRow: number, lastCell: number): Word.TableCell;

Параметры

topRow

number

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

firstCell

number

Обязательно. Индекс первой ячейки в строке

bottomRow

number

Обязательно. Строка последней ячейки

lastCell

number

Обязательно. Индекс последней ячейки в строке

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

Word.TableCell

Комментарии

[ Набор API: WordApi 1.4 ]

search(searchText, searchOptions)

Выполняет поиск с указанным searchOptions в область объекта таблицы. Результат поиска — это коллекция объектов диапазона.

search(searchText: string, searchOptions?: Word.SearchOptions | {
            ignorePunct?: boolean;
            ignoreSpace?: boolean;
            matchCase?: boolean;
            matchPrefix?: boolean;
            matchSuffix?: boolean;
            matchWholeWord?: boolean;
            matchWildcards?: boolean;
        }): Word.RangeCollection;

Параметры

searchText

string

Обязательно. Текст для поиска.

searchOptions

Word.SearchOptions | { ignorePunct?: boolean; ignoreSpace?: boolean; matchCase?: boolean; matchPrefix?: boolean; matchSuffix?: boolean; matchWholeWord?: boolean; matchWildcards?: boolean; }

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

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

Word.RangeCollection

Комментарии

[ Набор API: WordApi 1.3 ]

select(selectionMode)

Выбирает таблицу либо позицию в начале или в конце таблицы, а затем переходит к ней в Word.

select(selectionMode?: Word.SelectionMode): void;

Параметры

selectionMode

Word.SelectionMode

Необязательный параметр. Режим выбора должен быть "Select", "Start" или "End". Значение по умолчанию — Select.

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

void

Комментарии

[ Набор API: WordApi 1.3 ]

select(selectionModeString)

Выбирает таблицу либо позицию в начале или в конце таблицы, а затем переходит к ней в Word.

select(selectionModeString?: "Select" | "Start" | "End"): void;

Параметры

selectionModeString

"Select" | "Start" | "End"

Необязательный параметр. Режим выбора должен быть "Select", "Start" или "End". Значение по умолчанию — Select.

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

void

Комментарии

[ Набор API: WordApi 1.3 ]

set(properties, options)

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

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

Параметры

properties

Word.Interfaces.TableUpdateData

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

options

OfficeExtension.UpdateOptions

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

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

void

set(properties)

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

set(properties: Word.Table): void;

Параметры

properties

Word.Table

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

void

setCellPadding(cellPaddingLocation, cellPadding)

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

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

Параметры

cellPaddingLocation

Word.CellPaddingLocation

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

cellPadding

number

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

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

void

Комментарии

[ Набор API: WordApi 1.3 ]

setCellPadding(cellPaddingLocationString, cellPadding)

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

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

Параметры

cellPaddingLocationString

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

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

cellPadding

number

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

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

void

Комментарии

[ Набор API: WordApi 1.3 ]

toJSON()

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

toJSON(): Word.Interfaces.TableData;

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

Word.Interfaces.TableData

track()

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

track(): Word.Table;

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

Word.Table

untrack()

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

untrack(): Word.Table;

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

Word.Table