Visio.Hyperlink class

Pacote:

visio

Representa o Hiperlink.

Extends

OfficeExtension.ClientObject

Comentários

[ Conjunto de API: 1.1 ]

Propriedades

address	Obtém o endereço do objeto Hiperlink.
context	O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office.
description	Obtém a descrição de um hiperlink.
extraInfo	Obtém as informações adicionais do pedido de URL utilizadas para resolve o URL da hiperligação.
subAddress	Obtém o sub-endereço do objeto Hiperlink.

Métodos

load(options)	Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
load(propertyNames)	Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
load(propertyNamesAndPaths)	Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
toJSON()	Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é transmitido para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que lhe é transmitido.) Enquanto o objeto Visio.Hyperlink original é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Visio.Interfaces.HyperlinkData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.

Detalhes da propriedade

address

Obtém o endereço do objeto Hiperlink.

readonly address: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: 1.1 ]

context

O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office.

context: RequestContext;

Valor da propriedade

Visio.RequestContext

description

Obtém a descrição de um hiperlink.

readonly description: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: 1.1 ]

extraInfo

Obtém as informações adicionais do pedido de URL utilizadas para resolve o URL da hiperligação.

readonly extraInfo: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: 1.1 ]

subAddress

Obtém o sub-endereço do objeto Hiperlink.

readonly subAddress: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: 1.1 ]

Detalhes do método

load(options)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

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

Parâmetros

options

Visio.Interfaces.HyperlinkLoadOptions

Fornece opções para as propriedades do objeto a carregar.

Retornos

Visio.Hyperlink

Exemplos

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)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

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

Parâmetros

propertyNames

string | string[]

Uma cadeia delimitada por vírgulas ou uma matriz de cadeias que especificam as propriedades a carregar.

Retornos

Visio.Hyperlink

load(propertyNamesAndPaths)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

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

Parâmetros

propertyNamesAndPaths

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

propertyNamesAndPaths.select é uma cadeia delimitada por vírgulas que especifica as propriedades a carregar e propertyNamesAndPaths.expand é uma cadeia delimitada por vírgulas que especifica as propriedades de navegação a carregar.

Retornos

Visio.Hyperlink

toJSON()

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é transmitido para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que lhe é transmitido.) Enquanto o objeto Visio.Hyperlink original é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Visio.Interfaces.HyperlinkData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.

toJSON(): Visio.Interfaces.HyperlinkData;

Retornos

Visio.Interfaces.HyperlinkData