Word.Interfaces.ContentControlLoadOptions interface

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

属性

$all

指定加载选项将 $all 加载所有标量属性 ((如 Range.address) ),但不会加载导航属性 ((如 Range.format.fill.color) )。

appearance

指定内容控件的外观。 值可以是 boundingBoxtagshidden

buildingBlockGalleryContentControl

如果内容控件为 Word,则获取与构建基块库相关的数据。ContentControlType is buildingBlockGallery. 情况并非 null 如此。

cannotDelete

指定用户是否可以删除内容控件。 与 removeWhenEdited互斥。

cannotEdit

指定用户是否可以编辑内容控件的内容。

checkboxContentControl

获取内容控件的数据(当其类型为 checkBox时)。 情况并非 null 如此。

color

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

datePickerContentControl

如果内容控件为 Word,则获取日期选取器相关数据。ContentControlType is datePicker. 情况并非 null 如此。

font

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

groupContentControl

如果内容控件为 Word,则获取与组相关的数据。ContentControlType is group. 情况并非 null 如此。

id

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

parentBody

获取 contentControl 的父正文。

parentContentControl

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

parentContentControlOrNullObject

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

parentTable

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

parentTableCell

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

parentTableCellOrNullObject

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

parentTableOrNullObject

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

pictureContentControl

如果是内容控件的 Word,则获取与图片相关的数据。ContentControlType is picture. 情况并非 null 如此。

placeholderText

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

removeWhenEdited

指定是否在编辑内容控件后将其删除。 与 cannotDelete互斥。

repeatingSectionContentControl

如果是内容控件的 Word,则获取与重复节相关的数据。ContentControlType is repeatingSection. 情况并非 null 如此。

style

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

styleBuiltIn

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

subtype

获取 contentControl 的子类型。 子类型可以是 richTextInlinerichTextParagraphsrichTextTableCellrichTextTableRowrichTextTable以及格式文本内容控件,plainTextParagraphplainTextInline对于纯文本内容控件,checkBox对于复选框内容控件,dropDownList对于下拉列表内容控件,comboBox对于组合框内容控件,对于构建基块库内容控件datePickerbuildingBlockGallery对于日期选取器内容控件,repeatingSection对于重复节内容控件,picture对于图片内容控件group,对于组内容控件。

tag

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

text

获取内容控件的文本。

title

指定内容控件的标题。

type

获取内容控件的类型。 目前仅支持富文本、纯文本、检查框、下拉列表、组合框、构建基块库、日期选取器、重复节、图片和组内容控件。

xmlMapping

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

属性详细信息

$all

指定加载选项将 $all 加载所有标量属性 ((如 Range.address) ),但不会加载导航属性 ((如 Range.format.fill.color) )。

$all?: boolean;

属性值

boolean

appearance

指定内容控件的外观。 值可以是 boundingBoxtagshidden

appearance?: boolean;

属性值

boolean

注解

API 集:WordApi 1.1

buildingBlockGalleryContentControl

如果内容控件为 Word,则获取与构建基块库相关的数据。ContentControlType is buildingBlockGallery. 情况并非 null 如此。

buildingBlockGalleryContentControl?: Word.Interfaces.BuildingBlockGalleryContentControlLoadOptions;

属性值

注解

API 集:WordApiDesktop 1.3

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

datePickerContentControl

如果内容控件为 Word,则获取日期选取器相关数据。ContentControlType is datePicker. 情况并非 null 如此。

datePickerContentControl?: Word.Interfaces.DatePickerContentControlLoadOptions;

属性值

注解

API 集:WordApiDesktop 1.3

font

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

font?: Word.Interfaces.FontLoadOptions;

属性值

注解

API 集:WordApi 1.1

groupContentControl

如果内容控件为 Word,则获取与组相关的数据。ContentControlType is group. 情况并非 null 如此。

groupContentControl?: Word.Interfaces.GroupContentControlLoadOptions;

属性值

注解

API 集:WordApiDesktop 1.3

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

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

pictureContentControl

如果是内容控件的 Word,则获取与图片相关的数据。ContentControlType is picture. 情况并非 null 如此。

pictureContentControl?: Word.Interfaces.PictureContentControlLoadOptions;

属性值

注解

API 集:WordApiDesktop 1.3

placeholderText

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

placeholderText?: boolean;

属性值

boolean

注解

API 集:WordApi 1.1

removeWhenEdited

指定是否在编辑内容控件后将其删除。 与 cannotDelete互斥。

removeWhenEdited?: boolean;

属性值

boolean

注解

API 集:WordApi 1.1

repeatingSectionContentControl

如果是内容控件的 Word,则获取与重复节相关的数据。ContentControlType is repeatingSection. 情况并非 null 如此。

repeatingSectionContentControl?: Word.Interfaces.RepeatingSectionContentControlLoadOptions;

属性值

注解

API 集:WordApiDesktop 1.3

style

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

style?: boolean;

属性值

boolean

注解

API 集:WordApi 1.1

styleBuiltIn

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

styleBuiltIn?: boolean;

属性值

boolean

注解

API 集:WordApi 1.3

subtype

获取 contentControl 的子类型。 子类型可以是 richTextInlinerichTextParagraphsrichTextTableCellrichTextTableRowrichTextTable以及格式文本内容控件,plainTextParagraphplainTextInline对于纯文本内容控件,checkBox对于复选框内容控件,dropDownList对于下拉列表内容控件,comboBox对于组合框内容控件,对于构建基块库内容控件datePickerbuildingBlockGallery对于日期选取器内容控件,repeatingSection对于重复节内容控件,picture对于图片内容控件group,对于组内容控件。

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

xmlMapping

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

xmlMapping?: Word.Interfaces.XmlMappingLoadOptions;

属性值

注解

API 集:WordApiDesktop 1.3