Word.Interfaces.RangeCollectionLoadOptions interface

Contains a collection of Word.Range objects.

[ API set: WordApi 1.1 ]

Properties

$all
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.

[ API set: WordApi 1.1 ]

hyperlink

For EACH ITEM in the collection: Gets the first hyperlink in the range, or sets a hyperlink on the range. All hyperlinks in the range are deleted when you set a new hyperlink on the range. Use a '#' to separate the address part from the optional location part.

[ API set: WordApi 1.3 ]

isEmpty

For EACH ITEM in the collection: Checks whether the range length is zero. Read-only.

[ API set: WordApi 1.3 ]

parentBody

For EACH ITEM in the collection: Gets the parent body of the range.

[ API set: WordApi 1.3 ]

parentContentControl

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

[ API set: WordApi 1.1 ]

parentContentControlOrNullObject

For EACH ITEM in the collection: Gets the content control that contains the range. Returns a null object if there isn't a parent content control.

[ API set: WordApi 1.3 ]

parentTable

For EACH ITEM in the collection: Gets the table that contains the range. Throws an error if it is not contained in a table.

[ API set: WordApi 1.3 ]

parentTableCell

For EACH ITEM in the collection: Gets the table cell that contains the range. Throws an error if it is not contained in a table cell.

[ API set: WordApi 1.3 ]

parentTableCellOrNullObject

For EACH ITEM in the collection: Gets the table cell that contains the range. Returns a null object if it is not contained in a table cell.

[ API set: WordApi 1.3 ]

parentTableOrNullObject

For EACH ITEM in the collection: Gets the table that contains the range. Returns a null object if it is not contained in a table.

[ API set: WordApi 1.3 ]

style

For EACH ITEM in the collection: Gets or sets 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.

[ API set: WordApi 1.1 ]

styleBuiltIn

For EACH ITEM in the collection: Gets or sets the built-in style name for the range. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property.

[ API set: WordApi 1.3 ]

text

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

[ API set: WordApi 1.1 ]

Property Details

$all

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

[ API set: WordApi 1.1 ]

font?: Word.Interfaces.FontLoadOptions;

Property Value

For EACH ITEM in the collection: Gets the first hyperlink in the range, or sets a hyperlink on the range. All hyperlinks in the range are deleted when you set a new hyperlink on the range. Use a '#' to separate the address part from the optional location part.

[ API set: WordApi 1.3 ]

hyperlink?: boolean;

Property Value

boolean

isEmpty

For EACH ITEM in the collection: Checks whether the range length is zero. Read-only.

[ API set: WordApi 1.3 ]

isEmpty?: boolean;

Property Value

boolean

parentBody

For EACH ITEM in the collection: Gets the parent body of the range.

[ API set: WordApi 1.3 ]

parentBody?: Word.Interfaces.BodyLoadOptions;

Property Value

parentContentControl

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

[ API set: WordApi 1.1 ]

parentContentControl?: Word.Interfaces.ContentControlLoadOptions;

Property Value

parentContentControlOrNullObject

For EACH ITEM in the collection: Gets the content control that contains the range. Returns a null object if there isn't a parent content control.

[ API set: WordApi 1.3 ]

parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions;

Property Value

parentTable

For EACH ITEM in the collection: Gets the table that contains the range. Throws an error if it is not contained in a table.

[ API set: WordApi 1.3 ]

parentTable?: Word.Interfaces.TableLoadOptions;

Property Value

parentTableCell

For EACH ITEM in the collection: Gets the table cell that contains the range. Throws an error if it is not contained in a table cell.

[ API set: WordApi 1.3 ]

parentTableCell?: Word.Interfaces.TableCellLoadOptions;

Property Value

parentTableCellOrNullObject

For EACH ITEM in the collection: Gets the table cell that contains the range. Returns a null object if it is not contained in a table cell.

[ API set: WordApi 1.3 ]

parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions;

Property Value

parentTableOrNullObject

For EACH ITEM in the collection: Gets the table that contains the range. Returns a null object if it is not contained in a table.

[ API set: WordApi 1.3 ]

parentTableOrNullObject?: Word.Interfaces.TableLoadOptions;

Property Value

style

For EACH ITEM in the collection: Gets or sets 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.

[ API set: WordApi 1.1 ]

style?: boolean;

Property Value

boolean

styleBuiltIn

For EACH ITEM in the collection: Gets or sets the built-in style name for the range. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property.

[ API set: WordApi 1.3 ]

styleBuiltIn?: boolean;

Property Value

boolean

text

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

[ API set: WordApi 1.1 ]

text?: boolean;

Property Value

boolean