Visio.Hyperlink class

Пакет:
visio

Представляет Hyperlink.

Extends
OfficeExtension.ClientObject

Комментарии

Набор API: 1.1

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

Свойства

address

Возвращает адрес объекта Hyperlink.
context

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

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

Получает дополнительные сведения о запросе URL-адреса, используемые для разрешения URL-адреса гиперссылки.
subAddress

Возвращает субадрес объекта Hyperlink.

Методы

load(options)

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

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

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

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

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

Возвращает адрес объекта Hyperlink.

readonly address: string;

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

string

Комментарии

Набор API: 1.1

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

context: RequestContext;

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

Visio.RequestContext

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

readonly description: string;

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

string

Комментарии

Набор API: 1.1

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

readonly extraInfo: string;

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

string

Комментарии

Набор API: 1.1

Возвращает субадрес объекта Hyperlink.

readonly subAddress: string;

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

string

Комментарии

Набор API: 1.1

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

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

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

Параметры

options
Visio.Interfaces.HyperlinkLoadOptions

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

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

Visio.Hyperlink

Примеры

Visio.run(session, function (ctx) {
    const activePage = ctx.document.getActivePage();
    const shape = activePage.shapes.getItem(0);
    const hyperlink = shape.hyperlinks.getItem(0);
    hyperlink.load();
    return ctx.sync().then(function() {
        console.log(hyperlink.description);
        console.log(hyperlink.address);
        console.log(hyperlink.subAddress);
        console.log(hyperlink.extraInfo);
     });
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

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

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

Параметры

propertyNames

string | string[]

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

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

Visio.Hyperlink

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

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

Параметры

propertyNamesAndPaths

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

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

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

Visio.Hyperlink

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

toJSON(): Visio.Interfaces.HyperlinkData;

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

Visio.Interfaces.HyperlinkData