Compartilhar via

Visio.Hyperlink class

  • Referência
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 de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.
description

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

Obtém as informações extras de solicitação de URL usadas para resolve URL do hiperlink.
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.
setMockData(data)

Definir dados simulados
toJSON()

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

Detalhes da propriedade

Obtém o endereço do objeto Hiperlink.

readonly address: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: 1.1 ]

O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.

context: RequestContext;

Valor da propriedade

Visio.RequestContext

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

readonly description: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: 1.1 ]

Obtém as informações extras de solicitação de URL usadas para resolve URL do hiperlink.

readonly extraInfo: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: 1.1 ]

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

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 quais propriedades do objeto 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));
    }
});

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 de caracteres delimitada por vírgulas ou uma matriz de cadeias de caracteres que especificam as propriedades a serem carregadas.

Retornos

Visio.Hyperlink

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 de caracteres delimitada por vírgulas que especifica as propriedades a serem carregadas e propertyNamesAndPaths.expand é uma cadeia de caracteres delimitada por vírgulas que especifica as propriedades de navegação a serem carregadas.

Retornos

Visio.Hyperlink

Definir dados simulados

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

Parâmetros

data
Visio.Interfaces.HyperlinkData

Retornos

void

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

toJSON(): Visio.Interfaces.HyperlinkData;

Retornos

Visio.Interfaces.HyperlinkData