Word.TableRowCollection class
Содержит коллекцию Word документа. Объекты TableRow.
- 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 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}`);
});
Свойства
| context | Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office. |
| items | Получает загруженные дочерние элементы в этой коллекции. |
Методы
| convert |
Преобразует строки в таблице в текст. |
| delete() | Удаляет строки таблицы. |
| distribute |
Настраивает высоту строк таким образом, чтобы они были равными. |
| get |
Возвращает первую строку в коллекции. Выдает ошибку, |
| get |
Возвращает первую строку в коллекции. Если коллекция пуста, то этот метод вернет объект со свойством |
| load(options) | Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| select() | Выбирает строки таблицы. |
| set |
Задает высоту ячеек в таблице. |
| set |
Задает высоту ячеек в таблице. |
| set |
Задает левый отступ для строки таблицы. |
| set |
Задает левый отступ для строки таблицы. |
| toJSON() | Переопределяет метод JavaScript |
| track() | Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением для context.trackedObjects.add(thisObject). Если вы используете этот объект в вызовах |
| untrack() | Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращенным для context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вызов потребуется выполнить |
Сведения о свойстве
context
Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
context: RequestContext;Значение свойства
items
Получает загруженные дочерние элементы в этой коллекции.
readonly items: Word.TableRow[];Значение свойства
Сведения о методе
convertToText(options)
Преобразует строки в таблице в текст.
convertToText(options?: Word.TableConvertToTextOptions): Word.Range;Параметры
- options
- Word.TableConvertToTextOptions
Необязательный параметр. Объект , указывающий параметры преобразования строк таблицы в текст.
Возвращаемое значение
Объект Range , представляющий преобразованный текст.
Комментарии
delete()
Удаляет строки таблицы.
delete(): void;Возвращаемое значение
void
Комментарии
distributeHeight()
Настраивает высоту строк таким образом, чтобы они были равными.
distributeHeight(): void;Возвращаемое значение
void
Комментарии
getFirst()
Возвращает первую строку в коллекции. Выдает ошибку, ItemNotFound если эта коллекция пуста.
getFirst(): Word.TableRow;Возвращаемое значение
Комментарии
Примеры
// 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`);
});
getFirstOrNullObject()
Возвращает первую строку в коллекции. Если коллекция пуста, то этот метод вернет объект со свойством isNullObject .true Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
getFirstOrNullObject(): Word.TableRow;Возвращаемое значение
Комментарии
load(options)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(options?: Word.Interfaces.TableRowCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TableRowCollection;Параметры
Предоставляет параметры свойств объекта для загрузки.
Возвращаемое значение
load(propertyNames)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames?: string | string[]): Word.TableRowCollection;Параметры
- propertyNames
-
string | string[]
Строка с разделителями-запятыми или массив строк, указывающих свойства для загрузки.
Возвращаемое значение
load(propertyNamesAndPaths)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.TableRowCollection;Параметры
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и propertyNamesAndPaths.expand строка с разделителями-запятыми, указывающая загружаемые свойства навигации.
Возвращаемое значение
select()
Выбирает строки таблицы.
select(): void;Возвращаемое значение
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.TableRowCollection объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Word.Interfaces.TableRowCollectionData), содержащий массив "items" с мелкими копиями всех загруженных свойств из элементов коллекции.
toJSON(): Word.Interfaces.TableRowCollectionData;Возвращаемое значение
track()
Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением для context.trackedObjects.add(thisObject). Если вы используете этот объект в вызовах .sync и вне последовательного выполнения пакета .run и получаете ошибку InvalidObjectPath при задании свойства или вызове метода для объекта, необходимо добавить объект в отслеживаемую коллекцию объектов при первом создании объекта. Если этот объект является частью коллекции, следует также отслеживать родительскую коллекцию.
track(): Word.TableRowCollection;Возвращаемое значение
untrack()
Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращенным для context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вызов потребуется выполнить context.sync() до того, как выпуск памяти вступит в силу.
untrack(): Word.TableRowCollection;