Word.Interfaces.RangeLoadOptions interface
Represents a contiguous area in a document.
Remarks
Properties
| $all | Specifying |
| font | Gets the text format of the range. Use this to get and set font name, size, color, and other properties. |
| has |
Specifies the proofing status (spelling and grammar checking) of the range. |
| 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. |
| is |
Checks whether the range length is zero. |
| language |
Specifies whether Microsoft Word has detected the language of the text in the range. |
| language |
Specifies a |
| language |
Specifies an East Asian language for the range. |
| language |
Specifies a language for the range that isn't classified as an East Asian language. |
| list |
Returns a |
| parent |
Gets the parent body of the range. |
| parent |
Gets the currently supported content control that contains the range. Throws an |
| parent |
Gets the currently supported content control that contains the range. If there isn't a parent content control, then this method will return an object with its |
| parent |
Gets the table that contains the range. Throws an |
| parent |
Gets the table cell that contains the range. Throws an |
| parent |
Gets the table cell that contains the range. If it isn't contained in a table cell, then this method will return an object with its |
| parent |
Gets the table that contains the range. If it isn't contained in a table, then this method will return an object with its |
| shading | Returns a |
| style | 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 |
Specifies 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. |
| text | 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
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
hasNoProofing
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.
Specifies the proofing status (spelling and grammar checking) of the range.
hasNoProofing?: boolean;Property Value
boolean
Remarks
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.
hyperlink?: boolean;Property Value
boolean
Remarks
isEmpty
Checks whether the range length is zero.
isEmpty?: boolean;Property Value
boolean
Remarks
languageDetected
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.
Specifies whether Microsoft Word has detected the language of the text in the range.
languageDetected?: boolean;Property Value
boolean
Remarks
languageId
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.
Specifies a LanguageId value that represents the language for the range.
languageId?: boolean;Property Value
boolean
Remarks
languageIdFarEast
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.
Specifies an East Asian language for the range.
languageIdFarEast?: boolean;Property Value
boolean
Remarks
languageIdOther
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.
Specifies a language for the range that isn't classified as an East Asian language.
languageIdOther?: boolean;Property Value
boolean
Remarks
listFormat
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 a ListFormat object that represents all the list formatting characteristics of the range.
listFormat?: Word.Interfaces.ListFormatLoadOptions;Property Value
Remarks
parentBody
Gets the parent body of the range.
parentBody?: Word.Interfaces.BodyLoadOptions;Property Value
Remarks
parentContentControl
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
parentContentControlOrNullObject
Gets the currently supported content control that contains the range. 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
parentTable
Gets the table that contains the range. Throws an ItemNotFound error if it isn't contained in a table.
parentTable?: Word.Interfaces.TableLoadOptions;Property Value
Remarks
parentTableCell
Gets the table cell that contains the range. Throws an ItemNotFound error if it isn't contained in a table cell.
parentTableCell?: Word.Interfaces.TableCellLoadOptions;Property Value
Remarks
parentTableCellOrNullObject
Gets the table cell that contains the range. 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
parentTableOrNullObject
Gets the table that contains the range. 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
shading
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 a ShadingUniversal object that refers to the shading formatting for the range.
shading?: Word.Interfaces.ShadingUniversalLoadOptions;Property Value
Remarks
style
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
styleBuiltIn
Specifies 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.
styleBuiltIn?: boolean;Property Value
boolean