Word.RepeatingSectionContentControl class

表示 RepeatingSectionContentControl 对象。

扩展

注解

[ API 集:WordApiDesktop 1.3 ]

属性

allowInsertDeleteSection

指定用户是否可以使用用户界面在此重复节内容控件中添加或删除节。

appearance

指定内容控件的外观。

color

指定内容控件颜色的红-绿-蓝 (RGB) 值。 可以采用“#RRGGBB”格式提供值。

context

与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。

id

返回内容控件的标识。

isTemporary

指定当用户编辑控件的内容时是否从活动文档中删除内容控件。

level

返回内容控件的级别 - 内容控件是包围文本、段落、表格单元格还是表行;或内联时。

lockContentControl

指定内容控件是否锁定 (无法) 删除。 true 表示用户无法从活动文档中删除它, false 表示可以将其删除。

lockContents

指定内容控件的内容是否锁定 (不可编辑) 。 true 表示用户无法编辑内容, false 表示内容可编辑。

placeholderText

返回一个 BuildingBlock 对象,该对象代表内容控件的占位符文本。

range

获取一个 Range 对象,该对象表示活动文档中的内容控件的内容。

repeatingSectionItems

返回此重复节内容控件中的重复节项的集合。

repeatingSectionItemTitle

指定与此重复节内容控件关联的上下文菜单中使用的重复节项的名称。

showingPlaceholderText

返回是否显示内容控件的占位符文本。

tag

指定用于标识内容控件的标记。

title

指定内容控件的标题。

xmlapping

返回一个 XmlMapping 对象,该对象表示内容控件到文档数据存储中的 XML 数据的映射。

方法

copy()

将活动文档中的内容控件复制到剪贴板。

cut()

从活动文档中删除内容控件并将该内容控件移动到剪贴板中。

delete(deleteContents)

删除内容控件和内容控件的内容。

load(options)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()

load(propertyNames)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()

load(propertyNamesAndPaths)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()

set(properties, options)

同时设置对象的多个属性。 可以传递具有相应属性的纯对象,也可以传递同一类型的另一个 API 对象。

set(properties)

基于现有的已加载对象,同时对对象设置多个属性。

setPlaceholderText(options)

设置在用户输入自己的文本之前显示在内容控件中的占位符文本。

toJSON()

重写 JavaScript toJSON() 方法,以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 JSON.stringify (,依次调用toJSON传递给它的 对象的 方法。) 虽然原始Word.RepeatingSectionContentControl对象是 API 对象,toJSON但该方法返回一个纯 JavaScript 对象, (类型为 Word.Interfaces.RepeatingSectionContentControlData) ,其中包含从原始对象加载的任何子属性的浅表副本。

track()

根据文档中的相应更改来跟踪对象,以便进行自动调整。 此调用是 context.trackedObjects.add (thisObject) 的简写。 如果跨 .sync 调用和“.run”批处理的顺序执行外部使用此对象,并在设置属性或调用对象方法时收到“InvalidObjectPath”错误,则需要在首次创建对象时将该对象添加到跟踪的对象集合。 如果此对象是集合的一部分,则还应跟踪父集合。

untrack()

释放与此对象关联的内存(如果先前已跟踪过)。 此调用是 context.trackedObjects.remove (thisObject) 的简写。 拥有许多跟踪对象会降低主机应用程序的速度,因此请在使用完毕后释放所添加的任何对象。 在内存发布生效之前,需要调用 context.sync()

属性详细信息

allowInsertDeleteSection

指定用户是否可以使用用户界面在此重复节内容控件中添加或删除节。

allowInsertDeleteSection: boolean;

属性值

boolean

注解

[ API 集:WordApiDesktop 1.3 ]

appearance

指定内容控件的外观。

appearance: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden";

属性值

Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"

注解

[ API 集:WordApiDesktop 1.3 ]

color

指定内容控件颜色的红-绿-蓝 (RGB) 值。 可以采用“#RRGGBB”格式提供值。

color: string;

属性值

string

注解

[ API 集:WordApiDesktop 1.3 ]

context

与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。

context: RequestContext;

属性值

id

返回内容控件的标识。

readonly id: string;

属性值

string

注解

[ API 集:WordApiDesktop 1.3 ]

isTemporary

指定当用户编辑控件的内容时是否从活动文档中删除内容控件。

isTemporary: boolean;

属性值

boolean

注解

[ API 集:WordApiDesktop 1.3 ]

level

返回内容控件的级别 - 内容控件是包围文本、段落、表格单元格还是表行;或内联时。

readonly level: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell";

属性值

Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"

注解

[ API 集:WordApiDesktop 1.3 ]

lockContentControl

指定内容控件是否锁定 (无法) 删除。 true 表示用户无法从活动文档中删除它, false 表示可以将其删除。

lockContentControl: boolean;

属性值

boolean

注解

[ API 集:WordApiDesktop 1.3 ]

lockContents

指定内容控件的内容是否锁定 (不可编辑) 。 true 表示用户无法编辑内容, false 表示内容可编辑。

lockContents: boolean;

属性值

boolean

注解

[ API 集:WordApiDesktop 1.3 ]

placeholderText

返回一个 BuildingBlock 对象,该对象代表内容控件的占位符文本。

readonly placeholderText: Word.BuildingBlock;

属性值

注解

[ API 集:WordApiDesktop 1.3 ]

range

获取一个 Range 对象,该对象表示活动文档中的内容控件的内容。

readonly range: Word.Range;

属性值

注解

[ API 集:WordApiDesktop 1.3 ]

repeatingSectionItems

返回此重复节内容控件中的重复节项的集合。

readonly repeatingSectionItems: Word.RepeatingSectionItemCollection;

属性值

注解

[ API 集:WordApiDesktop 1.3 ]

repeatingSectionItemTitle

指定与此重复节内容控件关联的上下文菜单中使用的重复节项的名称。

repeatingSectionItemTitle: string;

属性值

string

注解

[ API 集:WordApiDesktop 1.3 ]

showingPlaceholderText

返回是否显示内容控件的占位符文本。

readonly showingPlaceholderText: boolean;

属性值

boolean

注解

[ API 集:WordApiDesktop 1.3 ]

tag

指定用于标识内容控件的标记。

tag: string;

属性值

string

注解

[ API 集:WordApiDesktop 1.3 ]

title

指定内容控件的标题。

title: string;

属性值

string

注解

[ API 集:WordApiDesktop 1.3 ]

xmlapping

注意

此 API 以预览状态提供给开发者,可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

返回一个 XmlMapping 对象,该对象表示内容控件到文档数据存储中的 XML 数据的映射。

readonly xmlapping: Word.XmlMapping;

属性值

注解

[ API 集:WordApi BETA (仅预览版) ]

方法详细信息

copy()

将活动文档中的内容控件复制到剪贴板。

copy(): void;

返回

void

注解

[ API 集:WordApiDesktop 1.3 ]

cut()

从活动文档中删除内容控件并将该内容控件移动到剪贴板中。

cut(): void;

返回

void

注解

[ API 集:WordApiDesktop 1.3 ]

delete(deleteContents)

删除内容控件和内容控件的内容。

delete(deleteContents?: boolean): void;

参数

deleteContents

boolean

可选。 是否删除控件内的内容。

返回

void

注解

[ API 集:WordApiDesktop 1.3 ]

load(options)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()

load(options?: Word.Interfaces.RepeatingSectionContentControlLoadOptions): Word.RepeatingSectionContentControl;

参数

options
Word.Interfaces.RepeatingSectionContentControlLoadOptions

提供要加载对象的属性的选项。

返回

load(propertyNames)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()

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

参数

propertyNames

string | string[]

逗号分隔的字符串或指定要加载的属性的字符串数组。

返回

load(propertyNamesAndPaths)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()

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

参数

propertyNamesAndPaths

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

propertyNamesAndPaths.select 是一个逗号分隔的字符串,指定要加载的属性,是 propertyNamesAndPaths.expand 一个逗号分隔的字符串,指定要加载的导航属性。

返回

set(properties, options)

同时设置对象的多个属性。 可以传递具有相应属性的纯对象,也可以传递同一类型的另一个 API 对象。

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

参数

properties
Word.Interfaces.RepeatingSectionContentControlUpdateData

一个 JavaScript 对象,其属性按同构方式构造为调用方法的对象的属性。

options
OfficeExtension.UpdateOptions

提供一个选项,用于在 properties 对象尝试设置任何只读属性时禁止显示错误。

返回

void

set(properties)

基于现有的已加载对象,同时对对象设置多个属性。

set(properties: Word.RepeatingSectionContentControl): void;

参数

返回

void

setPlaceholderText(options)

设置在用户输入自己的文本之前显示在内容控件中的占位符文本。

setPlaceholderText(options?: Word.ContentControlPlaceholderOptions): void;

参数

options
Word.ContentControlPlaceholderOptions

可选。 用于配置内容控件的占位符文本的选项。

返回

void

注解

[ API 集:WordApiDesktop 1.3 ]

toJSON()

重写 JavaScript toJSON() 方法,以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 JSON.stringify (,依次调用toJSON传递给它的 对象的 方法。) 虽然原始Word.RepeatingSectionContentControl对象是 API 对象,toJSON但该方法返回一个纯 JavaScript 对象, (类型为 Word.Interfaces.RepeatingSectionContentControlData) ,其中包含从原始对象加载的任何子属性的浅表副本。

toJSON(): Word.Interfaces.RepeatingSectionContentControlData;

返回

track()

根据文档中的相应更改来跟踪对象,以便进行自动调整。 此调用是 context.trackedObjects.add (thisObject) 的简写。 如果跨 .sync 调用和“.run”批处理的顺序执行外部使用此对象,并在设置属性或调用对象方法时收到“InvalidObjectPath”错误,则需要在首次创建对象时将该对象添加到跟踪的对象集合。 如果此对象是集合的一部分,则还应跟踪父集合。

track(): Word.RepeatingSectionContentControl;

返回

untrack()

释放与此对象关联的内存(如果先前已跟踪过)。 此调用是 context.trackedObjects.remove (thisObject) 的简写。 拥有许多跟踪对象会降低主机应用程序的速度,因此请在使用完毕后释放所添加的任何对象。 在内存发布生效之前,需要调用 context.sync()

untrack(): Word.RepeatingSectionContentControl;

返回