Word.Interfaces.GroupContentControlLoadOptions interface

Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).

$all?: boolean;

Property Value

Specifies the appearance of the content control.

appearance?: boolean;

Property Value

Remarks

[ API set: WordApiDesktop 1.3 ]

Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format.

color?: boolean;

Property Value

Remarks

[ API set: WordApiDesktop 1.3 ]

Returns the identification for the content control.

id?: boolean;

Property Value

Remarks

[ API set: WordApiDesktop 1.3 ]

Specifies whether to remove the content control from the active document when the user edits the contents of the control.

isTemporary?: boolean;

Property Value

Remarks

[ API set: WordApiDesktop 1.3 ]

Gets the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline.

level?: boolean;

Property Value

Remarks

[ API set: WordApiDesktop 1.3 ]

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

Remarks

[ API set: WordApiDesktop 1.3 ]

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

Remarks

[ API set: WordApiDesktop 1.3 ]

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

placeholderText?: Word.Interfaces.BuildingBlockLoadOptions;

Property Value

Remarks

[ API set: WordApiDesktop 1.3 ]

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

range?: Word.Interfaces.RangeLoadOptions;

Property Value

Remarks

[ API set: WordApiDesktop 1.3 ]

Returns whether the placeholder text for the content control is being displayed.

showingPlaceholderText?: boolean;

Property Value

Remarks

[ API set: WordApiDesktop 1.3 ]

Specifies a tag to identify the content control.

tag?: boolean;

Property Value

Remarks

[ API set: WordApiDesktop 1.3 ]

Specifies the title for the content control.

title?: boolean;

Property Value

Remarks

[ API set: WordApiDesktop 1.3 ]

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

xmlMapping?: Word.Interfaces.XmlMappingLoadOptions;

Property Value

Remarks

[ API set: WordApiDesktop 1.3 ]