Поделиться через

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

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

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

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