Word.Hyperlink class

Пакет:
word

Представляет гиперссылку в документе Word.

Extends
OfficeExtension.ClientObject

Комментарии

Набор API: WordApiDesktop 1.3

Используется

Свойства

address

Указывает адрес (например, имя файла или URL-адрес) гиперссылки.
context

Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office.
emailSubject

Определяет текстовую строку для строки темы гиперссылки.
isExtraInfoRequired

Возвращает true , если для разрешения гиперссылки требуются дополнительные сведения.
name

Возвращает имя Hyperlink объекта.
range

Возвращает объект, Range представляющий часть документа, содержащуюся в гиперссылке.
screenTip

Текст, отображаемый в качестве подсказки при наведении указателя мыши на гиперссылку.
subAddress

Указывает именованное расположение в месте назначения гиперссылки.
target

Указывает имя фрейма или окна, в которое загружается гиперссылка.
textToDisplay

Определяет видимый текст гиперссылки в документе.
type

Возвращает тип гиперссылки.

Методы

addToFavorites()

Создает ярлык для документа или гиперссылки и добавляет ее в папку "Избранное ".
createNewDocument(fileName, editNow, overwrite)

Создает документ, связанный с гиперссылкой.
delete()

Удаляет гиперссылку.
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.Hyperlink объект является объектом API, toJSON метод возвращает простой объект JavaScript (типизированный как Word.Interfaces.HyperlinkData), который содержит неглубокие копии любых загруженных дочерних свойств исходного объекта.
track()

Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением от context.trackedObjects.add(thisObject). Если вы используете этот объект во всех .sync вызовах и вне последовательного выполнения пакета ".run" и получаете сообщение об ошибке "InvalidObjectPath" при установке свойства или вызове метода объекта, необходимо добавить объект в коллекцию отслеживаемых объектов при его первом создании. Если этот объект является частью семейства, следует также отслеживать родительскую коллекцию.
untrack()

Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращением от context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вам нужно позвонить context.sync() , прежде чем освобождение памяти вступит в силу.

Сведения о свойстве

Указывает адрес (например, имя файла или URL-адрес) гиперссылки.

address: string;

Значение свойства

string

Комментарии

Набор API: WordApiDesktop 1.3

Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office.

context: RequestContext;

Значение свойства

Word.RequestContext

Определяет текстовую строку для строки темы гиперссылки.

emailSubject: string;

Значение свойства

string

Комментарии

Набор API: WordApiDesktop 1.3

Возвращает true , если для разрешения гиперссылки требуются дополнительные сведения.

readonly isExtraInfoRequired: boolean;

Значение свойства

boolean

Комментарии

Набор API: WordApiDesktop 1.3

Возвращает имя Hyperlink объекта.

readonly name: string;

Значение свойства

string

Комментарии

Набор API: WordApiDesktop 1.3

Возвращает объект, Range представляющий часть документа, содержащуюся в гиперссылке.

readonly range: Word.Range;

Значение свойства

Word.Range

Комментарии

Набор API: WordApiDesktop 1.3

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

screenTip: string;

Значение свойства

string

Комментарии

Набор API: WordApiDesktop 1.3

Указывает именованное расположение в месте назначения гиперссылки.

subAddress: string;

Значение свойства

string

Комментарии

Набор API: WordApiDesktop 1.3

Указывает имя фрейма или окна, в которое загружается гиперссылка.

target: string;

Значение свойства

string

Комментарии

Набор API: WordApiDesktop 1.3

Определяет видимый текст гиперссылки в документе.

textToDisplay: string;

Значение свойства

string

Комментарии

Набор API: WordApiDesktop 1.3

Возвращает тип гиперссылки.

readonly type: Word.HyperlinkType | "Range" | "Shape" | "InlineShape";

Значение свойства

Word.HyperlinkType | "Range" | "Shape" | "InlineShape"

Комментарии

Набор API: WordApiDesktop 1.3

Сведения о методе

Создает ярлык для документа или гиперссылки и добавляет ее в папку "Избранное ".

addToFavorites(): void;

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

void

Комментарии

Набор API: WordApiDesktop 1.3

Создает документ, связанный с гиперссылкой.

createNewDocument(fileName: string, editNow: boolean, overwrite: boolean): void;

Параметры

fileName

string

Имя файла

editNow

boolean

true чтобы начать редактирование прямо сейчас.

overwrite

boolean

true , чтобы перезаписать файл с таким же именем.

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

void

Комментарии

Набор API: WordApiDesktop 1.3

Удаляет гиперссылку.

delete(): void;

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

void

Комментарии

Набор API: WordApiDesktop 1.3

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(options?: Word.Interfaces.HyperlinkLoadOptions): Word.Hyperlink;

Параметры

options
Word.Interfaces.HyperlinkLoadOptions

Предоставляет параметры для загружаемых свойств объекта.

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

Word.Hyperlink

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

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

Параметры

propertyNames

string | string[]

Строка с разделителями-запятыми или массив строк, которые определяют свойства для загрузки.

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

Word.Hyperlink

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

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

Параметры

propertyNamesAndPaths

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

propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и строка propertyNamesAndPaths.expand через запятую, указывающая свойства навигации для загрузки.

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

Word.Hyperlink

Задает несколько свойств объекта одновременно. Вы можете передать либо простой объект с соответствующими свойствами, либо другой объект API того же типа.

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

Параметры

properties
Word.Interfaces.HyperlinkUpdateData

Объект JavaScript со свойствами, структурированными изоморфно свойствам объекта, для которого вызывается метод.

options
OfficeExtension.UpdateOptions

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

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

void

Одновременно задает несколько свойств объекта на основе существующего загруженного объекта.

set(properties: Word.Hyperlink): void;

Параметры

properties
Word.Hyperlink

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

void

Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringify, в свою очередь, вызывает toJSON метод переданного ему объекта.) В то время как исходный Word.Hyperlink объект является объектом API, toJSON метод возвращает простой объект JavaScript (типизированный как Word.Interfaces.HyperlinkData), который содержит неглубокие копии любых загруженных дочерних свойств исходного объекта.

toJSON(): Word.Interfaces.HyperlinkData;

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

Word.Interfaces.HyperlinkData

Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением от context.trackedObjects.add(thisObject). Если вы используете этот объект во всех .sync вызовах и вне последовательного выполнения пакета ".run" и получаете сообщение об ошибке "InvalidObjectPath" при установке свойства или вызове метода объекта, необходимо добавить объект в коллекцию отслеживаемых объектов при его первом создании. Если этот объект является частью семейства, следует также отслеживать родительскую коллекцию.

track(): Word.Hyperlink;

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

Word.Hyperlink

Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращением от context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вам нужно позвонить context.sync() , прежде чем освобождение памяти вступит в силу.

untrack(): Word.Hyperlink;

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

Word.Hyperlink