Word.TableRow class
Представляет строку в документе Word.
- 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}`,
);
});
Свойства
| cell |
Получает количество ячеек в строке. |
| cells | Возвращает ячейки. |
| context | Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office. |
| endnotes | Получает коллекцию концевых сносок в строке таблицы. |
| fields | Получает набор |
| font | Возвращает шрифт. Используйте эту связь, чтобы получать и задавать имя, размер, цвет и другие свойства шрифта. |
| footnotes | Получает коллекцию сносок в строке таблицы. |
| horizontal |
Выравнивание каждой ячейки строки по горизонтали. Значение может быть следующим : |
| is |
Проверяет, является ли элемент строкой заголовков. Чтобы задать количество строк заголовка, используйте |
| parent |
Возвращает родительскую таблицу. |
| preferred |
Указывает предпочтительную высоту строки в точках. |
| range | Возвращает объект, |
| row |
Получает индекс строки в родительской таблице. |
| shading | Возвращает |
| shading |
Цвет заливки. Цвет задается в формате "#RRGGBB" или по имени. |
| values | Определяет текстовые значения в строке как двумерный массив JavaScript. |
| vertical |
Определяет вертикальное выравнивание ячеек в строке. Это значение может быть следующим — |
Методы
| clear() | Очищает содержимое строки. |
| convert |
Преобразует строку таблицы в текст. |
| delete() | Удаляет всю строку. |
| get |
Возвращает стиль границ ячеек в строке. |
| get |
Возвращает стиль границ ячеек в строке. |
| get |
Возвращает размер поля ячейки в точках. |
| get |
Возвращает размер поля ячейки в точках. |
| get |
Возвращает следующую строку. Выдает ошибку, |
| get |
Возвращает следующую строку. Если эта строка последняя, то этот метод вернет объект со свойством |
| insert |
Вставляет элемент управления содержимым в строке. |
| insert |
Вставляет строки, используя данную строку в качестве шаблона. Если указаны значения, они вставляются в новые строки. |
| load(options) | Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| merge() | Объединяет строку в одну ячейку. |
| search(search |
Выполняет поиск с заданными параметрами поиска в области строки. Результаты поиска представляют собой набор |
| select(selection |
Выбирает строку и переходит к ней в Word. |
| select(selection |
Выбирает строку и переходит к ней в Word. |
| set(properties, options) | Задает несколько свойств объекта одновременно. Вы можете передать либо простой объект с соответствующими свойствами, либо другой объект API того же типа. |
| set(properties) | Одновременно задает несколько свойств объекта на основе существующего загруженного объекта. |
| set |
Задает размер поля ячейки в точках. |
| set |
Задает размер поля ячейки в точках. |
| set |
Установка высоты строки. |
| set |
Установка высоты строки. |
| set |
Задает левый отступ для строки таблицы. |
| set |
Задает левый отступ для строки таблицы. |
| toJSON() | Переопределяет метод JavaScript |
| track() | Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением от context.trackedObjects.add(thisObject). Если вы используете этот объект во всех |
| untrack() | Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращением от context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вам нужно позвонить |
Сведения о свойстве
cellCount
Получает количество ячеек в строке.
readonly cellCount: number;Значение свойства
number
Комментарии
cells
Возвращает ячейки.
readonly cells: Word.TableCellCollection;Значение свойства
Комментарии
Примеры
// 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.
context: RequestContext;Значение свойства
endnotes
Получает коллекцию концевых сносок в строке таблицы.
readonly endnotes: Word.NoteItemCollection;Значение свойства
Комментарии
fields
Получает набор Field объектов в строке таблицы.
readonly fields: Word.FieldCollection;Значение свойства
Комментарии
font
Возвращает шрифт. Используйте эту связь, чтобы получать и задавать имя, размер, цвет и другие свойства шрифта.
readonly font: Word.Font;Значение свойства
Комментарии
footnotes
Получает коллекцию сносок в строке таблицы.
readonly footnotes: Word.NoteItemCollection;Значение свойства
Комментарии
horizontalAlignment
Выравнивание каждой ячейки строки по горизонтали. Значение может быть следующим : left, rightcentered, или .justified
horizontalAlignment: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified";Значение свойства
Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"
Комментарии
isHeader
Проверяет, является ли элемент строкой заголовков. Чтобы задать количество строк заголовка, используйте headerRowCount для Table объекта.
readonly isHeader: boolean;Значение свойства
boolean
Комментарии
parentTable
Возвращает родительскую таблицу.
readonly parentTable: Word.Table;Значение свойства
Комментарии
preferredHeight
Указывает предпочтительную высоту строки в точках.
preferredHeight: number;Значение свойства
number
Комментарии
range
Возвращает объект, Range представляющий строку таблицы.
readonly range: Word.Range;Значение свойства
Комментарии
rowIndex
Получает индекс строки в родительской таблице.
readonly rowIndex: number;Значение свойства
number
Комментарии
shading
Возвращает ShadingUniversal объект, представляющий затенение строки таблицы.
readonly shading: Word.ShadingUniversal;Значение свойства
Комментарии
shadingColor
Цвет заливки. Цвет задается в формате "#RRGGBB" или по имени.
shadingColor: string;Значение свойства
string
Комментарии
values
Определяет текстовые значения в строке как двумерный массив JavaScript.
values: string[][];Значение свойства
string[][]
Комментарии
verticalAlignment
Определяет вертикальное выравнивание ячеек в строке. Это значение может быть следующим — top, centerили bottom.
verticalAlignment: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom";Значение свойства
Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"
Комментарии
Сведения о методе
clear()
Очищает содержимое строки.
clear(): void;Возвращаемое значение
void
Комментарии
convertToText(options)
Преобразует строку таблицы в текст.
convertToText(options?: Word.TableConvertToTextOptions): Word.Range;Параметры
- options
- Word.TableConvertToTextOptions
Необязательный параметр. Объект, определяющий параметры преобразования строки таблицы в текст.
Возвращаемое значение
Комментарии
delete()
getBorder(borderLocation)
Возвращает стиль границ ячеек в строке.
getBorder(borderLocation: Word.BorderLocation): Word.TableBorder;Параметры
- borderLocation
- Word.BorderLocation
Пограничное расположение.
Возвращаемое значение
Комментарии
Примеры
// 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 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();
const borderLocation = Word.BorderLocation.bottom;
const border: Word.TableBorder = firstTableRow.getBorder(borderLocation);
border.load(["type", "color", "width"]);
await context.sync();
console.log(
`Details about the ${borderLocation} border of the first table's first row:`,
`- Color: ${border.color}`,
`- Type: ${border.type}`,
`- Width: ${border.width} points`,
);
});
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"
Пограничное расположение.
Возвращаемое значение
Комментарии
getCellPadding(cellPaddingLocation)
Возвращает размер поля ячейки в точках.
getCellPadding(cellPaddingLocation: Word.CellPaddingLocation): OfficeExtension.ClientResult<number>;Параметры
- cellPaddingLocation
- Word.CellPaddingLocation
Расположение полей ячейки должно быть , topleftbottomили .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 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();
const cellPaddingLocation = Word.CellPaddingLocation.bottom;
const cellPadding = firstTableRow.getCellPadding(cellPaddingLocation);
await context.sync();
console.log(
`Cell padding details about the ${cellPaddingLocation} border of the first table's first row: ${cellPadding.value} points`,
);
});
getCellPadding(cellPaddingLocation)
Возвращает размер поля ячейки в точках.
getCellPadding(cellPaddingLocation: "Top" | "Left" | "Bottom" | "Right"): OfficeExtension.ClientResult<number>;Параметры
- cellPaddingLocation
-
"Top" | "Left" | "Bottom" | "Right"
Расположение полей ячейки должно быть , topleftbottomили .right
Возвращаемое значение
OfficeExtension.ClientResult<number>
Комментарии
getNext()
Возвращает следующую строку. Выдает ошибку, ItemNotFound если эта строка последняя.
getNext(): Word.TableRow;Возвращаемое значение
Комментарии
getNextOrNullObject()
Возвращает следующую строку. Если эта строка последняя, то этот метод вернет объект со свойством isNullObject , установленным в true. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
getNextOrNullObject(): Word.TableRow;Возвращаемое значение
Комментарии
insertContentControl()
Вставляет элемент управления содержимым в строке.
insertContentControl(): Word.ContentControl;Возвращаемое значение
Комментарии
insertRows(insertLocation, rowCount, values)
Вставляет строки, используя данную строку в качестве шаблона. Если указаны значения, они вставляются в новые строки.
insertRows(insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After", rowCount: number, values?: string[][]): Word.TableRowCollection;Параметры
Место вставки новых строк относительно текущей. Это должно быть before или after.
- rowCount
-
number
Количество строк для сложения.
- values
-
string[][]
Необязательный параметр. Строки для вставки в новые строки, заданные в виде двумерного массива. Количество ячеек в каждой строке не должно превышать количество ячеек в существующей строке.
Возвращаемое значение
Комментарии
load(options)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(options?: Word.Interfaces.TableRowLoadOptions): Word.TableRow;Параметры
Предоставляет параметры для загружаемых свойств объекта.
Возвращаемое значение
load(propertyNames)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames?: string | string[]): Word.TableRow;Параметры
- propertyNames
-
string | string[]
Строка с разделителями-запятыми или массив строк, которые определяют свойства для загрузки.
Возвращаемое значение
load(propertyNamesAndPaths)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Word.TableRow;Параметры
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и строка propertyNamesAndPaths.expand через запятую, указывающая свойства навигации для загрузки.
Возвращаемое значение
merge()
Объединяет строку в одну ячейку.
merge(): Word.TableCell;Возвращаемое значение
Комментарии
search(searchText, searchOptions)
Выполняет поиск с заданными параметрами поиска в области строки. Результаты поиска представляют собой набор Range объектов.
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; }
Необязательный параметр. Параметры поиска.
Возвращаемое значение
Комментарии
select(selectionMode)
Выбирает строку и переходит к ней в Word.
select(selectionMode?: Word.SelectionMode): void;Параметры
- selectionMode
- Word.SelectionMode
Необязательный параметр. Режим выделения должен быть , selectstartили .end
select используется по умолчанию.
Возвращаемое значение
void
Комментарии
select(selectionMode)
Выбирает строку и переходит к ней в Word.
select(selectionMode?: "Select" | "Start" | "End"): void;Параметры
- selectionMode
-
"Select" | "Start" | "End"
Необязательный параметр. Режим выделения должен быть , selectstartили .end
select используется по умолчанию.
Возвращаемое значение
void
Комментарии
set(properties, options)
Задает несколько свойств объекта одновременно. Вы можете передать либо простой объект с соответствующими свойствами, либо другой объект API того же типа.
set(properties: Interfaces.TableRowUpdateData, options?: OfficeExtension.UpdateOptions): void;Параметры
- properties
- Word.Interfaces.TableRowUpdateData
Объект JavaScript со свойствами, структурированными изоморфно свойствам объекта, для которого вызывается метод.
- options
- OfficeExtension.UpdateOptions
Предоставляет возможность подавления ошибок, если объект properties пытается задать какие-либо свойства только для чтения.
Возвращаемое значение
void
set(properties)
Одновременно задает несколько свойств объекта на основе существующего загруженного объекта.
set(properties: Word.TableRow): void;Параметры
- properties
- Word.TableRow
Возвращаемое значение
void
setCellPadding(cellPaddingLocation, cellPadding)
Задает размер поля ячейки в точках.
setCellPadding(cellPaddingLocation: Word.CellPaddingLocation, cellPadding: number): void;Параметры
- cellPaddingLocation
- Word.CellPaddingLocation
Расположение полей ячейки должно быть , topleftbottomили .right
- cellPadding
-
number
Заполнение ячеек.
Возвращаемое значение
void
Комментарии
setCellPadding(cellPaddingLocation, cellPadding)
Задает размер поля ячейки в точках.
setCellPadding(cellPaddingLocation: "Top" | "Left" | "Bottom" | "Right", cellPadding: number): void;Параметры
- cellPaddingLocation
-
"Top" | "Left" | "Bottom" | "Right"
Расположение полей ячейки должно быть , topleftbottomили .right
- cellPadding
-
number
Заполнение ячеек.
Возвращаемое значение
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
Комментарии
setLeftIndent(leftIndent, rulerStyle)
Задает левый отступ для строки таблицы.
setLeftIndent(leftIndent: number, rulerStyle: Word.RulerStyle): void;Параметры
- leftIndent
-
number
Расстояние (в точках) между текущим левым краем строки таблицы и нужным левым краем.
- rulerStyle
- Word.RulerStyle
Стиль линейки, который нужно применить.
Возвращаемое значение
void
Комментарии
setLeftIndent(leftIndent, rulerStyle)
Задает левый отступ для строки таблицы.
setLeftIndent(leftIndent: number, rulerStyle: "None" | "Proportional" | "FirstColumn" | "SameWidth"): void;Параметры
- leftIndent
-
number
Расстояние (в точках) между текущим левым краем строки таблицы и нужным левым краем.
- rulerStyle
-
"None" | "Proportional" | "FirstColumn" | "SameWidth"
Стиль линейки, который нужно применить.
Возвращаемое значение
void
Комментарии
toJSON()
Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringify, в свою очередь, вызывает toJSON метод переданного ему объекта.) В то время как исходный Word.TableRow объект является объектом API, toJSON метод возвращает простой объект JavaScript (типизированный как Word.Interfaces.TableRowData), который содержит неглубокие копии любых загруженных дочерних свойств исходного объекта.
toJSON(): Word.Interfaces.TableRowData;Возвращаемое значение
track()
Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением от context.trackedObjects.add(thisObject). Если вы используете этот объект во всех .sync вызовах и вне последовательного выполнения пакета ".run" и получаете сообщение об ошибке "InvalidObjectPath" при установке свойства или вызове метода объекта, необходимо добавить объект в коллекцию отслеживаемых объектов при его первом создании. Если этот объект является частью семейства, следует также отслеживать родительскую коллекцию.
track(): Word.TableRow;Возвращаемое значение
untrack()
Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращением от context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вам нужно позвонить context.sync() , прежде чем освобождение памяти вступит в силу.
untrack(): Word.TableRow;