Word.Interfaces.ContentControlData interface
An interface describing the data returned by calling contentControl.toJSON().
Properties
| appearance | Specifies the appearance of the content control. The value can be 'BoundingBox', 'Tags', or 'Hidden'. |
| cannot |
Specifies a value that indicates whether the user can delete the content control. Mutually exclusive with removeWhenEdited. |
| cannot |
Specifies a value that indicates whether the user can edit the contents of the content control. |
| color | Specifies the color of the content control. Color is specified in '#RRGGBB' format or by using the color name. |
| content |
Gets the collection of content control objects in the content control. |
| font | Gets the text format of the content control. Use this to get and set font name, size, color, and other properties. |
| id | Gets an integer that represents the content control identifier. |
| inline |
Gets the collection of InlinePicture objects in the content control. The collection doesn't include floating images. |
| paragraphs | Gets the collection of paragraph objects in the content control. |
| placeholder |
Specifies the placeholder text of the content control. Dimmed text will be displayed when the content control is empty. Note: The set operation for this property isn't supported in Word on the web. |
| remove |
Specifies a value that indicates whether the content control is removed after it is edited. Mutually exclusive with cannotDelete. |
| style | Specifies the style name for the content control. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. |
| tag | Specifies a tag to identify a content control. |
| text | Gets the text of the content control. |
| title | Specifies the title for a content control. |
| type | Gets the content control type. Only rich text, plain text, and checkbox content controls are supported currently. |
Property Details
appearance
Specifies the appearance of the content control. The value can be 'BoundingBox', 'Tags', or 'Hidden'.
appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden";Property Value
Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"
Remarks
cannotDelete
Specifies a value that indicates whether the user can delete the content control. Mutually exclusive with removeWhenEdited.
cannotDelete?: boolean;Property Value
boolean
Remarks
cannotEdit
Specifies a value that indicates whether the user can edit the contents of the content control.
cannotEdit?: boolean;Property Value
boolean
Remarks
color
Specifies the color of the content control. Color is specified in '#RRGGBB' format or by using the color name.
color?: string;Property Value
string
Remarks
contentControls
Gets the collection of content control objects in the content control.
contentControls?: Word.Interfaces.ContentControlData[];Property Value
Remarks
font
Gets the text format of the content control. Use this to get and set font name, size, color, and other properties.
font?: Word.Interfaces.FontData;Property Value
Remarks
id
Gets an integer that represents the content control identifier.
id?: number;Property Value
number
Remarks
inlinePictures
Gets the collection of InlinePicture objects in the content control. The collection doesn't include floating images.
inlinePictures?: Word.Interfaces.InlinePictureData[];Property Value
Remarks
paragraphs
Gets the collection of paragraph objects in the content control.
paragraphs?: Word.Interfaces.ParagraphData[];Property Value
Remarks
Important: For requirement sets 1.1 and 1.2, paragraphs in tables wholly contained within this content control aren't returned. From requirement set 1.3, paragraphs in such tables are also returned.
placeholderText
Specifies the placeholder text of the content control. Dimmed text will be displayed when the content control is empty.
Note: The set operation for this property isn't supported in Word on the web.
placeholderText?: string;Property Value
string
Remarks
removeWhenEdited
Specifies a value that indicates whether the content control is removed after it is edited. Mutually exclusive with cannotDelete.
removeWhenEdited?: boolean;Property Value
boolean
Remarks
style
Specifies the style name for the content control. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property.
style?: string;Property Value
string
Remarks
tag
Specifies a tag to identify a content control.
tag?: string;Property Value
string
Remarks
text
Gets the text of the content control.
text?: string;Property Value
string
Remarks
title
Specifies the title for a content control.
title?: string;Property Value
string
Remarks
type
Gets the content control type. Only rich text, plain text, and checkbox content controls are supported currently.
type?: Word.ContentControlType | "Unknown" | "RichTextInline" | "RichTextParagraphs" | "RichTextTableCell" | "RichTextTableRow" | "RichTextTable" | "PlainTextInline" | "PlainTextParagraph" | "Picture" | "BuildingBlockGallery" | "CheckBox" | "ComboBox" | "DropDownList" | "DatePicker" | "RepeatingSection" | "RichText" | "PlainText";Property Value
Word.ContentControlType | "Unknown" | "RichTextInline" | "RichTextParagraphs" | "RichTextTableCell" | "RichTextTableRow" | "RichTextTable" | "PlainTextInline" | "PlainTextParagraph" | "Picture" | "BuildingBlockGallery" | "CheckBox" | "ComboBox" | "DropDownList" | "DatePicker" | "RepeatingSection" | "RichText" | "PlainText"
Remarks
Office Add-ins
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for