Word.TableRow class
Представляет строку в документе Word.
- Extends
Комментарии
Свойства
| cell |
Получает количество ячеек в строке. |
| cells | Возвращает ячейки. Только для чтения. |
| context | Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office. |
| endnotes | Возвращает коллекцию концевых сносок в строке таблицы. |
| fields | Возвращает коллекцию объектов полей в строке таблицы. |
| font | Возвращает шрифт. Используйте эту связь, чтобы получать и задавать имя, размер, цвет и другие свойства шрифта. |
| footnotes | Возвращает коллекцию сносок в строке таблицы. |
| horizontal |
Задает горизонтальное выравнивание каждой ячейки в строке. Значение может быть "Слева", "По центру", "Справа" или "Оправдано". |
| is |
Проверяет, является ли элемент строкой заголовков. Чтобы задать количество строк заголовков, используйте в |
| parent |
Возвращает родительскую таблицу. |
| preferred |
Задает предпочтительную высоту строки в точках. |
| row |
Получает индекс строки в родительской таблице. |
| shading |
Задает цвет заливки. Цвет задается в формате "#RRGGBB" или по имени. |
| values | Задает текстовые значения в строке в виде массива JavaScript 2D. |
| vertical |
Задает вертикальное выравнивание ячеек в строке. Это может быть значение "Top", "Center" или "Bottom". |
Методы
| clear() | Очищает содержимое строки. |
| delete() | Удаляет всю строку. |
| get |
Возвращает стиль границ ячеек в строке. |
| get |
Возвращает стиль границ ячеек в строке. |
| get |
Возвращает размер поля ячейки в точках. |
| get |
Возвращает размер поля ячейки в точках. |
| get |
Возвращает следующую строку. Выдает ошибку, |
| get |
Возвращает следующую строку. Если эта строка является последней, то этот метод возвращает объект со свойством |
| insert |
Вставляет строки, используя данную строку в качестве шаблона. Если указаны значения, они вставляются в новые строки. |
| load(options) | Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| merge() | Объединяет строку в одну ячейку. |
| search(search |
Выполняет поиск с указанным параметром SearchOptions в области строки. Результат поиска — это коллекция объектов диапазона. |
| select(selection |
Выбирает строку и переходит к ней в Word. |
| select(selection |
Выбирает строку и переходит к ней в Word. |
| set(properties, options) | Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа. |
| set(properties) | Задает несколько свойств объекта одновременно на основе существующего загруженного объекта. |
| 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
Возвращает коллекцию объектов полей в строке таблицы.
readonly fields: Word.FieldCollection;Значение свойства
Комментарии
font
Возвращает шрифт. Используйте эту связь, чтобы получать и задавать имя, размер, цвет и другие свойства шрифта.
readonly font: Word.Font;Значение свойства
Комментарии
footnotes
Возвращает коллекцию сносок в строке таблицы.
readonly footnotes: Word.NoteItemCollection;Значение свойства
Комментарии
horizontalAlignment
Задает горизонтальное выравнивание каждой ячейки в строке. Значение может быть "Слева", "По центру", "Справа" или "Оправдано".
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
Комментарии
rowIndex
Получает индекс строки в родительской таблице.
readonly rowIndex: number;Значение свойства
number
Комментарии
shadingColor
Задает цвет заливки. Цвет задается в формате "#RRGGBB" или по имени.
shadingColor: string;Значение свойства
string
Комментарии
values
Задает текстовые значения в строке в виде массива JavaScript 2D.
values: string[][];Значение свойства
string[][]
Комментарии
verticalAlignment
Задает вертикальное выравнивание ячеек в строке. Это может быть значение "Top", "Center" или "Bottom".
verticalAlignment: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom";Значение свойства
Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"
Комментарии
Сведения о методе
clear()
Очищает содержимое строки.
clear(): void;Возвращаемое значение
void
Комментарии
delete()
Удаляет всю строку.
delete(): void;Возвращаемое значение
void
Комментарии
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(borderLocationString)
Возвращает стиль границ ячеек в строке.
getBorder(borderLocationString: "Top" | "Left" | "Bottom" | "Right" | "InsideHorizontal" | "InsideVertical" | "Inside" | "Outside" | "All"): Word.TableBorder;Параметры
- borderLocationString
-
"Top" | "Left" | "Bottom" | "Right" | "InsideHorizontal" | "InsideVertical" | "Inside" | "Outside" | "All"
Обязательно. Расположение границы.
Возвращаемое значение
Комментарии
getCellPadding(cellPaddingLocation)
Возвращает размер поля ячейки в точках.
getCellPadding(cellPaddingLocation: Word.CellPaddingLocation): OfficeExtension.ClientResult<number>;Параметры
- cellPaddingLocation
- Word.CellPaddingLocation
Обязательно. Расположение заполнений ячейки должно быть "Сверху", "Слева", "Внизу" или "Справа".
Возвращаемое значение
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(cellPaddingLocationString)
Возвращает размер поля ячейки в точках.
getCellPadding(cellPaddingLocationString: "Top" | "Left" | "Bottom" | "Right"): OfficeExtension.ClientResult<number>;Параметры
- cellPaddingLocationString
-
"Top" | "Left" | "Bottom" | "Right"
Обязательно. Расположение заполнений ячейки должно быть "Сверху", "Слева", "Внизу" или "Справа".
Возвращаемое значение
OfficeExtension.ClientResult<number>
Комментарии
getNext()
Возвращает следующую строку. Выдает ошибку, ItemNotFound если эта строка является последней.
getNext(): Word.TableRow;Возвращаемое значение
Комментарии
getNextOrNullObject()
Возвращает следующую строку. Если эта строка является последней, то этот метод возвращает объект со свойством isNullObjecttrue. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
getNextOrNullObject(): Word.TableRow;Возвращаемое значение
Комментарии
insertRows(insertLocation, rowCount, values)
Вставляет строки, используя данную строку в качестве шаблона. Если указаны значения, они вставляются в новые строки.
insertRows(insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After", rowCount: number, values?: string[][]): Word.TableRowCollection;Параметры
Обязательно. Место вставки новых строк относительно текущей строки. Он должен быть "До" или "После".
- rowCount
-
number
Обязательно. Количество добавляемых строк
- values
-
string[][]
Необязательный параметр. Строки для вставки в новые строки, указанные в виде массива 2D. Количество ячеек в каждой строке не должно превышать количество ячеек в существующей строке.
Возвращаемое значение
Комментарии
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)
Выполняет поиск с указанным параметром 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; }
Необязательный параметр. Параметры поиска.
Возвращаемое значение
Комментарии
select(selectionMode)
Выбирает строку и переходит к ней в Word.
select(selectionMode?: Word.SelectionMode): void;Параметры
- selectionMode
- Word.SelectionMode
Необязательный параметр. Режим выбора должен быть "Select", "Start" или "End". Значение по умолчанию — Select.
Возвращаемое значение
void
Комментарии
select(selectionModeString)
Выбирает строку и переходит к ней в Word.
select(selectionModeString?: "Select" | "Start" | "End"): void;Параметры
- selectionModeString
-
"Select" | "Start" | "End"
Необязательный параметр. Режим выбора должен быть "Select", "Start" или "End". Значение по умолчанию — Select.
Возвращаемое значение
void
Комментарии
set(properties, options)
Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.
set(properties: Interfaces.TableRowUpdateData, options?: OfficeExtension.UpdateOptions): void;Параметры
- properties
- Word.Interfaces.TableRowUpdateData
Объект JavaScript со свойствами, структурированными изоморфно по свойствам объекта, для которого вызывается метод .
- options
- OfficeExtension.UpdateOptions
Предоставляет возможность подавления ошибок, если объект свойств пытается задать какие-либо свойства, доступные только для чтения.
Возвращаемое значение
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
Обязательно. Расположение заполнений ячейки должно быть "Сверху", "Слева", "Внизу" или "Справа".
- cellPadding
-
number
Обязательно. Заполнение ячейки.
Возвращаемое значение
void
Комментарии
setCellPadding(cellPaddingLocationString, cellPadding)
Задает размер поля ячейки в точках.
setCellPadding(cellPaddingLocationString: "Top" | "Left" | "Bottom" | "Right", cellPadding: number): void;Параметры
- cellPaddingLocationString
-
"Top" | "Left" | "Bottom" | "Right"
Обязательно. Расположение заполнений ячейки должно быть "Сверху", "Слева", "Внизу" или "Справа".
- cellPadding
-
number
Обязательно. Заполнение ячейки.
Возвращаемое значение
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;Возвращаемое значение
Office Add-ins
Обратная связь
Ожидается в ближайшее время: в течение 2024 года мы постепенно откажемся от GitHub Issues как механизма обратной связи для контента и заменим его новой системой обратной связи. Дополнительные сведения см. в разделе https://aka.ms/ContentUserFeedback.
Отправить и просмотреть отзыв по