Visio.Hyperlink class

Paquet:

visio

Représente l’objet Hyperlink.

Extends

OfficeExtension.ClientObject

Remarques

[ Ensemble d’API : 1.1 ]

Propriétés

address	Obtient l’adresse de l’objet Hyperlink.
context	Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.
description	Obtient la description d’un lien hypertexte.
extraInfo	Obtient les informations de demande d’URL supplémentaires utilisées pour résoudre l’URL du lien hypertexte.
subAddress	Obtient la sous-adresse de l’objet Hyperlink.

Méthodes

load(options)	Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.
load(propertyNames)	Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.
load(propertyNamesAndPaths)	Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.
setMockData(data)	Définir des données fictives
toJSON()	Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringifyappelle à son tour la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet Visio.Hyperlink d’origine est un objet API, la toJSON méthode renvoie un objet JavaScript brut (tapé en tant Visio.Interfaces.HyperlinkDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.

Détails de la propriété

address

Obtient l’adresse de l’objet Hyperlink.

readonly address: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : 1.1 ]

context

Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.

context: RequestContext;

Valeur de propriété

Visio.RequestContext

description

Obtient la description d’un lien hypertexte.

readonly description: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : 1.1 ]

extraInfo

Obtient les informations de demande d’URL supplémentaires utilisées pour résoudre l’URL du lien hypertexte.

readonly extraInfo: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : 1.1 ]

subAddress

Obtient la sous-adresse de l’objet Hyperlink.

readonly subAddress: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : 1.1 ]

Détails de la méthode

load(options)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

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

Paramètres

options

Visio.Interfaces.HyperlinkLoadOptions

Fournit des options pour les propriétés de l’objet à charger.

Retours

Visio.Hyperlink

Exemples

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

load(propertyNames)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

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

Paramètres

propertyNames

string | string[]

Chaîne délimitée par des virgules ou tableau de chaînes qui spécifient les propriétés à charger.

Retours

Visio.Hyperlink

load(propertyNamesAndPaths)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

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

Paramètres

propertyNamesAndPaths

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

propertyNamesAndPaths.select est une chaîne délimitée par des virgules qui spécifie les propriétés à charger, et propertyNamesAndPaths.expand est une chaîne délimitée par des virgules qui spécifie les propriétés de navigation à charger.

Retours

Visio.Hyperlink

setMockData(data)

Définir des données fictives

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

Paramètres

data

Visio.Interfaces.HyperlinkData

Retours

void

toJSON()

Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringifyappelle à son tour la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet Visio.Hyperlink d’origine est un objet API, la toJSON méthode renvoie un objet JavaScript brut (tapé en tant Visio.Interfaces.HyperlinkDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.

toJSON(): Visio.Interfaces.HyperlinkData;

Retours

Visio.Interfaces.HyperlinkData