Compartir a través de

Word.Hyperlink class

Paquete:
word

Representa un hipervínculo en un documento Word.

Extends
OfficeExtension.ClientObject

Comentarios

[ Conjunto de API: WordApiDesktop 1.3 ]

Propiedades

address

Especifica la dirección (por ejemplo, un nombre de archivo o una dirección URL) del hipervínculo.
context

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

Especifica la cadena de texto de la línea de asunto del hipervínculo.
isExtraInfoRequired

Devuelve true si se necesita información adicional para resolver el hipervínculo.
name

Devuelve el nombre del Hyperlink objeto.
range

Devuelve un Range objeto que representa la parte del documento contenida en el hipervínculo.
screenTip

Especifica el texto que aparece como información sobre pantalla cuando el puntero del mouse se coloca sobre el hipervínculo.
subAddress

Especifica una ubicación con nombre en el destino del hipervínculo.
target

Especifica el nombre del marco o ventana en el que se va a cargar el hipervínculo.
textToDisplay

Especifica el texto visible del hipervínculo en el documento.
type

Devuelve el tipo de hipervínculo.

Métodos

addToFavorites()

Crea un acceso directo al documento o hipervínculo y lo agrega a la carpeta Favoritos .
createNewDocument(fileName, editNow, overwrite)

Crea un nuevo documento vinculado al hipervínculo.
delete()

Elimina el hipervínculo.
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.
set(properties, options)

Establece varias propiedades de un objeto al mismo tiempo. Puede pasar un objeto sin formato con las propiedades adecuadas u otro objeto de API del mismo tipo.
set(properties)

Establece varias propiedades en el objeto al mismo tiempo, en función de un objeto cargado existente.
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 original Word.Hyperlink es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Word.Interfaces.HyperlinkData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.
track()

Realiza un seguimiento del objeto de ajuste automático según cambios adyacentes en el documento. Esta llamada es una abreviatura para context.trackedObjects.add(thisObject). Si usa este objeto entre .sync llamadas y fuera de la ejecución secuencial de un lote ".run" y obtiene un error "InvalidObjectPath" al establecer una propiedad o invocar un método en el objeto, debe agregar el objeto a la colección de objetos de seguimiento cuando se creó el objeto por primera vez. Si este objeto forma parte de una colección, también debe realizar un seguimiento de la colección primaria.
untrack()

Libere la memoria asociada a este objeto, si se ha realizado un seguimiento de él anteriormente. Esta llamada es abreviada para context.trackedObjects.remove(thisObject). Tener muchos objetos marcados ralentiza la aplicación host, así que debe recordar liberar los objetos que agregue cuando haya terminado con ellos. Tendrá que llamar context.sync() a antes de que la versión de memoria surta efecto.

Detalles de las propiedades

Especifica la dirección (por ejemplo, un nombre de archivo o una dirección URL) del hipervínculo.

address: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: WordApiDesktop 1.3 ]

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

Word.RequestContext

Especifica la cadena de texto de la línea de asunto del hipervínculo.

emailSubject: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: WordApiDesktop 1.3 ]

Devuelve true si se necesita información adicional para resolver el hipervínculo.

readonly isExtraInfoRequired: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: WordApiDesktop 1.3 ]

Devuelve el nombre del Hyperlink objeto.

readonly name: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: WordApiDesktop 1.3 ]

Devuelve un Range objeto que representa la parte del documento contenida en el hipervínculo.

readonly range: Word.Range;

Valor de propiedad

Word.Range

Comentarios

[ Conjunto de API: WordApiDesktop 1.3 ]

Especifica el texto que aparece como información sobre pantalla cuando el puntero del mouse se coloca sobre el hipervínculo.

screenTip: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: WordApiDesktop 1.3 ]

Especifica una ubicación con nombre en el destino del hipervínculo.

subAddress: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: WordApiDesktop 1.3 ]

Especifica el nombre del marco o ventana en el que se va a cargar el hipervínculo.

target: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: WordApiDesktop 1.3 ]

Especifica el texto visible del hipervínculo en el documento.

textToDisplay: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: WordApiDesktop 1.3 ]

Devuelve el tipo de hipervínculo.

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

Valor de propiedad

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

Comentarios

[ Conjunto de API: WordApiDesktop 1.3 ]

Detalles del método

Crea un acceso directo al documento o hipervínculo y lo agrega a la carpeta Favoritos .

addToFavorites(): void;

Devoluciones

void

Comentarios

[ Conjunto de API: WordApiDesktop 1.3 ]

Crea un nuevo documento vinculado al hipervínculo.

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

Parámetros

fileName

string

Nombre del archivo.

editNow

boolean

true para empezar a editar ahora.

overwrite

boolean

true para sobrescribir si hay otro archivo con el mismo nombre.

Devoluciones

void

Comentarios

[ Conjunto de API: WordApiDesktop 1.3 ]

Elimina el hipervínculo.

delete(): void;

Devoluciones

void

Comentarios

[ Conjunto de API: WordApiDesktop 1.3 ]

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

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

Parámetros

options
Word.Interfaces.HyperlinkLoadOptions

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

Devoluciones

Word.Hyperlink

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

Word.Hyperlink

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

Word.Hyperlink

Establece varias propiedades de un objeto al mismo tiempo. Puede pasar un objeto sin formato con las propiedades adecuadas u otro objeto de API del mismo tipo.

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

Parámetros

properties
Word.Interfaces.HyperlinkUpdateData

Objeto JavaScript con propiedades estructuradas isomórficamente con las propiedades del objeto al que se llama al método.

options
OfficeExtension.UpdateOptions

Proporciona una opción para suprimir errores si el objeto properties intenta establecer propiedades de solo lectura.

Devoluciones

void

Establece varias propiedades en el objeto al mismo tiempo, en función de un objeto cargado existente.

set(properties: Word.Hyperlink): void;

Parámetros

properties
Word.Hyperlink

Devoluciones

void

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 original Word.Hyperlink es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Word.Interfaces.HyperlinkData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.

toJSON(): Word.Interfaces.HyperlinkData;

Devoluciones

Word.Interfaces.HyperlinkData

Realiza un seguimiento del objeto de ajuste automático según cambios adyacentes en el documento. Esta llamada es una abreviatura para context.trackedObjects.add(thisObject). Si usa este objeto entre .sync llamadas y fuera de la ejecución secuencial de un lote ".run" y obtiene un error "InvalidObjectPath" al establecer una propiedad o invocar un método en el objeto, debe agregar el objeto a la colección de objetos de seguimiento cuando se creó el objeto por primera vez. Si este objeto forma parte de una colección, también debe realizar un seguimiento de la colección primaria.

track(): Word.Hyperlink;

Devoluciones

Word.Hyperlink

Libere la memoria asociada a este objeto, si se ha realizado un seguimiento de él anteriormente. Esta llamada es abreviada para context.trackedObjects.remove(thisObject). Tener muchos objetos marcados ralentiza la aplicación host, así que debe recordar liberar los objetos que agregue cuando haya terminado con ellos. Tendrá que llamar context.sync() a antes de que la versión de memoria surta efecto.

untrack(): Word.Hyperlink;

Devoluciones

Word.Hyperlink