Word.Interfaces.RangeCollectionLoadOptions interface

Contains a collection of Word.Range objects.

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

font

For EACH ITEM in the collection: Gets the text format of the range. Use this to get and set font name, size, color, and other properties.

parentContentControl

For EACH ITEM in the collection: Gets the currently supported content control that contains the range. Throws an ItemNotFound error if there isn't a parent content control.

style

For EACH ITEM in the collection: Specifies the style name for the range. 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.

text

For EACH ITEM in the collection: Gets the text of the range.

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

font

For EACH ITEM in the collection: Gets the text format of the range. 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 ]

parentContentControl

For EACH ITEM in the collection: Gets the currently supported content control that contains the range. Throws an ItemNotFound error if there isn't a parent content control.

parentContentControl?: Word.Interfaces.ContentControlLoadOptions;

Property Value

Remarks

[ API set: WordApi 1.1 ]

style

For EACH ITEM in the collection: Specifies the style name for the range. 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 ]

text

For EACH ITEM in the collection: Gets the text of the range.

text?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.1 ]