Word.Interfaces.ContentControlLoadOptions interface

表示内容控件。 内容控件是文档中绑定的、有可能添加标签的区域,它们充当特定类型的内容的容器。 各个内容控件可能包含诸如图像、表格或格式化文本段落等内容。 目前,仅支持格式文本、纯文本和复选框内容控件。

注解

[ API 集:WordApi 1.1 ]

属性

$all

$all为 LoadOptions 指定将加载所有标量属性 (例如:Range.address) 但不加载导航属性 (例如: Range.format.fill.color) 。

appearance

指定内容控件的外观。 该值可以是“BoundingBox”、“Tags”或“Hidden”。

cannotDelete

指定一个值,该值指示用户是否可以删除内容控件。 与 removeWhenEdited 互相排斥。

cannotEdit

指定一个值,该值指示用户是否可以编辑内容控件的内容。

checkboxContentControl

如果内容控件的类型为“CheckBox”,则指定与复选框相关的数据。 否则为 null。

color

指定内容控件的颜色。 颜色以“#RRGGBB”格式或使用颜色名称指定。

font

获取内容控件的文本格式。 使用此对象获取和设置字体名称、大小、颜色和其他属性。

id

获取表示内容控件标识符的整数。

parentBody

获取 contentControl 的父正文。

parentContentControl

获取包含此内容控件的内容控件。 ItemNotFound如果没有父内容控件,则引发错误。

parentContentControlOrNullObject

获取包含此内容控件的内容控件。 如果没有父内容控件,则此方法将返回其属性设置为 true的对象isNullObject。 有关详细信息,请参阅 *OrNullObject 方法和属性

parentTable

获取包含 contentControl 的 table。 ItemNotFound如果未包含在表中,则引发错误。

parentTableCell

获取包含 contentControl 的 tableCell。 ItemNotFound如果表单元格中未包含错误,则引发错误。

parentTableCellOrNullObject

获取包含 contentControl 的 tableCell。 如果它未包含在表单元格中,则此方法将返回其 isNullObject 属性设置为 true的对象。 有关详细信息,请参阅 *OrNullObject 方法和属性

parentTableOrNullObject

获取包含 contentControl 的 table。 如果它未包含在表中,则此方法将返回一个 对象,其 isNullObject 属性设置为 true。 有关详细信息,请参阅 *OrNullObject 方法和属性

placeholderText

指定内容控件的占位符文本。 内容控件为空时,将显示灰色的文本。

注意:web 上的Word不支持此属性的设置操作。

removeWhenEdited

指定一个值,该值指示内容控件在编辑后是否将其删除。 与 cannotDelete 互相排斥。

style

指定内容控件的样式名称。 请对自定义样式和本地化样式名称使用此属性。 若要使用可以在区域设置之间移植的嵌入样式,请参阅“styleBuiltIn”属性。

styleBuiltIn

指定内容控件的内置样式名称。 请对可以在区域设置之间移植的嵌入样式使用此属性。 若要使用自定义样式或本地化样式名称,请参阅“style”属性。

subtype

获取 contentControl 的子类型。 对于富文本内容控件,子类型可以是“RichTextInline”、“RichTextParagraphs”、“RichTextTableCell”、“RichTextTableRow”和“RichTextTable”,或者对于纯文本内容控件,可以是“PlainTextInline”和“PlainTextParagraph”,也可以是复选框内容控件的“CheckBox”。

tag

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

text

获取内容控件的文本。

title

指定内容控件的标题。

type

获取内容控件的类型。 目前仅支持格式文本、纯文本和复选框内容控件。

属性详细信息

$all

$all为 LoadOptions 指定将加载所有标量属性 (例如:Range.address) 但不加载导航属性 (例如: Range.format.fill.color) 。

$all?: boolean;

属性值

boolean

appearance

指定内容控件的外观。 该值可以是“BoundingBox”、“Tags”或“Hidden”。

appearance?: boolean;

属性值

boolean

注解

[ API 集:WordApi 1.1 ]

cannotDelete

指定一个值,该值指示用户是否可以删除内容控件。 与 removeWhenEdited 互相排斥。

cannotDelete?: boolean;

属性值

boolean

注解

[ API 集:WordApi 1.1 ]

cannotEdit

指定一个值,该值指示用户是否可以编辑内容控件的内容。

cannotEdit?: boolean;

属性值

boolean

注解

[ API 集:WordApi 1.1 ]

checkboxContentControl

如果内容控件的类型为“CheckBox”,则指定与复选框相关的数据。 否则为 null。

checkboxContentControl?: Word.Interfaces.CheckboxContentControlLoadOptions;

属性值

注解

[ API 集:WordApi 1.7 ]

color

指定内容控件的颜色。 颜色以“#RRGGBB”格式或使用颜色名称指定。

color?: boolean;

属性值

boolean

注解

[ API 集:WordApi 1.1 ]

font

获取内容控件的文本格式。 使用此对象获取和设置字体名称、大小、颜色和其他属性。

font?: Word.Interfaces.FontLoadOptions;

属性值

注解

[ API 集:WordApi 1.1 ]

id

获取表示内容控件标识符的整数。

id?: boolean;

属性值

boolean

注解

[ API 集:WordApi 1.1 ]

parentBody

获取 contentControl 的父正文。

parentBody?: Word.Interfaces.BodyLoadOptions;

属性值

注解

[ API 集:WordApi 1.3 ]

parentContentControl

获取包含此内容控件的内容控件。 ItemNotFound如果没有父内容控件,则引发错误。

parentContentControl?: Word.Interfaces.ContentControlLoadOptions;

属性值

注解

[ API 集:WordApi 1.1 ]

parentContentControlOrNullObject

获取包含此内容控件的内容控件。 如果没有父内容控件,则此方法将返回其属性设置为 true的对象isNullObject。 有关详细信息,请参阅 *OrNullObject 方法和属性

parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions;

属性值

注解

[ API 集:WordApi 1.3 ]

parentTable

获取包含 contentControl 的 table。 ItemNotFound如果未包含在表中,则引发错误。

parentTable?: Word.Interfaces.TableLoadOptions;

属性值

注解

[ API 集:WordApi 1.3 ]

parentTableCell

获取包含 contentControl 的 tableCell。 ItemNotFound如果表单元格中未包含错误,则引发错误。

parentTableCell?: Word.Interfaces.TableCellLoadOptions;

属性值

注解

[ API 集:WordApi 1.3 ]

parentTableCellOrNullObject

获取包含 contentControl 的 tableCell。 如果它未包含在表单元格中,则此方法将返回其 isNullObject 属性设置为 true的对象。 有关详细信息,请参阅 *OrNullObject 方法和属性

parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions;

属性值

注解

[ API 集:WordApi 1.3 ]

parentTableOrNullObject

获取包含 contentControl 的 table。 如果它未包含在表中,则此方法将返回一个 对象,其 isNullObject 属性设置为 true。 有关详细信息,请参阅 *OrNullObject 方法和属性

parentTableOrNullObject?: Word.Interfaces.TableLoadOptions;

属性值

注解

[ API 集:WordApi 1.3 ]

placeholderText

指定内容控件的占位符文本。 内容控件为空时,将显示灰色的文本。

注意:web 上的Word不支持此属性的设置操作。

placeholderText?: boolean;

属性值

boolean

注解

[ API 集:WordApi 1.1 ]

removeWhenEdited

指定一个值,该值指示内容控件在编辑后是否将其删除。 与 cannotDelete 互相排斥。

removeWhenEdited?: boolean;

属性值

boolean

注解

[ API 集:WordApi 1.1 ]

style

指定内容控件的样式名称。 请对自定义样式和本地化样式名称使用此属性。 若要使用可以在区域设置之间移植的嵌入样式,请参阅“styleBuiltIn”属性。

style?: boolean;

属性值

boolean

注解

[ API 集:WordApi 1.1 ]

styleBuiltIn

指定内容控件的内置样式名称。 请对可以在区域设置之间移植的嵌入样式使用此属性。 若要使用自定义样式或本地化样式名称,请参阅“style”属性。

styleBuiltIn?: boolean;

属性值

boolean

注解

[ API 集:WordApi 1.3 ]

subtype

获取 contentControl 的子类型。 对于富文本内容控件,子类型可以是“RichTextInline”、“RichTextParagraphs”、“RichTextTableCell”、“RichTextTableRow”和“RichTextTable”,或者对于纯文本内容控件,可以是“PlainTextInline”和“PlainTextParagraph”,也可以是复选框内容控件的“CheckBox”。

subtype?: boolean;

属性值

boolean

注解

[ API 集:WordApi 1.3 ]

tag

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

tag?: boolean;

属性值

boolean

注解

[ API 集:WordApi 1.1 ]

text

获取内容控件的文本。

text?: boolean;

属性值

boolean

注解

[ API 集:WordApi 1.1 ]

title

指定内容控件的标题。

title?: boolean;

属性值

boolean

注解

[ API 集:WordApi 1.1 ]

type

获取内容控件的类型。 目前仅支持格式文本、纯文本和复选框内容控件。

type?: boolean;

属性值

boolean

注解

[ API 集:WordApi 1.1 ]