Excel.TextRange class

Contains the text that is attached to a shape, in addition to properties and methods for manipulating the text.

[ API set: ExcelApi 1.9 ]

Extends
OfficeExtension.ClientObject

Properties

context

The request context associated with the object. This connects the add-in's process to the Office host application's process.

font

Returns a ShapeFont object that represents the font attributes for the text range. Read-only.

[ API set: ExcelApi 1.9 ]

text

Represents the plain text content of the text range.

[ API set: ExcelApi 1.9 ]

Methods

getSubstring(start, length)

Returns a TextRange object for the substring in the given range.

[ API set: ExcelApi 1.9 ]

load(options)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(propertyNames)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(propertyNamesAndPaths)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

set(properties, options)

Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.

set(properties)

Sets multiple properties on the object at the same time, based on an existing loaded object.

toJSON()

Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Excel.TextRange object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.TextRangeData) that contains shallow copies of any loaded child properties from the original object.

Property Details

context

The request context associated with the object. This connects the add-in's process to the Office host application's process.

context: RequestContext;

Property Value

font

Returns a ShapeFont object that represents the font attributes for the text range. Read-only.

[ API set: ExcelApi 1.9 ]

readonly font: Excel.ShapeFont;

Property Value

text

Represents the plain text content of the text range.

[ API set: ExcelApi 1.9 ]

text: string;

Property Value

string

Method Details

getSubstring(start, length)

Returns a TextRange object for the substring in the given range.

[ API set: ExcelApi 1.9 ]

getSubstring(start: number, length?: number): Excel.TextRange;

Parameters

start
number

The zero-based index of the first character to get from the text range.

length
number

Optional. The number of characters to be returned in the new text range. If length is omitted, all the characters from start to the end of the text range's last paragraph will be returned.

Returns

load(options)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(options?: Excel.Interfaces.TextRangeLoadOptions): Excel.TextRange;

Parameters

options
Excel.Interfaces.TextRangeLoadOptions

Provides options for which properties of the object to load.

Returns

load(propertyNames)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(propertyNames?: string | string[]): Excel.TextRange;

Parameters

propertyNames
string | string[]

A comma-delimited string or an array of strings that specify the properties to load.

Returns

load(propertyNamesAndPaths)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.TextRange;

Parameters

propertyNamesAndPaths
{ select?: string; expand?: string; }

propertyNamesAndPaths.select is a comma-delimited string that specifies the properties to load, and propertyNamesAndPaths.expand is a comma-delimited string that specifies the navigation properties to load.

Returns

set(properties, options)

Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.

set(properties: Interfaces.TextRangeUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parameters

properties
Interfaces.TextRangeUpdateData

A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.

options
OfficeExtension.UpdateOptions

Provides an option to suppress errors if the properties object tries to set any read-only properties.

Returns

void

Remarks

This method has the following additional signature:

set(properties: Excel.TextRange): void

set(properties)

Sets multiple properties on the object at the same time, based on an existing loaded object.

set(properties: Excel.TextRange): void;

Parameters

properties
Excel.TextRange

Returns

void

toJSON()

Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Excel.TextRange object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.TextRangeData) that contains shallow copies of any loaded child properties from the original object.

toJSON(): Excel.Interfaces.TextRangeData;

Returns