Word.BuildingBlock class

Представляет стандартный блок в шаблоне. Стандартный блок — это готовое содержимое, похожее на автотекст, которое может содержать текст, изображения и параметры форматирования.

Свойства

category	Возвращает объект, `BuildingBlockCategory` представляющий категорию стандартного блока.
context	Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office.
description	Задает описание стандартного блока.
id	Возвращает внутренний идентификационный номер стандартного блока.
index	Возвращает позицию этого стандартного блока в коллекции.
insertType	Значение `DocPartInsertType` , которое представляет способ вставки содержимого стандартного блока в документ.
name	Указывает имя стандартного блока.
type	Возвращает `BuildingBlockTypeItem` объект, представляющий тип стандартного блока.
value	Определяет содержимое стандартного блока.

Методы

delete()	Удаление стандартного блока.
insert(range, richText)	Вставляет значение стандартного блока в документ и возвращает объект, `Range` представляющий содержимое стандартного блока в документе.
load(options)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNames)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNamesAndPaths)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
set(properties, options)	Задает несколько свойств объекта одновременно. Вы можете передать либо простой объект с соответствующими свойствами, либо другой объект API того же типа.
set(properties)	Одновременно задает несколько свойств объекта на основе существующего загруженного объекта.
toJSON()	Переопределяет метод JavaScript `toJSON()` , чтобы обеспечить более полезные выходные данные при передаче объекта API в `JSON.stringify()`. (`JSON.stringify`, в свою очередь, вызывает `toJSON` метод переданного ему объекта.) В то время как исходный `Word.BuildingBlock` объект является объектом API, `toJSON` метод возвращает простой объект JavaScript (типизированный как `Word.Interfaces.BuildingBlockData`), который содержит неглубокие копии любых загруженных дочерних свойств исходного объекта.
track()	Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением от context.trackedObjects.add(thisObject). Если вы используете этот объект во всех `.sync` вызовах и вне последовательного выполнения пакета ".run" и получаете сообщение об ошибке "InvalidObjectPath" при установке свойства или вызове метода объекта, необходимо добавить объект в коллекцию отслеживаемых объектов при его первом создании. Если этот объект является частью семейства, следует также отслеживать родительскую коллекцию.
untrack()	Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращением от context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вам нужно позвонить `context.sync()` , прежде чем освобождение памяти вступит в силу.

context

Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office.

context: RequestContext;

Значение свойства

Word.RequestContext

description

Задает описание стандартного блока.

description: string;

Значение свойства

string

id

Возвращает внутренний идентификационный номер стандартного блока.

readonly id: string;

Значение свойства

string

index

Возвращает позицию этого стандартного блока в коллекции.

readonly index: number;

Значение свойства

number

insertType

Значение DocPartInsertType , которое представляет способ вставки содержимого стандартного блока в документ.

insertType: Word.DocPartInsertType | "Content" | "Paragraph" | "Page";

Значение свойства

Word.DocPartInsertType | "Content" | "Paragraph" | "Page"

name

Указывает имя стандартного блока.

name: string;

Значение свойства

string

type

Возвращает BuildingBlockTypeItem объект, представляющий тип стандартного блока.

readonly type: Word.BuildingBlockTypeItem;

Значение свойства

Word.BuildingBlockTypeItem

value

Определяет содержимое стандартного блока.

value: string;

Значение свойства

string

delete()

Удаление стандартного блока.

delete(): void;

Возвращаемое значение

void

insert(range, richText)

Вставляет значение стандартного блока в документ и возвращает объект, Range представляющий содержимое стандартного блока в документе.

insert(range: Word.Range, richText: boolean): Word.Range;

Параметры

range: Word.Range

Диапазон, в который необходимо вставить стандартный блок.

richText: boolean

Указывает, следует ли вставлять в формате RTF.

Возвращаемое значение

Word.Range

load(options)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(options?: Word.Interfaces.BuildingBlockLoadOptions): Word.BuildingBlock;

Параметры

options: Word.Interfaces.BuildingBlockLoadOptions

Предоставляет параметры для загружаемых свойств объекта.

Возвращаемое значение

Word.BuildingBlock

load(propertyNames)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(propertyNames?: string | string[]): Word.BuildingBlock;

Параметры

propertyNames: string | string[]

Строка с разделителями-запятыми или массив строк, которые определяют свойства для загрузки.

Возвращаемое значение

Word.BuildingBlock

load(propertyNamesAndPaths)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Word.BuildingBlock;

Параметры

propertyNamesAndPaths: { select?: string; expand?: string; }

propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и строка propertyNamesAndPaths.expand через запятую, указывающая свойства навигации для загрузки.

Возвращаемое значение

Word.BuildingBlock

set(properties, options)

Задает несколько свойств объекта одновременно. Вы можете передать либо простой объект с соответствующими свойствами, либо другой объект API того же типа.

set(properties: Interfaces.BuildingBlockUpdateData, options?: OfficeExtension.UpdateOptions): void;

Параметры

properties: Word.Interfaces.BuildingBlockUpdateData

Объект JavaScript со свойствами, структурированными изоморфно свойствам объекта, для которого вызывается метод.

options: OfficeExtension.UpdateOptions

Предоставляет возможность подавления ошибок, если объект properties пытается задать какие-либо свойства только для чтения.

Возвращаемое значение

void

set(properties)

Одновременно задает несколько свойств объекта на основе существующего загруженного объекта.

set(properties: Word.BuildingBlock): void;

Параметры

properties: Word.BuildingBlock

Возвращаемое значение

void

toJSON()

Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringify, в свою очередь, вызывает toJSON метод переданного ему объекта.) В то время как исходный Word.BuildingBlock объект является объектом API, toJSON метод возвращает простой объект JavaScript (типизированный как Word.Interfaces.BuildingBlockData), который содержит неглубокие копии любых загруженных дочерних свойств исходного объекта.

toJSON(): Word.Interfaces.BuildingBlockData;

Возвращаемое значение

Word.Interfaces.BuildingBlockData

track()

Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением от context.trackedObjects.add(thisObject). Если вы используете этот объект во всех .sync вызовах и вне последовательного выполнения пакета ".run" и получаете сообщение об ошибке "InvalidObjectPath" при установке свойства или вызове метода объекта, необходимо добавить объект в коллекцию отслеживаемых объектов при его первом создании. Если этот объект является частью семейства, следует также отслеживать родительскую коллекцию.

track(): Word.BuildingBlock;

Возвращаемое значение

Word.BuildingBlock

untrack()

Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращением от context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вам нужно позвонить context.sync() , прежде чем освобождение памяти вступит в силу.

untrack(): Word.BuildingBlock;

Возвращаемое значение

Word.BuildingBlock

Комментарии

Используется

Свойства

Методы

Сведения о свойстве

category

Значение свойства

Комментарии

context

Значение свойства

description

Значение свойства

Комментарии

id

Значение свойства

Комментарии

index

Значение свойства

Комментарии

insertType

Значение свойства

Комментарии

name

Значение свойства

Комментарии

type

Значение свойства

Комментарии

value

Значение свойства

Комментарии

Сведения о методе

delete()

Возвращаемое значение

Комментарии

insert(range, richText)

Параметры

Возвращаемое значение

Комментарии

load(options)

Параметры

Возвращаемое значение

load(propertyNames)

Параметры

Возвращаемое значение

load(propertyNamesAndPaths)

Параметры

Возвращаемое значение

set(properties, options)

Параметры

Возвращаемое значение

set(properties)

Параметры

Возвращаемое значение

toJSON()

Возвращаемое значение

track()

Возвращаемое значение

untrack()

Возвращаемое значение

Обратная связь