Word.Interfaces.RangeLoadOptions interface

Represents a contiguous area in a document.

[ API set: WordApi 1.1 ]

Properties

$all
font

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

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

Checks whether the range length is zero. Read-only.

[ API set: WordApi 1.3 ]

parentBody

Gets the parent body of the range.

[ API set: WordApi 1.3 ]

parentContentControl

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

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

Gets the table that contains the range. Throws an error if it is not contained in a table.

[ API set: WordApi 1.3 ]

parentTableCell

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

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

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

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

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

Gets the text of the range. Read-only.

[ API set: WordApi 1.1 ]

Property Details

$all

$all?: boolean;

Property Value

boolean

font

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

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

Checks whether the range length is zero. Read-only.

[ API set: WordApi 1.3 ]

isEmpty?: boolean;

Property Value

boolean

parentBody

Gets the parent body of the range.

[ API set: WordApi 1.3 ]

parentBody?: Word.Interfaces.BodyLoadOptions;

Property Value

parentContentControl

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

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

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

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

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

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

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

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

Gets the text of the range. Read-only.

[ API set: WordApi 1.1 ]

text?: boolean;

Property Value

boolean