Excel.TextRange class

包:

excel

包含附加到形状上的文本，以及用于操作文本的属性和方法。

扩展

OfficeExtension.ClientObject

注解

[ API 集：ExcelApi 1.9 ]

属性

context	与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。
font	返回一个 ShapeFont 对象，该对象代表文本区域的字体属性。
text	表示文本范围的纯文本内容。

方法

getSubstring(start, length)	返回给定区域内子字符串的 TextRange 对象。
load(options)	将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames)	将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths)	将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
set(properties, options)	同时设置对象的多个属性。 可以传递具有相应属性的纯对象，也可以传递同一类型的另一个 API 对象。
set(properties)	基于现有的已加载对象，同时对对象设置多个属性。
toJSON()	重写 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 JSON.stringify (，反过来又调用toJSON传递给它的 对象的 方法。) 而原始Excel.TextRange对象是 API 对象，toJSON该方法返回一个纯 JavaScript 对象， (类型为 Excel.Interfaces.TextRangeData) ，其中包含原始对象中任何已加载子属性的浅表副本。

属性详细信息

context

与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。

context: RequestContext;

属性值

Excel.RequestContext

font

返回一个 ShapeFont 对象，该对象代表文本区域的字体属性。

readonly font: Excel.ShapeFont;

属性值

Excel.ShapeFont

注解

[ API 集：ExcelApi 1.9 ]

text

表示文本范围的纯文本内容。

text: string;

属性值

string

注解

[ API 集：ExcelApi 1.9 ]

方法详细信息

getSubstring(start, length)

返回给定区域内子字符串的 TextRange 对象。

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

参数

start

number

要从文本范围获取的第一个字符的从零开始的索引。

length

number

可选。 在新文本区域中要返回的字符数。 如果省略 length，则将返回从文本范围最后一段的开头到末尾的所有字符。

返回

Excel.TextRange

注解

[ API 集：ExcelApi 1.9 ]

load(options)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

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

参数

options

Excel.Interfaces.TextRangeLoadOptions

提供要加载对象的属性的选项。

返回

Excel.TextRange

load(propertyNames)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

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

参数

propertyNames

string | string[]

逗号分隔的字符串或指定要加载的属性的字符串数组。

返回

Excel.TextRange

load(propertyNamesAndPaths)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

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

参数

propertyNamesAndPaths

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

propertyNamesAndPaths.select 是一个逗号分隔的字符串，指定要加载的属性，是 propertyNamesAndPaths.expand 一个逗号分隔的字符串，指定要加载的导航属性。

返回

Excel.TextRange

set(properties, options)

同时设置对象的多个属性。 可以传递具有相应属性的纯对象，也可以传递同一类型的另一个 API 对象。

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

参数

properties

Excel.Interfaces.TextRangeUpdateData

一个 JavaScript 对象，其属性按同构方式构造为调用方法的对象的属性。

options

OfficeExtension.UpdateOptions

提供一个选项，用于在 properties 对象尝试设置任何只读属性时禁止显示错误。

返回

void

set(properties)

基于现有的已加载对象，同时对对象设置多个属性。

set(properties: Excel.TextRange): void;

参数

properties

Excel.TextRange

返回

void

toJSON()

重写 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 JSON.stringify (，反过来又调用toJSON传递给它的 对象的 方法。) 而原始Excel.TextRange对象是 API 对象，toJSON该方法返回一个纯 JavaScript 对象， (类型为 Excel.Interfaces.TextRangeData) ，其中包含原始对象中任何已加载子属性的浅表副本。

toJSON(): Excel.Interfaces.TextRangeData;

返回

Excel.Interfaces.TextRangeData