Word.BuildingBlock class
代表模板中的构建基块。 构建基块是预先构建的内容，类似于自动图文集，其中可能包含文本、图像和格式。
注解
使用方
- Word.BuildingBlockCollection： add， getItemAt
- Word.BuildingBlockEntryCollection： add， getItemAt
- Word.BuildingBlockGalleryContentControl： placeholderText
- Word.ContentControlPlaceholderOptions： buildingBlock
- Word.DatePickerContentControl： placeholderText
- Word.GroupContentControl： placeholderText
- Word.PictureContentControl： placeholderText
- Word.RepeatingSectionContentControl： placeholderText
属性
| category | 返回 |
| context | 与对象关联的请求上下文。 这将加载项的进程连接到 Office 主机应用程序的进程。 |
| description | 指定构建基块的说明。 |
| id | 返回构建基块的内部标识号。 |
| index | 返回此构建基块在集合中的位置。 |
| insert |
指定一个 |
| name | 指定生成块的名称。 |
| type | 返回 |
| value | 指定构建基块的内容。 |
方法
| delete() | 删除构建基块。 |
| insert(range, rich |
将构建基块的值插入到文档中，并返回一个 |
| load(options) | 将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| set(properties, options) | 同时设置对象的多个属性。 可以传递具有相应属性的纯文本对象，也可以传递另一个相同类型的 API 对象。 |
| set(properties) | 基于现有加载的对象，同时在对象上设置多个属性。 |
| toJSON() | 覆盖 JavaScript |
| track() | 根据文档中的相应更改来跟踪对象，以便进行自动调整。 此调用是 context.trackedObjects.add (thisObject) 的简写。 如果在调用中 |
| untrack() | 释放与此对象关联的内存（如果先前已跟踪过）。 此调用是 context.trackedObjects.remove (thisObject) 的简写。 拥有许多跟踪对象会降低主机应用程序的速度，因此请在使用完毕后释放所添加的任何对象。 需要在内存释放生效之前调用 |
属性详细信息
category
返回 BuildingBlockCategory 表示构建基块类别的对象。
readonly category: Word.BuildingBlockCategory;属性值
注解
context
description
id
index
insertType
指定一个 DocPartInsertType 值，该值表示如何将构建基块的内容插入文档。
insertType: Word.DocPartInsertType | "Content" | "Paragraph" | "Page";属性值
Word.DocPartInsertType | "Content" | "Paragraph" | "Page"
注解
name
type
返回 BuildingBlockTypeItem 表示构建基块类型的对象。
readonly type: Word.BuildingBlockTypeItem;属性值
注解
value
方法详细信息
delete()
insert(range, richText)
将构建基块的值插入到文档中，并返回一个 Range 对象，该对象表示文档中构建基块的内容。
insert(range: Word.Range, richText: boolean): Word.Range;参数
- range
- Word.Range
应插入构建基块的区域。
- richText
-
boolean
指示是否作为富文本插入。
返回
注解
load(options)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(options?: Word.Interfaces.BuildingBlockLoadOptions): Word.BuildingBlock;参数
为要加载的对象属性提供选项。
返回
load(propertyNames)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames?: string | string[]): Word.BuildingBlock;参数
- propertyNames
-
string | string[]
指定要加载的属性的逗号分隔的字符串或字符串数组。
返回
load(propertyNamesAndPaths)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Word.BuildingBlock;参数
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select 是指定要加载的属性的逗号分隔字符串，以及 propertyNamesAndPaths.expand 指定要加载的导航属性的逗号分隔字符串。
返回
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;返回
track()
根据文档中的相应更改来跟踪对象，以便进行自动调整。 此调用是 context.trackedObjects.add (thisObject) 的简写。 如果在调用中 .sync 使用此对象，并且在“.run”批处理的顺序执行之外使用此对象，并且在设置属性或对对象调用方法时收到“InvalidObjectPath”错误，则需要在首次创建对象时将对象添加到跟踪对象集合。 如果此对象是集合的一部分，您还应跟踪父集合。
track(): Word.BuildingBlock;返回
untrack()
释放与此对象关联的内存（如果先前已跟踪过）。 此调用是 context.trackedObjects.remove (thisObject) 的简写。 拥有许多跟踪对象会降低主机应用程序的速度，因此请在使用完毕后释放所添加的任何对象。 需要在内存释放生效之前调用 context.sync() 。
untrack(): Word.BuildingBlock;