Word.BuildingBlock class

Пакет:

word

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

Extends

OfficeExtension.ClientObject

Комментарии

[ Набор API: WordApiDesktop 1.3 ]

Свойства

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() до того, как выпуск памяти вступит в силу.

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

category

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

readonly category: Word.BuildingBlockCategory;

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

Word.BuildingBlockCategory

Комментарии

[ Набор API: WordApiDesktop 1.3 ]

context

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

context: RequestContext;

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

Word.RequestContext

description

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

description: string;

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

string

Комментарии

[ Набор API: WordApiDesktop 1.3 ]

id

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

readonly id: string;

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

string

Комментарии

[ Набор API: WordApiDesktop 1.3 ]

index

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

readonly index: number;

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

number

Комментарии

[ Набор API: WordApiDesktop 1.3 ]

insertType

Указывает DocPartInsertType значение, представляющее способ вставки содержимого стандартного блока в документ.

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

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

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

Комментарии

[ Набор API: WordApiDesktop 1.3 ]

name

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

name: string;

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

string

Комментарии

[ Набор API: WordApiDesktop 1.3 ]

type

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

readonly type: Word.BuildingBlockTypeItem;

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

Word.BuildingBlockTypeItem

Комментарии

[ Набор API: WordApiDesktop 1.3 ]

value

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

value: string;

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

string

Комментарии

[ Набор API: WordApiDesktop 1.3 ]

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

delete()

Удаляет стандартный блок.

delete(): void;

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

void

Комментарии

[ Набор API: WordApiDesktop 1.3 ]

insert(range, richText)

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

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

Параметры

range

Word.Range

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

richText

boolean

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

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

Word.Range

Комментарии

[ Набор API: WordApiDesktop 1.3 ]

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

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

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

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