Visio.HyperlinkCollection class

Пакет:

visio

Представляет коллекцию Hyperlink.

Extends

OfficeExtension.ClientObject

Комментарии

[ Набор API: 1.1 ]

Свойства

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

Методы

getCount()	Возвращает количество гиперссылок.
getItem(Key)	Возвращает Hyperlink по ключу (имени или идентификатору).
load(options)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
setMockData(data)	Настройка макетных данных
toJSON()	Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный Visio.HyperlinkCollection объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Visio.Interfaces.HyperlinkCollectionData), содержащий массив "items" с мелкими копиями всех загруженных свойств из элементов коллекции.

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

context

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

context: RequestContext;

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

Visio.RequestContext

items

Получает загруженные дочерние элементы в этой коллекции.

readonly items: Visio.Hyperlink[];

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

Visio.Hyperlink[]

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

getCount()

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

getCount(): OfficeExtension.ClientResult<number>;

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

OfficeExtension.ClientResult<number>

Комментарии

[ Набор API: 1.1 ]

getItem(Key)

Возвращает Hyperlink по ключу (имени или идентификатору).

getItem(Key: number | string): Visio.Hyperlink;

Параметры

Key

number | string

Ключ — имя или индекс объекта Hyperlink, который нужно получить.

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

Visio.Hyperlink

Комментарии

[ Набор API: 1.1 ]

load(options)

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

load(options?: Visio.Interfaces.HyperlinkCollectionLoadOptions & Visio.Interfaces.CollectionLoadOptions): Visio.HyperlinkCollection;

Параметры

options

Visio.Interfaces.HyperlinkCollectionLoadOptions & Visio.Interfaces.CollectionLoadOptions

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

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

Visio.HyperlinkCollection

Примеры

Visio.run(session, function (ctx) {
    const activePage = ctx.document.getActivePage();
    const shapeName = "Manager Belt";
    const shape = activePage.shapes.getItem(shapeName);
    const shapeHyperlinks = shape.hyperlinks;
    shapeHyperlinks.load(["description", "address", "subAddress"]);
        ctx.sync().then(function () {
            for (let i = 0; i < shapeHyperlinks.items.length; i++) {
                const hyperlink = shapeHyperlinks.items[i];
                console.log(
                    "Description:"+hyperlink.description +"Address:"+hyperlink.address +"SubAddress:  " + 
                    hyperlink.subAddress);
            }
        });
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

load(propertyNames)

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

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

Параметры

propertyNames

string | string[]

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

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

Visio.HyperlinkCollection

load(propertyNamesAndPaths)

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

load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Visio.HyperlinkCollection;

Параметры

propertyNamesAndPaths

OfficeExtension.LoadOption

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

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

Visio.HyperlinkCollection

setMockData(data)

Настройка макетных данных

setMockData(data: Visio.Interfaces.HyperlinkCollectionData): void;

Параметры

data

Visio.Interfaces.HyperlinkCollectionData

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

void

toJSON()

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

toJSON(): Visio.Interfaces.HyperlinkCollectionData;

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

Visio.Interfaces.HyperlinkCollectionData