Edit

Share via

Word.Interfaces.PictureContentControlUpdateData interface

Package:
word

An interface for updating data on the PictureContentControl object, for use in pictureContentControl.set({ ... }).

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.
isTemporary

Specifies whether to remove the content control from the active document when the user edits the contents of the control.
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.
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.
placeholderText

Returns a BuildingBlock object that represents the placeholder text for the content control.
range

Returns a Range object that represents the contents of the content control in the active document.
tag

Specifies a tag to identify the content control.
title

Specifies the title for the content control.
xmlMapping

Returns an XmlMapping object that represents the mapping of the content control to XML data in the data store of the document.

Property Details

appearance

Specifies the appearance of the content control.

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

Property Value

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

Remarks

[ API set: WordApiDesktop 1.3 ]

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

[ API set: WordApiDesktop 1.3 ]

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

[ API set: WordApiDesktop 1.3 ]

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

[ API set: WordApiDesktop 1.3 ]

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

[ API set: WordApiDesktop 1.3 ]

placeholderText

Returns a BuildingBlock object that represents the placeholder text for the content control.

placeholderText?: Word.Interfaces.BuildingBlockUpdateData;

Property Value

Word.Interfaces.BuildingBlockUpdateData

Remarks

[ API set: WordApiDesktop 1.3 ]

range

Returns a Range object that represents the contents of the content control in the active document.

range?: Word.Interfaces.RangeUpdateData;

Property Value

Word.Interfaces.RangeUpdateData

Remarks

[ API set: WordApiDesktop 1.3 ]

tag

Specifies a tag to identify the content control.

tag?: string;

Property Value

string

Remarks

[ API set: WordApiDesktop 1.3 ]

title

Specifies the title for the content control.

title?: string;

Property Value

string

Remarks

[ API set: WordApiDesktop 1.3 ]

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

Property Value

Word.Interfaces.XmlMappingUpdateData

Remarks

[ API set: WordApiDesktop 1.3 ]