Word.Bookmark class

Пакет:

word

Представляет одну закладку в документе, выделении или диапазоне. Объект Bookmark является членом Bookmark коллекции. Word. BookmarkCollection содержит все закладки, перечисленные в диалоговом окне Закладка (меню Вставка).

Extends

OfficeExtension.ClientObject

Комментарии

[ Набор API: WordApiDesktop 1.4 ]

Свойства

context	Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
end	Указывает конечное положение символа закладки.
isColumn	Возвращает значение true , если закладка является столбцом таблицы.
isEmpty	Возвращает значение true , если закладка пуста.
name	Возвращает имя Bookmark объекта .
range	Range Возвращает объект , представляющий часть документа, которая содержится в объекте Bookmark .
start	Указывает начальную позицию символа закладки.
storyType	Возвращает тип истории для закладки.

Методы

copyTo(name)	Копирует эту закладку в новую закладку, указанную в аргументе nameBookmark , и возвращает объект .
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)

Копирует эту закладку в новую закладку, указанную в аргументе nameBookmark , и возвращает объект .

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

Предоставляет возможность подавления ошибок, если объект свойств пытается задать какие-либо свойства, доступные только для чтения.

Возвращаемое значение

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