Word.Interfaces.ContentControlLoadOptions 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. The value can be boundingBox, tags, or hidden.

appearance?: boolean;

Property Value

Remarks

[ API set: WordApi 1.1 ]

Gets the building block gallery-related data if the content control's Word.ContentControlType is buildingBlockGallery. It's null otherwise.

buildingBlockGalleryContentControl?: Word.Interfaces.BuildingBlockGalleryContentControlLoadOptions;

Property Value

Remarks

[ API set: WordApiDesktop 1.3 ]

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

cannotDelete?: boolean;

Property Value

Remarks

[ API set: WordApi 1.1 ]

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

cannotEdit?: boolean;

Property Value

Remarks

[ API set: WordApi 1.1 ]

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

checkboxContentControl?: Word.Interfaces.CheckboxContentControlLoadOptions;

Property Value

Remarks

[ API set: WordApi 1.7 ]

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

color?: boolean;

Property Value

Remarks

[ API set: WordApi 1.1 ]

Gets the date picker-related data if the content control's Word.ContentControlType is datePicker. It's null otherwise.

datePickerContentControl?: Word.Interfaces.DatePickerContentControlLoadOptions;

Property Value

Remarks

[ API set: WordApiDesktop 1.3 ]

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

Remarks

[ API set: WordApi 1.1 ]

Gets the group-related data if the content control's Word.ContentControlType is group. It's null otherwise.

groupContentControl?: Word.Interfaces.GroupContentControlLoadOptions;

Property Value

Remarks

[ API set: WordApiDesktop 1.3 ]

Gets an integer that represents the content control identifier.

id?: boolean;

Property Value

Remarks

[ API set: WordApi 1.1 ]

Gets the parent body of the content control.

parentBody?: Word.Interfaces.BodyLoadOptions;

Property Value

Remarks

[ API set: WordApi 1.3 ]

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

Remarks

[ API set: WordApi 1.1 ]

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

Remarks

[ API set: WordApi 1.3 ]

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

Remarks

[ API set: WordApi 1.3 ]

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

Remarks

[ API set: WordApi 1.3 ]

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

Remarks

[ API set: WordApi 1.3 ]

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

Remarks

[ API set: WordApi 1.3 ]

Gets the picture-related data if the content control's Word.ContentControlType is picture. It's null otherwise.

pictureContentControl?: Word.Interfaces.PictureContentControlLoadOptions;

Property Value

Remarks

[ API set: WordApiDesktop 1.3 ]

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

placeholderText?: boolean;

Property Value

Remarks

[ API set: WordApi 1.1 ]

Specifies a value that indicates whether the content control is removed after it's edited. Mutually exclusive with cannotDelete.

removeWhenEdited?: boolean;

Property Value

Remarks

[ API set: WordApi 1.1 ]

Gets the repeating section-related data if the content control's Word.ContentControlType is repeatingSection. It's null otherwise.

repeatingSectionContentControl?: Word.Interfaces.RepeatingSectionContentControlLoadOptions;

Property Value

Remarks

[ API set: WordApiDesktop 1.3 ]

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

Remarks

[ API set: WordApi 1.1 ]

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

Remarks

[ API set: WordApi 1.3 ]

Gets the content control subtype. The subtype can be richTextInline, richTextParagraphs, richTextTableCell, richTextTableRow and richTextTable for rich text content controls, plainTextInline and plainTextParagraph for plain text content controls, checkBox for checkbox content controls, dropDownList for dropdown list content controls, comboBox for combo box content controls, buildingBlockGallery for building block gallery content controls, datePicker for date picker content controls, repeatingSection for repeating section content controls, picture for picture content controls, and group for group content controls.

subtype?: boolean;

Property Value

Remarks

[ API set: WordApi 1.3 ]

Specifies a tag to identify a content control.

tag?: boolean;

Property Value

Remarks

[ API set: WordApi 1.1 ]

Gets the text of the content control.

text?: boolean;

Property Value

Remarks

[ API set: WordApi 1.1 ]

Specifies the title for a content control.

title?: boolean;

Property Value

Remarks

[ API set: WordApi 1.1 ]

Gets the content control type. Only rich text, plain text, check box, dropdown list, combo box, building block gallery, date picker, repeating section, picture, and group content controls are supported currently.

type?: boolean;

Property Value

Remarks

[ API set: WordApi 1.1 ]

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

Property Value

Remarks

[ API set: WordApiDesktop 1.3 ]