Word.CommentContentRange class

包:

word

Extends

OfficeExtension.ClientObject

注解

[ API 集：WordApi 1.4 ]

属性

bold	指定一个值，该值指示注释文本是否为粗体。
context	与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。
hyperlink	获取 range 内的第一个超链接，或在 range 内设置超链接。 在 range 内设置新的超链接将删除 range 内的所有超链接。
isEmpty	检查 range 长度是否为零。
italic	指定一个值，该值指示注释文本是否斜体。
strikeThrough	指定一个值，该值指示注释文本是否具有删除线。
text	获取注释范围的文本。
underline	指定一个值，该值指示注释文本的下划线类型。 如果批注文本没有下划线，则为“无”。

方法

insertText(text, insertLocation)	将文本插入到指定位置。 注意：对于新式批注，如果通过 UI 发布批注的任何修订，则跨上下文跟踪的内容范围将变为空。
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传递给它的 对象的 方法。) 而原始Word。CommentContentRange 对象是一个 API 对象，toJSON该方法返回一个纯 JavaScript 对象 (类型为 Word.Interfaces.CommentContentRangeData) ，其中包含原始对象中任何已加载子属性的浅表副本。
track()	根据文档中的相应更改来跟踪对象，以便进行自动调整。 此调用是 context.trackedObjects.add (thisObject) 的简写。 如果跨 .sync 调用和“.run”批处理的顺序执行外部使用此对象，并在设置属性或调用对象方法时收到“InvalidObjectPath”错误，则需要在首次创建对象时将该对象添加到跟踪的对象集合。 如果此对象是集合的一部分，则还应跟踪父集合。
untrack()	释放与此对象关联的内存（如果先前已跟踪过）。 此调用是 context.trackedObjects.remove (thisObject) 的简写。 拥有许多跟踪对象会降低主机应用程序的速度，因此请在使用完毕后释放所添加的任何对象。 在内存发布生效之前，需要调用 context.sync() 。

属性详细信息

bold

指定一个值，该值指示注释文本是否为粗体。

bold: boolean;

属性值

boolean

注解

[ API 集：WordApi 1.4 ]

context

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

context: RequestContext;

属性值

Word.RequestContext

hyperlink

获取 range 内的第一个超链接，或在 range 内设置超链接。 在 range 内设置新的超链接将删除 range 内的所有超链接。

hyperlink: string;

属性值

string

注解

[ API 集：WordApi 1.4 ]

isEmpty

检查 range 长度是否为零。

readonly isEmpty: boolean;

属性值

boolean

注解

[ API 集：WordApi 1.4 ]

italic

指定一个值，该值指示注释文本是否斜体。

italic: boolean;

属性值

boolean

注解

[ API 集：WordApi 1.4 ]

strikeThrough

指定一个值，该值指示注释文本是否具有删除线。

strikeThrough: boolean;

属性值

boolean

注解

[ API 集：WordApi 1.4 ]

text

获取注释范围的文本。

readonly text: string;

属性值

string

注解

[ API 集：WordApi 1.4 ]

underline

指定一个值，该值指示注释文本的下划线类型。 如果批注文本没有下划线，则为“无”。

underline: Word.UnderlineType | "Mixed" | "None" | "Hidden" | "DotLine" | "Single" | "Word" | "Double" | "Thick" | "Dotted" | "DottedHeavy" | "DashLine" | "DashLineHeavy" | "DashLineLong" | "DashLineLongHeavy" | "DotDashLine" | "DotDashLineHeavy" | "TwoDotDashLine" | "TwoDotDashLineHeavy" | "Wave" | "WaveHeavy" | "WaveDouble";

属性值

Word.UnderlineType | "Mixed" | "None" | "Hidden" | "DotLine" | "Single" | "Word" | "Double" | "Thick" | "Dotted" | "DottedHeavy" | "DashLine" | "DashLineHeavy" | "DashLineLong" | "DashLineLongHeavy" | "DotDashLine" | "DotDashLineHeavy" | "TwoDotDashLine" | "TwoDotDashLineHeavy" | "Wave" | "WaveHeavy" | "WaveDouble"

注解

[ API 集：WordApi 1.4 ]

方法详细信息

insertText(text, insertLocation)

将文本插入到指定位置。 注意：对于新式批注，如果通过 UI 发布批注的任何修订，则跨上下文跟踪的内容范围将变为空。

insertText(text: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.CommentContentRange;

参数

text

string

必需。 要插入到 CommentContentRange 中的文本。

insertLocation

Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"

必填。 该值必须为“Replace”、“Start”、“End”、“Before”或“After”。

返回

Word.CommentContentRange

注解

[ API 集：WordApi 1.4 ]

load(options)

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

load(options?: Word.Interfaces.CommentContentRangeLoadOptions): Word.CommentContentRange;

参数

options

Word.Interfaces.CommentContentRangeLoadOptions

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

返回

Word.CommentContentRange

load(propertyNames)

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

load(propertyNames?: string | string[]): Word.CommentContentRange;

参数

propertyNames

string | string[]

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

返回

Word.CommentContentRange

load(propertyNamesAndPaths)

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

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Word.CommentContentRange;

参数

propertyNamesAndPaths

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

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

返回

Word.CommentContentRange

set(properties, options)

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

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

参数

properties

Word.Interfaces.CommentContentRangeUpdateData

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

options

OfficeExtension.UpdateOptions

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

返回

void

set(properties)

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

set(properties: Word.CommentContentRange): void;

参数

properties

Word.CommentContentRange

返回

void

toJSON()

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

toJSON(): Word.Interfaces.CommentContentRangeData;

返回

Word.Interfaces.CommentContentRangeData

track()

根据文档中的相应更改来跟踪对象，以便进行自动调整。 此调用是 context.trackedObjects.add (thisObject) 的简写。 如果跨 .sync 调用和“.run”批处理的顺序执行外部使用此对象，并在设置属性或调用对象方法时收到“InvalidObjectPath”错误，则需要在首次创建对象时将该对象添加到跟踪的对象集合。 如果此对象是集合的一部分，则还应跟踪父集合。

track(): Word.CommentContentRange;

返回

Word.CommentContentRange

untrack()

释放与此对象关联的内存（如果先前已跟踪过）。 此调用是 context.trackedObjects.remove (thisObject) 的简写。 拥有许多跟踪对象会降低主机应用程序的速度，因此请在使用完毕后释放所添加的任何对象。 在内存发布生效之前，需要调用 context.sync() 。

untrack(): Word.CommentContentRange;

返回

Word.CommentContentRange