Word.BuildingBlockGalleryContentControl class
代表 BuildingBlockGalleryContentControl 对象。
属性
| appearance | 指定内容控件的外观。 |
| building |
指定构建基块内容控件的类别。 |
| building |
指定一个 |
| color | 指定内容控件颜色的红-绿-蓝 (RGB) 值。 可以用“#RRGGBB”格式提供值。 |
| context | 与对象关联的请求上下文。 这将加载项的进程连接到 Office 主机应用程序的进程。 |
| id | 获取内容控件的标识。 |
| is |
指定当用户编辑控件内容时是否从活动文档中删除内容控件。 |
| level | 获取内容控件的级别 - 内容控件是在文本、段落、表格单元格还是表格行周围;或者是否是内联的。 |
| lock |
指定内容控件是否已锁定 (无法) 删除。
|
| lock |
指定内容控件的内容是否已锁定 (不可编辑) 。
|
| placeholder |
返回 |
| range | 返回 |
| showing |
获取是否显示内容控件的占位符文本。 |
| tag | 指定用于标识内容控件的标记。 |
| title | 指定内容控件的标题。 |
| xml |
返回一个 |
方法
| copy() | 将活动文档中的内容控件复制到剪贴板。 |
| cut() | 从活动文档中删除内容控件并将该内容控件移动到剪贴板中。 |
| delete(delete |
删除内容控件和可选内容。 |
| load(options) | 将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| set(properties, options) | 同时设置对象的多个属性。 可以传递具有相应属性的纯文本对象，也可以传递另一个相同类型的 API 对象。 |
| set(properties) | 基于现有加载的对象，同时在对象上设置多个属性。 |
| set |
设置在用户输入自己的文本之前显示在内容控件中的占位符文本。 |
| toJSON() | 覆盖 JavaScript |
| track() | 根据文档中的相应更改来跟踪对象，以便进行自动调整。 此调用是 context.trackedObjects.add (thisObject) 的简写。 如果在调用中 |
| untrack() | 释放与此对象关联的内存（如果先前已跟踪过）。 此调用是 context.trackedObjects.remove (thisObject) 的简写。 拥有许多跟踪对象会降低主机应用程序的速度，因此请在使用完毕后释放所添加的任何对象。 需要在内存释放生效之前调用 |
属性详细信息
appearance
指定内容控件的外观。
appearance: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden";属性值
Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"
注解
buildingBlockCategory
buildingBlockType
指定一个 BuildingBlockType 值，该值表示构建基块内容控件的构建基块类型。
buildingBlockType: Word.BuildingBlockType | "QuickParts" | "CoverPage" | "Equations" | "Footers" | "Headers" | "PageNumber" | "Tables" | "Watermarks" | "AutoText" | "TextBox" | "PageNumberTop" | "PageNumberBottom" | "PageNumberPage" | "TableOfContents" | "CustomQuickParts" | "CustomCoverPage" | "CustomEquations" | "CustomFooters" | "CustomHeaders" | "CustomPageNumber" | "CustomTables" | "CustomWatermarks" | "CustomAutoText" | "CustomTextBox" | "CustomPageNumberTop" | "CustomPageNumberBottom" | "CustomPageNumberPage" | "CustomTableOfContents" | "Custom1" | "Custom2" | "Custom3" | "Custom4" | "Custom5" | "Bibliography" | "CustomBibliography";属性值
Word.BuildingBlockType | "QuickParts" | "CoverPage" | "Equations" | "Footers" | "Headers" | "PageNumber" | "Tables" | "Watermarks" | "AutoText" | "TextBox" | "PageNumberTop" | "PageNumberBottom" | "PageNumberPage" | "TableOfContents" | "CustomQuickParts" | "CustomCoverPage" | "CustomEquations" | "CustomFooters" | "CustomHeaders" | "CustomPageNumber" | "CustomTables" | "CustomWatermarks" | "CustomAutoText" | "CustomTextBox" | "CustomPageNumberTop" | "CustomPageNumberBottom" | "CustomPageNumberPage" | "CustomTableOfContents" | "Custom1" | "Custom2" | "Custom3" | "Custom4" | "Custom5" | "Bibliography" | "CustomBibliography"
注解
color
context
id
isTemporary
level
获取内容控件的级别 - 内容控件是在文本、段落、表格单元格还是表格行周围;或者是否是内联的。
readonly level: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell";属性值
Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"
注解
lockContentControl
指定内容控件是否已锁定 (无法) 删除。
true 意味着用户无法将其从活动文档中删除， false 意味着它可以删除。
lockContentControl: boolean;属性值
boolean
注解
lockContents
指定内容控件的内容是否已锁定 (不可编辑) 。
true 表示用户无法编辑内容， false 意味着内容可以编辑。
lockContents: boolean;属性值
boolean
注解
placeholderText
返回 BuildingBlock 表示内容控件的占位符文本的对象。
readonly placeholderText: Word.BuildingBlock;属性值
注解
range
showingPlaceholderText
tag
title
xmlMapping
返回一个 XmlMapping 对象，该对象表示内容控件到文档数据存储中 XML 数据的映射。
readonly xmlMapping: Word.XmlMapping;属性值
注解
方法详细信息
copy()
cut()
delete(deleteContents)
删除内容控件和可选内容。
delete(deleteContents?: boolean): void;参数
- deleteContents
-
boolean
可选。 是否删除控件内的内容。
返回
void
注解
load(options)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(options?: Word.Interfaces.BuildingBlockGalleryContentControlLoadOptions): Word.BuildingBlockGalleryContentControl;参数
为要加载的对象属性提供选项。
返回
load(propertyNames)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames?: string | string[]): Word.BuildingBlockGalleryContentControl;参数
- propertyNames
-
string | string[]
指定要加载的属性的逗号分隔的字符串或字符串数组。
返回
load(propertyNamesAndPaths)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Word.BuildingBlockGalleryContentControl;参数
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select 是指定要加载的属性的逗号分隔字符串，以及 propertyNamesAndPaths.expand 指定要加载的导航属性的逗号分隔字符串。
返回
set(properties, options)
同时设置对象的多个属性。 可以传递具有相应属性的纯文本对象，也可以传递另一个相同类型的 API 对象。
set(properties: Interfaces.BuildingBlockGalleryContentControlUpdateData, options?: OfficeExtension.UpdateOptions): void;参数
一个 JavaScript 对象，其属性与调用该方法的对象的属性同构结构。
- options
- OfficeExtension.UpdateOptions
提供一个选项，用于在 properties 对象尝试设置任何只读属性时禁止错误。
返回
void
set(properties)
基于现有加载的对象，同时在对象上设置多个属性。
set(properties: Word.BuildingBlockGalleryContentControl): void;参数
- properties
- Word.BuildingBlockGalleryContentControl
返回
void
setPlaceholderText(options)
设置在用户输入自己的文本之前显示在内容控件中的占位符文本。
setPlaceholderText(options?: Word.ContentControlPlaceholderOptions): void;参数
可选。 用于配置内容控件的占位符文本的选项。
返回
void
注解
toJSON()
覆盖 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 (JSON.stringify反过来调用 toJSON 传递给它的对象的方法。) 虽然原始 Word.BuildingBlockGalleryContentControl 对象是 API 对象， toJSON 但该方法返回一个纯 JavaScript 对象， (类型化为 Word.Interfaces.BuildingBlockGalleryContentControlData) ，其中包含从原始对象加载的任何子属性的浅层副本。
toJSON(): Word.Interfaces.BuildingBlockGalleryContentControlData;返回
track()
根据文档中的相应更改来跟踪对象，以便进行自动调整。 此调用是 context.trackedObjects.add (thisObject) 的简写。 如果在调用中 .sync 使用此对象，并且在“.run”批处理的顺序执行之外使用此对象，并且在设置属性或对对象调用方法时收到“InvalidObjectPath”错误，则需要在首次创建对象时将对象添加到跟踪对象集合。 如果此对象是集合的一部分，您还应跟踪父集合。
track(): Word.BuildingBlockGalleryContentControl;返回
untrack()
释放与此对象关联的内存（如果先前已跟踪过）。 此调用是 context.trackedObjects.remove (thisObject) 的简写。 拥有许多跟踪对象会降低主机应用程序的速度，因此请在使用完毕后释放所添加的任何对象。 需要在内存释放生效之前调用 context.sync() 。
untrack(): Word.BuildingBlockGalleryContentControl;