Word.Interfaces.ContentControlUpdateData interface

用于更新对象上 ContentControl 的数据的接口,用于 contentControl.set({ ... }).

注解

使用方

属性

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 如此。

pictureContentControl

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

placeholderText

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

removeWhenEdited

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

repeatingSectionContentControl

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

style

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

styleBuiltIn

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

tag

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

title

指定内容控件的标题。

xmlMapping

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

属性详细信息

appearance

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

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

属性值

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

注解

API 集:WordApi 1.1

buildingBlockGalleryContentControl

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

buildingBlockGalleryContentControl?: Word.Interfaces.BuildingBlockGalleryContentControlUpdateData;

属性值

注解

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.CheckboxContentControlUpdateData;

属性值

注解

API 集:WordApi 1.7

color

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

color?: string;

属性值

string

注解

API 集:WordApi 1.1

datePickerContentControl

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

datePickerContentControl?: Word.Interfaces.DatePickerContentControlUpdateData;

属性值

注解

API 集:WordApiDesktop 1.3

font

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

font?: Word.Interfaces.FontUpdateData;

属性值

注解

API 集:WordApi 1.1

groupContentControl

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

groupContentControl?: Word.Interfaces.GroupContentControlUpdateData;

属性值

注解

API 集:WordApiDesktop 1.3

pictureContentControl

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

pictureContentControl?: Word.Interfaces.PictureContentControlUpdateData;

属性值

注解

API 集:WordApiDesktop 1.3

placeholderText

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

placeholderText?: string;

属性值

string

注解

API 集:WordApi 1.1

removeWhenEdited

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

removeWhenEdited?: boolean;

属性值

boolean

注解

API 集:WordApi 1.1

repeatingSectionContentControl

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

repeatingSectionContentControl?: Word.Interfaces.RepeatingSectionContentControlUpdateData;

属性值

注解

API 集:WordApiDesktop 1.3

style

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

style?: string;

属性值

string

注解

API 集:WordApi 1.1

styleBuiltIn

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

styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6";

属性值

Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"

注解

API 集:WordApi 1.3

tag

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

tag?: string;

属性值

string

注解

API 集:WordApi 1.1

title

指定内容控件的标题。

title?: string;

属性值

string

注解

API 集:WordApi 1.1

xmlMapping

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

xmlMapping?: Word.Interfaces.XmlMappingUpdateData;

属性值

注解

API 集:WordApiDesktop 1.3