Word.Interfaces.PictureContentControlData interface
An interface describing the data returned by calling pictureContentControl.toJSON().
Properties
| appearance | Specifies the appearance of the content control. |
| color | Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. |
| id | Returns the identification for the content control. |
| is |
Specifies whether to remove the content control from the active document when the user edits the contents of the control. |
| level | Returns the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. |
| lock |
Specifies if the content control is locked (can't be deleted). |
| lock |
Specifies if the contents of the content control are locked (not editable). |
| placeholder |
Returns a |
| range | Returns a |
| showing |
Returns whether the placeholder text for the content control is being displayed. |
| tag | Specifies a tag to identify the content control. |
| title | Specifies the title for the content control. |
| xml |
Returns an |
Property Details
appearance
Specifies the appearance of the content control.
appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden";Property Value
Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"
Remarks
color
Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format.
color?: string;Property Value
string
Remarks
id
Returns the identification for the content control.
id?: string;Property Value
string
Remarks
isTemporary
Specifies whether to remove the content control from the active document when the user edits the contents of the control.
isTemporary?: boolean;Property Value
boolean
Remarks
level
Returns the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline.
level?: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell";Property Value
Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"
Remarks
lockContentControl
Specifies if the content control is locked (can't be deleted). true means that the user can't delete it from the active document, false means it can be deleted.
lockContentControl?: boolean;Property Value
boolean
Remarks
lockContents
Specifies if the contents of the content control are locked (not editable). true means the user can't edit the contents, false means the contents are editable.
lockContents?: boolean;Property Value
boolean
Remarks
placeholderText
Returns a BuildingBlock object that represents the placeholder text for the content control.
placeholderText?: Word.Interfaces.BuildingBlockData;Property Value
Remarks
range
Returns a Range object that represents the contents of the content control in the active document.
range?: Word.Interfaces.RangeData;Property Value
Remarks
showingPlaceholderText
Returns whether the placeholder text for the content control is being displayed.
showingPlaceholderText?: boolean;Property Value
boolean
Remarks
tag
Specifies a tag to identify the content control.
tag?: string;Property Value
string
Remarks
title
Specifies the title for the content control.
title?: string;Property Value
string
Remarks
xmlMapping
Returns an XmlMapping object that represents the mapping of the content control to XML data in the data store of the document.
xmlMapping?: Word.Interfaces.XmlMappingData;