Word.Interfaces.ContentControlUpdateData interface

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

Properties

appearance

Specifies the appearance of the content control. The value can be 'BoundingBox', 'Tags', or 'Hidden'.

cannotDelete

Specifies a value that indicates whether the user can delete the content control. Mutually exclusive with removeWhenEdited.

cannotEdit

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.

font

Gets the text format of the content control. Use this to get and set font name, size, color, and other properties.

placeholderText

Specifies the placeholder text of the content control. Dimmed text will be displayed when the content control is empty.

removeWhenEdited

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.

title

Specifies the title for a content control.

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

[ API set: WordApi 1.1 ]

cannotDelete

Specifies a value that indicates whether the user can delete the content control. Mutually exclusive with removeWhenEdited.

cannotDelete?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.1 ]

cannotEdit

Specifies a value that indicates whether the user can edit the contents of the content control.

cannotEdit?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.1 ]

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

[ API set: WordApi 1.1 ]

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

Property Value

Remarks

[ API set: WordApi 1.1 ]

placeholderText

Specifies the placeholder text of the content control. Dimmed text will be displayed when the content control is empty.

placeholderText?: string;

Property Value

string

Remarks

[ API set: WordApi 1.1 ]

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

[ API set: WordApi 1.1 ]

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

[ API set: WordApi 1.1 ]

tag

Specifies a tag to identify a content control.

tag?: string;

Property Value

string

Remarks

[ API set: WordApi 1.1 ]

title

Specifies the title for a content control.

title?: string;

Property Value

string

Remarks

[ API set: WordApi 1.1 ]