Partager via

Word.Hyperlink class

Paquet:
word

Représente un lien hypertexte dans un document Word.

Extends
OfficeExtension.ClientObject

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Propriétés

address

Spécifie l’adresse (par exemple, un nom de fichier ou une URL) du lien hypertexte.
context

Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.
emailSubject

Spécifie la chaîne de texte pour la ligne d’objet du lien hypertexte.
isExtraInfoRequired

Retourne true si des informations supplémentaires sont nécessaires pour résoudre le lien hypertexte.
name

Retourne le nom de l’objet Hyperlink .
range

Renvoie un Range objet qui représente la partie du document contenue dans le lien hypertexte.
screenTip

Spécifie le texte qui apparaît sous forme d’info-bulle lorsque le pointeur de la souris est positionné sur le lien hypertexte.
subAddress

Spécifie un emplacement nommé dans la destination du lien hypertexte.
target

Spécifie le nom du cadre ou de la fenêtre dans lequel charger le lien hypertexte.
textToDisplay

Spécifie le texte visible du lien hypertexte dans le document.
type

Renvoie le type de lien hypertexte.

Méthodes

addToFavorites()

Crée un raccourci vers le document ou le lien hypertexte et l’ajoute au dossier Favoris .
createNewDocument(fileName, editNow, overwrite)

Crée un document lié au lien hypertexte.
delete()

Supprime le lien hypertexte.
load(options)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.
load(propertyNames)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.
load(propertyNamesAndPaths)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.
set(properties, options)

Définit plusieurs propriétés d’un objet en même temps. Vous pouvez passer un objet brut avec les propriétés appropriées ou un autre objet API du même type.
set(properties)

Définit plusieurs propriétés sur l’objet en même temps, en fonction d’un objet chargé existant.
toJSON()

Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringify, à son tour, appelle la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine Word.Hyperlink est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Word.Interfaces.HyperlinkDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.
track()

Effectuer le suivi de l’objet pour l’ajustement automatique en fonction environnant des modifications dans le document. Cet appel est un raccourci pour context.trackedObjects.add(thisObject). Si vous utilisez cet objet sur des .sync appels et en dehors de l’exécution séquentielle d’un lot « .run », et que vous obtenez une erreur « InvalidObjectPath » lors de la définition d’une propriété ou de l’appel d’une méthode sur l’objet, vous devez ajouter l’objet à la collection d’objets suivie lors de la première création de l’objet. Si cet objet fait partie d’une collection, vous devez également suivre la collection parente.
untrack()

Publication mémoire associée à cet objet si elle a été précédemment suivie. Cet appel est abrégé pour context.trackedObjects.remove(thisObject). Vous rencontrez de nombreux objets suivies ralentit l’application hôte, donc n’oubliez pas de libérer les objets que l'on ajoute, une fois que vous avez terminé à les utiliser. Vous devez appeler context.sync() avant que la mise en production de la mémoire ne prenne effet.

Détails de la propriété

Spécifie l’adresse (par exemple, un nom de fichier ou une URL) du lien hypertexte.

address: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.

context: RequestContext;

Valeur de propriété

Word.RequestContext

Spécifie la chaîne de texte pour la ligne d’objet du lien hypertexte.

emailSubject: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Retourne true si des informations supplémentaires sont nécessaires pour résoudre le lien hypertexte.

readonly isExtraInfoRequired: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Retourne le nom de l’objet Hyperlink .

readonly name: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Renvoie un Range objet qui représente la partie du document contenue dans le lien hypertexte.

readonly range: Word.Range;

Valeur de propriété

Word.Range

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Spécifie le texte qui apparaît sous forme d’info-bulle lorsque le pointeur de la souris est positionné sur le lien hypertexte.

screenTip: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Spécifie un emplacement nommé dans la destination du lien hypertexte.

subAddress: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Spécifie le nom du cadre ou de la fenêtre dans lequel charger le lien hypertexte.

target: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Spécifie le texte visible du lien hypertexte dans le document.

textToDisplay: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Renvoie le type de lien hypertexte.

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

Valeur de propriété

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

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Détails de la méthode

Crée un raccourci vers le document ou le lien hypertexte et l’ajoute au dossier Favoris .

addToFavorites(): void;

Retours

void

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Crée un document lié au lien hypertexte.

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

Paramètres

fileName

string

Nom du fichier.

editNow

boolean

true pour commencer à modifier maintenant.

overwrite

boolean

true pour remplacer s’il existe un autre fichier portant le même nom.

Retours

void

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Supprime le lien hypertexte.

delete(): void;

Retours

void

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

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

Paramètres

options
Word.Interfaces.HyperlinkLoadOptions

Fournit des options pour les propriétés de l’objet à charger.

Retours

Word.Hyperlink

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

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

Paramètres

propertyNames

string | string[]

Chaîne délimitée par des virgules ou tableau de chaînes qui spécifient les propriétés à charger.

Retours

Word.Hyperlink

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

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

Paramètres

propertyNamesAndPaths

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

propertyNamesAndPaths.select est une chaîne délimitée par des virgules qui spécifie les propriétés à charger, et propertyNamesAndPaths.expand est une chaîne délimitée par des virgules qui spécifie les propriétés de navigation à charger.

Retours

Word.Hyperlink

Définit plusieurs propriétés d’un objet en même temps. Vous pouvez passer un objet brut avec les propriétés appropriées ou un autre objet API du même type.

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

Paramètres

properties
Word.Interfaces.HyperlinkUpdateData

Objet JavaScript avec des propriétés qui sont structurées isomorphes en fonction des propriétés de l’objet sur lequel la méthode est appelée.

options
OfficeExtension.UpdateOptions

Fournit une option permettant de supprimer les erreurs si l’objet properties tente de définir des propriétés en lecture seule.

Retours

void

Définit plusieurs propriétés sur l’objet en même temps, en fonction d’un objet chargé existant.

set(properties: Word.Hyperlink): void;

Paramètres

properties
Word.Hyperlink

Retours

void

Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringify, à son tour, appelle la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine Word.Hyperlink est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Word.Interfaces.HyperlinkDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.

toJSON(): Word.Interfaces.HyperlinkData;

Retours

Word.Interfaces.HyperlinkData

Effectuer le suivi de l’objet pour l’ajustement automatique en fonction environnant des modifications dans le document. Cet appel est un raccourci pour context.trackedObjects.add(thisObject). Si vous utilisez cet objet sur des .sync appels et en dehors de l’exécution séquentielle d’un lot « .run », et que vous obtenez une erreur « InvalidObjectPath » lors de la définition d’une propriété ou de l’appel d’une méthode sur l’objet, vous devez ajouter l’objet à la collection d’objets suivie lors de la première création de l’objet. Si cet objet fait partie d’une collection, vous devez également suivre la collection parente.

track(): Word.Hyperlink;

Retours

Word.Hyperlink

Publication mémoire associée à cet objet si elle a été précédemment suivie. Cet appel est abrégé pour context.trackedObjects.remove(thisObject). Vous rencontrez de nombreux objets suivies ralentit l’application hôte, donc n’oubliez pas de libérer les objets que l'on ajoute, une fois que vous avez terminé à les utiliser. Vous devez appeler context.sync() avant que la mise en production de la mémoire ne prenne effet.

untrack(): Word.Hyperlink;

Retours

Word.Hyperlink