通过

Word.Bookmark class

包:
word

代表文档、 选定内容或区域中的单个书签。 对象 Bookmark 是 集合的成员 Bookmark 。 Word。BookmarkCollection 包括“书签”对话框中列出的所有书签， (“插入”菜单) 。

扩展
OfficeExtension.ClientObject

注解

[ API 集：WordApiDesktop 1.4 ]

属性

context

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

指定书签的结束字符位置。
isColumn

true如果书签是表列，则返回 。
isEmpty

true如果书签为空，则返回 。
name

返回对象的名称 Bookmark 。
range

返回一个 Range 对象，该对象表示对象中包含的 Bookmark 文档部分。
start

指定书签的起始字符位置。
storyType

返回书签的故事类型。

方法

copyTo(name)

将此书签复制到参数中指定的新书签， name 并返回 对象 Bookmark 。
delete()

删除书签。
load(options)

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

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

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

选择书签。
set(properties, options)

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

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

重写 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 JSON.stringify (，依次调用toJSON传递给它的 对象的 方法。) 虽然原始Word.Bookmark对象是 API 对象，toJSON但该方法返回一个纯 JavaScript 对象， (类型为 Word.Interfaces.BookmarkData) ，其中包含从原始对象加载的任何子属性的浅表副本。
track()

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

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

属性详细信息

context

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

context: RequestContext;

属性值

Word.RequestContext

end

指定书签的结束字符位置。

end: number;

属性值

number

注解

[ API 集：WordApiDesktop 1.4 ]

isColumn

true如果书签是表列，则返回 。

readonly isColumn: boolean;

属性值

boolean

注解

[ API 集：WordApiDesktop 1.4 ]

isEmpty

true如果书签为空，则返回 。

readonly isEmpty: boolean;

属性值

boolean

注解

[ API 集：WordApiDesktop 1.4 ]

name

返回对象的名称 Bookmark 。

readonly name: string;

属性值

string

注解

[ API 集：WordApiDesktop 1.4 ]

range

返回一个 Range 对象，该对象表示对象中包含的 Bookmark 文档部分。

readonly range: Word.Range;

属性值

Word.Range

注解

[ API 集：WordApiDesktop 1.4 ]

start

指定书签的起始字符位置。

start: number;

属性值

number

注解

[ API 集：WordApiDesktop 1.4 ]

storyType

返回书签的故事类型。

readonly storyType: Word.StoryType | "MainText" | "Footnotes" | "Endnotes" | "Comments" | "TextFrame" | "EvenPagesHeader" | "PrimaryHeader" | "EvenPagesFooter" | "PrimaryFooter" | "FirstPageHeader" | "FirstPageFooter" | "FootnoteSeparator" | "FootnoteContinuationSeparator" | "FootnoteContinuationNotice" | "EndnoteSeparator" | "EndnoteContinuationSeparator" | "EndnoteContinuationNotice";

属性值

Word.StoryType | "MainText" | "Footnotes" | "Endnotes" | "Comments" | "TextFrame" | "EvenPagesHeader" | "PrimaryHeader" | "EvenPagesFooter" | "PrimaryFooter" | "FirstPageHeader" | "FirstPageFooter" | "FootnoteSeparator" | "FootnoteContinuationSeparator" | "FootnoteContinuationNotice" | "EndnoteSeparator" | "EndnoteContinuationSeparator" | "EndnoteContinuationNotice"

注解

[ API 集：WordApiDesktop 1.4 ]

方法详细信息

copyTo(name)

将此书签复制到参数中指定的新书签， name 并返回 对象 Bookmark 。

copyTo(name: string): Word.Bookmark;

参数

name

string

新书签的名称。

返回

Word.Bookmark

注解

[ API 集：WordApiDesktop 1.4 ]

delete()

删除书签。

delete(): void;

返回

void

注解

[ API 集：WordApiDesktop 1.4 ]

load(options)

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

load(options?: Word.Interfaces.BookmarkLoadOptions): Word.Bookmark;

参数

options
Word.Interfaces.BookmarkLoadOptions

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

返回

Word.Bookmark

load(propertyNames)

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

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

参数

propertyNames

string | string[]

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

返回

Word.Bookmark

load(propertyNamesAndPaths)

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

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

参数

propertyNamesAndPaths

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

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

返回

Word.Bookmark

select()

选择书签。

select(): void;

返回

void

注解

[ API 集：WordApiDesktop 1.4 ]

set(properties, options)

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

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

参数

properties
Word.Interfaces.BookmarkUpdateData

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

options
OfficeExtension.UpdateOptions

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

返回

void

set(properties)

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

set(properties: Word.Bookmark): void;

参数

properties
Word.Bookmark

返回

void

toJSON()

重写 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 JSON.stringify (，依次调用toJSON传递给它的 对象的 方法。) 虽然原始Word.Bookmark对象是 API 对象，toJSON但该方法返回一个纯 JavaScript 对象， (类型为 Word.Interfaces.BookmarkData) ，其中包含从原始对象加载的任何子属性的浅表副本。

toJSON(): Word.Interfaces.BookmarkData;

返回

Word.Interfaces.BookmarkData

track()

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

track(): Word.Bookmark;

返回

Word.Bookmark

untrack()

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

untrack(): Word.Bookmark;

返回

Word.Bookmark