Edit

Share via


Word.Interfaces.RepeatingSectionContentControlLoadOptions interface

Represents the RepeatingSectionContentControl object.

Remarks

[ API set: WordApiDesktop 1.3 ]

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

allowInsertDeleteSection

Specifies whether users can add or remove sections from this repeating section content control by using the user interface.

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.

id

Returns the identification for the content control.

isTemporary

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

level

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

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

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

repeatingSectionItemTitle

Specifies the name of the repeating section items used in the context menu associated with this repeating section content control.

showingPlaceholderText

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

tag

Specifies a tag to identify the content control.

title

Specifies the title for the content control.

xmlapping

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

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

allowInsertDeleteSection

Specifies whether users can add or remove sections from this repeating section content control by using the user interface.

allowInsertDeleteSection?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.3 ]

appearance

Specifies the appearance of the content control.

appearance?: boolean;

Property Value

boolean

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

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.3 ]

id

Returns the identification for the content control.

id?: boolean;

Property Value

boolean

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 ]

level

Returns 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

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

Property Value

Remarks

[ API set: WordApiDesktop 1.3 ]

range

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 ]

repeatingSectionItemTitle

Specifies the name of the repeating section items used in the context menu associated with this repeating section content control.

repeatingSectionItemTitle?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.3 ]

showingPlaceholderText

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

showingPlaceholderText?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.3 ]

tag

Specifies a tag to identify the content control.

tag?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.3 ]

title

Specifies the title for the content control.

title?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.3 ]

xmlapping

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

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

xmlapping?: Word.Interfaces.XmlMappingLoadOptions;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]