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;