Word.Interfaces.ContentControlLoadOptions interface

Package:

word

Represents a content control. Content controls are bounded and potentially labeled regions in a document that serve as containers for specific types of content. Individual content controls may contain contents such as images, tables, or paragraphs of formatted text. Currently, only rich text, plain text, and checkbox content controls are supported.

Remarks

[ API set: WordApi 1.1 ]

Properties

$all	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).
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.
checkboxContentControl	Gets the data of the content control when its type is 'CheckBox'. It's null otherwise.
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.
id	Gets an integer that represents the content control identifier.
parentBody	Gets the parent body of the content control.
parentContentControl	Gets the content control that contains the content control. Throws an ItemNotFound error if there isn't a parent content control.
parentContentControlOrNullObject	Gets the content control that contains the content control. If there isn't a parent content control, then this method will return an object with its isNullObject property set to true. For further information, see *OrNullObject methods and properties.
parentTable	Gets the table that contains the content control. Throws an ItemNotFound error if it isn't contained in a table.
parentTableCell	Gets the table cell that contains the content control. Throws an ItemNotFound error if it isn't contained in a table cell.
parentTableCellOrNullObject	Gets the table cell that contains the content control. If it isn't contained in a table cell, then this method will return an object with its isNullObject property set to true. For further information, see *OrNullObject methods and properties.
parentTableOrNullObject	Gets the table that contains the content control. If it isn't contained in a table, then this method will return an object with its isNullObject property set to true. For further information, see *OrNullObject methods and 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.
styleBuiltIn	Specifies the built-in style name for the content control. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property.
subtype	Gets the content control subtype. The subtype can be 'RichTextInline', 'RichTextParagraphs', 'RichTextTableCell', 'RichTextTableRow' and 'RichTextTable' for rich text content controls, or 'PlainTextInline' and 'PlainTextParagraph' for plain text content controls, or 'CheckBox' for checkbox content controls.
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

$all

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

boolean

appearance

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

appearance?: boolean;

Property Value

boolean

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 ]

checkboxContentControl

Gets the data of the content control when its type is 'CheckBox'. It's null otherwise.

checkboxContentControl?: Word.Interfaces.CheckboxContentControlLoadOptions;

Property Value

Word.Interfaces.CheckboxContentControlLoadOptions

Remarks

[ API set: WordApi 1.7 ]

color

Specifies the color of the content control. Color is specified in '#RRGGBB' format or by using the color name.

color?: boolean;

Property Value

boolean

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

Property Value

Word.Interfaces.FontLoadOptions

Remarks

[ API set: WordApi 1.1 ]

id

Gets an integer that represents the content control identifier.

id?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.1 ]

parentBody

Gets the parent body of the content control.

parentBody?: Word.Interfaces.BodyLoadOptions;

Property Value

Word.Interfaces.BodyLoadOptions

Remarks

[ API set: WordApi 1.3 ]

parentContentControl

Gets the content control that contains the content control. Throws an ItemNotFound error if there isn't a parent content control.

parentContentControl?: Word.Interfaces.ContentControlLoadOptions;

Property Value

Word.Interfaces.ContentControlLoadOptions

Remarks

[ API set: WordApi 1.1 ]

parentContentControlOrNullObject

Gets the content control that contains the content control. If there isn't a parent content control, then this method will return an object with its isNullObject property set to true. For further information, see *OrNullObject methods and properties.

parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions;

Property Value

Word.Interfaces.ContentControlLoadOptions

Remarks

[ API set: WordApi 1.3 ]

parentTable

Gets the table that contains the content control. Throws an ItemNotFound error if it isn't contained in a table.

parentTable?: Word.Interfaces.TableLoadOptions;

Property Value

Word.Interfaces.TableLoadOptions

Remarks

[ API set: WordApi 1.3 ]

parentTableCell

Gets the table cell that contains the content control. Throws an ItemNotFound error if it isn't contained in a table cell.

parentTableCell?: Word.Interfaces.TableCellLoadOptions;

Property Value

Word.Interfaces.TableCellLoadOptions

Remarks

[ API set: WordApi 1.3 ]

parentTableCellOrNullObject

Gets the table cell that contains the content control. If it isn't contained in a table cell, then this method will return an object with its isNullObject property set to true. For further information, see *OrNullObject methods and properties.

parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions;

Property Value

Word.Interfaces.TableCellLoadOptions

Remarks

[ API set: WordApi 1.3 ]

parentTableOrNullObject

Gets the table that contains the content control. If it isn't contained in a table, then this method will return an object with its isNullObject property set to true. For further information, see *OrNullObject methods and properties.

parentTableOrNullObject?: Word.Interfaces.TableLoadOptions;

Property Value

Word.Interfaces.TableLoadOptions

Remarks

[ API set: WordApi 1.3 ]

placeholderText

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

placeholderText?: boolean;

Property Value

boolean

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?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.1 ]

styleBuiltIn

Specifies the built-in style name for the content control. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property.

styleBuiltIn?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.3 ]

subtype

Gets the content control subtype. The subtype can be 'RichTextInline', 'RichTextParagraphs', 'RichTextTableCell', 'RichTextTableRow' and 'RichTextTable' for rich text content controls, or 'PlainTextInline' and 'PlainTextParagraph' for plain text content controls, or 'CheckBox' for checkbox content controls.

subtype?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.3 ]

tag

Specifies a tag to identify a content control.

tag?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.1 ]

text

Gets the text of the content control.

text?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.1 ]

title

Specifies the title for a content control.

title?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.1 ]

type

Gets the content control type. Only rich text, plain text, and checkbox content controls are supported currently.

type?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.1 ]