Visio.HyperlinkCollection class

The request context associated with the object. This connects the add-in's process to the Office host application's process.

context: RequestContext;

Property Value

Gets the loaded child items in this collection.

readonly items: Visio.Hyperlink[];

Property Value

Gets the number of hyperlinks.

getCount(): OfficeExtension.ClientResult<number>;

Returns

Remarks

[ API set: 1.1 ]

Gets a Hyperlink using its key (name or Id).

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

Parameters

Returns

Remarks

[ API set: 1.1 ]

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

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

Parameters

Returns

Examples

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));
    }
});

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

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

Parameters

Returns

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

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

Parameters

Returns

Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Visio.HyperlinkCollection object is an API object, the toJSON method returns a plain JavaScript object (typed as Visio.Interfaces.HyperlinkCollectionData) that contains an "items" array with shallow copies of any loaded properties from the collection's items.

toJSON(): Visio.Interfaces.HyperlinkCollectionData;

Returns