Word.BuildingBlockCollection class
Представляет коллекцию Word. Объекты BuildingBlock для определенного типа и категории стандартных блоков в шаблоне.
- Extends
Комментарии
Свойства
| context | Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office. |
Методы
| add(name, range, description, insert |
Создает новый стандартный блок и возвращает |
| add(name, range, description, insert |
Создает новый стандартный блок и возвращает |
| get |
Возвращает количество элементов в коллекции. |
| get |
|
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| toJSON() | Переопределяет метод JavaScript |
| track() | Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением для context.trackedObjects.add(thisObject). Если вы используете этот объект в вызовах |
| untrack() | Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращенным для context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вызов потребуется выполнить |
Сведения о свойстве
context
Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
context: RequestContext;Значение свойства
Сведения о методе
add(name, range, description, insertType)
Создает новый стандартный блок и возвращает BuildingBlock объект .
add(name: string, range: Word.Range, description: string, insertType: Word.DocPartInsertType): Word.BuildingBlock;Параметры
- name
-
string
Имя стандартного блока.
- range
- Word.Range
Диапазон для вставки стандартного блока.
- description
-
string
Описание стандартного блока.
- insertType
- Word.DocPartInsertType
Вставка содержимого стандартного блока.
Возвращаемое значение
Комментарии
add(name, range, description, insertType)
Создает новый стандартный блок и возвращает BuildingBlock объект .
add(name: string, range: Word.Range, description: string, insertType: "Content" | "Paragraph" | "Page"): Word.BuildingBlock;Параметры
- name
-
string
Имя стандартного блока.
- range
- Word.Range
Диапазон для вставки стандартного блока.
- description
-
string
Описание стандартного блока.
- insertType
-
"Content" | "Paragraph" | "Page"
Вставка содержимого стандартного блока.
Возвращаемое значение
Комментарии
getCount()
Возвращает количество элементов в коллекции.
getCount(): OfficeExtension.ClientResult<number>;Возвращаемое значение
OfficeExtension.ClientResult<number>
Комментарии
getItemAt(index)
BuildingBlock Возвращает объект , представляющий указанный элемент в коллекции.
getItemAt(index: number): Word.BuildingBlock;Параметры
- index
-
number
Индекс извлекаемого элемента.
Возвращаемое значение
Комментарии
load(propertyNames)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames?: string | string[]): Word.BuildingBlockCollection;Параметры
- propertyNames
-
string | string[]
Строка с разделителями-запятыми или массив строк, указывающих свойства для загрузки.
Возвращаемое значение
load(propertyNamesAndPaths)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Word.BuildingBlockCollection;Параметры
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и propertyNamesAndPaths.expand строка с разделителями-запятыми, указывающая загружаемые свойства навигации.
Возвращаемое значение
toJSON()
Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный Word.BuildingBlockCollection объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Word.Interfaces.BuildingBlockCollectionData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.
toJSON(): {
[key: string]: string;
};Возвращаемое значение
{ [key: string]: string; }
track()
Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением для context.trackedObjects.add(thisObject). Если вы используете этот объект в вызовах .sync и вне последовательного выполнения пакета .run и получаете ошибку InvalidObjectPath при задании свойства или вызове метода для объекта, необходимо добавить объект в отслеживаемую коллекцию объектов при первом создании объекта. Если этот объект является частью коллекции, следует также отслеживать родительскую коллекцию.
track(): Word.BuildingBlockCollection;Возвращаемое значение
untrack()
Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращенным для context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вызов потребуется выполнить context.sync() до того, как выпуск памяти вступит в силу.
untrack(): Word.BuildingBlockCollection;