Visio.Hyperlink class

Paquete:

visio

Representa el hipervínculo.

Extends

OfficeExtension.ClientObject

Comentarios

[ Conjunto de API: 1.1 ]

Propiedades

address	Obtiene la dirección del objeto de hipervínculo.
context	Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.
description	Obtiene la descripción de un hipervínculo.
extraInfo	Obtiene la información de solicitud de dirección URL adicional que se usa para resolver la dirección URL del hipervínculo.
subAddress	Obtiene la subdirección del objeto de hipervínculo.

Métodos

load(options)	Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
load(propertyNames)	Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
load(propertyNamesAndPaths)	Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
toJSON()	Invalida el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto de API a JSON.stringify(). (JSON.stringifya su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto Visio.Hyperlink original es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Visio.Interfaces.HyperlinkData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.

Detalles de las propiedades

address

Obtiene la dirección del objeto de hipervínculo.

readonly address: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: 1.1 ]

context

Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.

context: RequestContext;

Valor de propiedad

Visio.RequestContext

description

Obtiene la descripción de un hipervínculo.

readonly description: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: 1.1 ]

extraInfo

Obtiene la información de solicitud de dirección URL adicional que se usa para resolver la dirección URL del hipervínculo.

readonly extraInfo: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: 1.1 ]

subAddress

Obtiene la subdirección del objeto de hipervínculo.

readonly subAddress: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: 1.1 ]

Detalles del método

load(options)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

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

Parámetros

options

Visio.Interfaces.HyperlinkLoadOptions

Proporciona opciones para las propiedades del objeto que se van a cargar.

Devoluciones

Visio.Hyperlink

Ejemplos

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)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

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

Parámetros

propertyNames

string | string[]

Una cadena delimitada por comas o una matriz de cadenas que especifican las propiedades que se van a cargar.

Devoluciones

Visio.Hyperlink

load(propertyNamesAndPaths)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

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

Parámetros

propertyNamesAndPaths

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

propertyNamesAndPaths.select es una cadena delimitada por comas que especifica las propiedades que se van a cargar y propertyNamesAndPaths.expand es una cadena delimitada por comas que especifica las propiedades de navegación que se van a cargar.

Devoluciones

Visio.Hyperlink

toJSON()

Invalida el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto de API a JSON.stringify(). (JSON.stringifya su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto Visio.Hyperlink original es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Visio.Interfaces.HyperlinkData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.

toJSON(): Visio.Interfaces.HyperlinkData;

Devoluciones

Visio.Interfaces.HyperlinkData