Compartilhar via

Word.Hyperlink class

Pacote:
word

Representa uma hiperligação num documento Word.

Extends
OfficeExtension.ClientObject

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Propriedades

address

Especifica o endereço (por exemplo, um nome de ficheiro ou URL) da hiperligação.
context

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

Especifica a cadeia de texto da linha de assunto da hiperligação.
isExtraInfoRequired

Devolve true se forem necessárias informações adicionais para resolve a hiperligação.
name

Devolve o nome do Hyperlink objeto.
range

Devolve um Range objeto que representa a parte do documento contida na hiperligação.
screenTip

Especifica o texto que aparece como uma Descrição quando o ponteiro do rato está posicionado sobre a hiperligação.
subAddress

Especifica uma localização com nome no destino da hiperligação.
target

Especifica o nome da moldura ou janela na qual carregar a hiperligação.
textToDisplay

Especifica o texto visível da hiperligação no documento.
type

Retorna o tipo de hiperlink.

Métodos

addToFavorites()

Cria um atalho para o documento ou hiperligação e adiciona-o à pasta Favoritos .
createNewDocument(fileName, editNow, overwrite)

Cria um novo documento ligado à hiperligação.
delete()

Elimina a hiperligação.
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.
set(properties, options)

Define várias propriedades de um objeto ao mesmo tempo. Pode transmitir um objeto simples com as propriedades adequadas ou outro objeto de API do mesmo tipo.
set(properties)

Define várias propriedades no objeto ao mesmo tempo, com base num objeto carregado existente.
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 original Word.Hyperlink é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Word.Interfaces.HyperlinkData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.
track()

Acompanha o objeto para ajuste automático com base nas alterações adjacentes no documento. Esta chamada é uma abreviatura de context.trackedObjects.add(thisObject). Se estiver a utilizar este objeto entre .sync chamadas e fora da execução sequencial de um lote ".run" e receber um erro "InvalidObjectPath" ao definir uma propriedade ou invocar um método no objeto, terá de adicionar o objeto à coleção de objetos controlados quando o objeto foi criado pela primeira vez. Se este objeto fizer parte de uma coleção, também deve controlar a coleção principal.
untrack()

Libere a memória associada a este objeto, se ele já tiver sido rastreado anteriormente. Esta chamada é abreviada para context.trackedObjects.remove(thisObject). Ter muitos objetos rastreados desacelera o aplicativo host, por isso, lembre-se de liberar todos os objetos adicionados após usá-los. Terá de chamar context.sync() antes de a libertação da memória ser aplicada.

Detalhes da propriedade

Especifica o endereço (por exemplo, um nome de ficheiro ou URL) da hiperligação.

address: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

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

Word.RequestContext

Especifica a cadeia de texto da linha de assunto da hiperligação.

emailSubject: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Devolve true se forem necessárias informações adicionais para resolve a hiperligação.

readonly isExtraInfoRequired: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Devolve o nome do Hyperlink objeto.

readonly name: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Devolve um Range objeto que representa a parte do documento contida na hiperligação.

readonly range: Word.Range;

Valor da propriedade

Word.Range

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Especifica o texto que aparece como uma Descrição quando o ponteiro do rato está posicionado sobre a hiperligação.

screenTip: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Especifica uma localização com nome no destino da hiperligação.

subAddress: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Especifica o nome da moldura ou janela na qual carregar a hiperligação.

target: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Especifica o texto visível da hiperligação no documento.

textToDisplay: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Retorna o tipo de hiperlink.

readonly type: Word.HyperlinkType | "Range" | "Shape" | "InlineShape";

Valor da propriedade

Word.HyperlinkType | "Range" | "Shape" | "InlineShape"

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Detalhes do método

Cria um atalho para o documento ou hiperligação e adiciona-o à pasta Favoritos .

addToFavorites(): void;

Retornos

void

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Cria um novo documento ligado à hiperligação.

createNewDocument(fileName: string, editNow: boolean, overwrite: boolean): void;

Parâmetros

fileName

string

O nome do arquivo.

editNow

boolean

true para começar a editar agora.

overwrite

boolean

true para substituir se existir outro ficheiro com o mesmo nome.

Retornos

void

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Elimina a hiperligação.

delete(): void;

Retornos

void

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

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

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

Parâmetros

options
Word.Interfaces.HyperlinkLoadOptions

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

Retornos

Word.Hyperlink

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[]): Word.Hyperlink;

Parâmetros

propertyNames

string | string[]

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

Retornos

Word.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;
        }): Word.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

Word.Hyperlink

Define várias propriedades de um objeto ao mesmo tempo. Pode transmitir um objeto simples com as propriedades adequadas ou outro objeto de API do mesmo tipo.

set(properties: Interfaces.HyperlinkUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parâmetros

properties
Word.Interfaces.HyperlinkUpdateData

Um objeto JavaScript com propriedades que são estruturadas isomorfoticamente para as propriedades do objeto no qual o método é chamado.

options
OfficeExtension.UpdateOptions

Fornece uma opção para suprimir erros se o objeto de propriedades tentar definir quaisquer propriedades só de leitura.

Retornos

void

Define várias propriedades no objeto ao mesmo tempo, com base num objeto carregado existente.

set(properties: Word.Hyperlink): void;

Parâmetros

properties
Word.Hyperlink

Retornos

void

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 original Word.Hyperlink é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Word.Interfaces.HyperlinkData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.

toJSON(): Word.Interfaces.HyperlinkData;

Retornos

Word.Interfaces.HyperlinkData

Acompanha o objeto para ajuste automático com base nas alterações adjacentes no documento. Esta chamada é uma abreviatura de context.trackedObjects.add(thisObject). Se estiver a utilizar este objeto entre .sync chamadas e fora da execução sequencial de um lote ".run" e receber um erro "InvalidObjectPath" ao definir uma propriedade ou invocar um método no objeto, terá de adicionar o objeto à coleção de objetos controlados quando o objeto foi criado pela primeira vez. Se este objeto fizer parte de uma coleção, também deve controlar a coleção principal.

track(): Word.Hyperlink;

Retornos

Word.Hyperlink

Libere a memória associada a este objeto, se ele já tiver sido rastreado anteriormente. Esta chamada é abreviada para context.trackedObjects.remove(thisObject). Ter muitos objetos rastreados desacelera o aplicativo host, por isso, lembre-se de liberar todos os objetos adicionados após usá-los. Terá de chamar context.sync() antes de a libertação da memória ser aplicada.

untrack(): Word.Hyperlink;

Retornos

Word.Hyperlink