Freigeben über

Word.Hyperlink class

Paket:
word

Stellt einen Link in einem Word Dokument dar.

Extends
OfficeExtension.ClientObject

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Eigenschaften

address

Gibt die Adresse (z. B. einen Dateinamen oder eine URL) des Links an.
context

Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.
emailSubject

Gibt die Textzeichenfolge für die Betreffzeile des Links an.
isExtraInfoRequired

Gibt zurück true , wenn zusätzliche Informationen zum Auflösen des Links erforderlich sind.
name

Gibt den Namen des Hyperlink Objekts zurück.
range

Gibt ein Range -Objekt zurück, das den Teil des Dokuments darstellt, der im Link enthalten ist.
screenTip

Gibt den Text an, der als QuickInfo angezeigt wird, wenn der Mauszeiger über dem Link positioniert wird.
subAddress

Gibt einen benannten Speicherort im Ziel des Links an.
target

Gibt den Namen des Frames oder Fensters an, in den der Link geladen werden soll.
textToDisplay

Gibt den sichtbaren Text des Links im Dokument an.
type

Gibt den Typ des Hyperlinks zurück.

Methoden

addToFavorites()

Erstellt eine Verknüpfung zum Dokument oder Link und fügt sie dem Ordner Favoriten hinzu.
createNewDocument(fileName, editNow, overwrite)

Erstellt ein neues Dokument, das mit dem Link verknüpft ist.
delete()

Löscht den Link.
load(options)

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.
load(propertyNames)

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.
load(propertyNamesAndPaths)

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.
set(properties, options)

Legt mehrere Eigenschaften eines Objekts gleichzeitig fest. Sie können entweder ein einfaches Objekt mit den entsprechenden Eigenschaften oder ein anderes API-Objekt desselben Typs übergeben.
set(properties)

Legt mehrere Eigenschaften für das -Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt.
toJSON()

Überschreibt die JavaScript-Methode toJSON() , um eine nützlichere Ausgabe bereitzustellen, wenn ein API-Objekt an JSON.stringify()übergeben wird. (JSON.stringifyruft wiederum die toJSON -Methode des Objekts auf, das an das Objekt übergeben wird.) Während das ursprüngliche Word.Hyperlink Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Word.Interfaces.HyperlinkData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.
track()

Nachverfolgung des Objekts zwecks automatischer Anpassung auf der Grundlage der umgebenden Änderungen im Dokument. Dieser Aufruf ist eine Kurzform für context.trackedObjects.add(thisObject). Wenn Sie dieses Objekt über .sync Aufrufe hinweg und außerhalb der sequenziellen Ausführung eines ".run"-Batches verwenden und beim Festlegen einer Eigenschaft oder beim Aufrufen einer Methode für das Objekt den Fehler "InvalidObjectPath" erhalten, müssen Sie das Objekt der nachverfolgten Objektauflistung hinzufügen, als das Objekt zum ersten Mal erstellt wurde. Wenn dieses Objekt Teil einer Auflistung ist, sollten Sie auch die übergeordnete Auflistung nachverfolgen.
untrack()

Gibt den diesem Objekt zugewiesenen Arbeitsspeicher frei, wenn das Objekt zuvor nachverfolgt wurde. Dieser Aufruf ist die Kurzform für context.trackedObjects.remove(thisObject). Viele nachverfolgte Objekte verlangsamen die Ausführung der Hostanwendung, also achten Sie darauf, alle hinzugefügten Objekte nach abgeschlossener Verwendung freizugeben. Sie müssen aufrufen context.sync() , bevor die Speicherfreigabe wirksam wird.

Details zur Eigenschaft

Gibt die Adresse (z. B. einen Dateinamen oder eine URL) des Links an.

address: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.

context: RequestContext;

Eigenschaftswert

Word.RequestContext

Gibt die Textzeichenfolge für die Betreffzeile des Links an.

emailSubject: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Gibt zurück true , wenn zusätzliche Informationen zum Auflösen des Links erforderlich sind.

readonly isExtraInfoRequired: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Gibt den Namen des Hyperlink Objekts zurück.

readonly name: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Gibt ein Range -Objekt zurück, das den Teil des Dokuments darstellt, der im Link enthalten ist.

readonly range: Word.Range;

Eigenschaftswert

Word.Range

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Gibt den Text an, der als QuickInfo angezeigt wird, wenn der Mauszeiger über dem Link positioniert wird.

screenTip: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Gibt einen benannten Speicherort im Ziel des Links an.

subAddress: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Gibt den Namen des Frames oder Fensters an, in den der Link geladen werden soll.

target: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Gibt den sichtbaren Text des Links im Dokument an.

textToDisplay: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Gibt den Typ des Hyperlinks zurück.

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

Eigenschaftswert

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

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Details zur Methode

Erstellt eine Verknüpfung zum Dokument oder Link und fügt sie dem Ordner Favoriten hinzu.

addToFavorites(): void;

Gibt zurück

void

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Erstellt ein neues Dokument, das mit dem Link verknüpft ist.

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

Parameter

fileName

string

Der Name der Datei.

editNow

boolean

true , um jetzt mit der Bearbeitung zu beginnen.

overwrite

boolean

true , um zu überschreiben, wenn eine andere Datei mit demselben Namen vorhanden ist.

Gibt zurück

void

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Löscht den Link.

delete(): void;

Gibt zurück

void

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

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

Parameter

options
Word.Interfaces.HyperlinkLoadOptions

Stellt Optionen dafür bereit, welche Eigenschaften des -Objekts geladen werden sollen.

Gibt zurück

Word.Hyperlink

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

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

Parameter

propertyNames

string | string[]

Eine durch Trennzeichen getrennte Zeichenfolge oder ein Array von Zeichenfolgen, die die zu ladenden Eigenschaften angeben.

Gibt zurück

Word.Hyperlink

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

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

Parameter

propertyNamesAndPaths

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

propertyNamesAndPaths.select ist eine durch Trennzeichen getrennte Zeichenfolge, die die zu ladenden Eigenschaften angibt, und propertyNamesAndPaths.expand eine durch Trennzeichen getrennte Zeichenfolge, die die zu ladenden Navigationseigenschaften angibt.

Gibt zurück

Word.Hyperlink

Legt mehrere Eigenschaften eines Objekts gleichzeitig fest. Sie können entweder ein einfaches Objekt mit den entsprechenden Eigenschaften oder ein anderes API-Objekt desselben Typs übergeben.

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

Parameter

properties
Word.Interfaces.HyperlinkUpdateData

Ein JavaScript-Objekt mit Eigenschaften, die isomorph zu den Eigenschaften des Objekts strukturiert sind, für das die Methode aufgerufen wird.

options
OfficeExtension.UpdateOptions

Stellt eine Option zum Unterdrücken von Fehlern bereit, wenn das Eigenschaftenobjekt versucht, schreibgeschützte Eigenschaften festzulegen.

Gibt zurück

void

Legt mehrere Eigenschaften für das -Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt.

set(properties: Word.Hyperlink): void;

Parameter

properties
Word.Hyperlink

Gibt zurück

void

Überschreibt die JavaScript-Methode toJSON() , um eine nützlichere Ausgabe bereitzustellen, wenn ein API-Objekt an JSON.stringify()übergeben wird. (JSON.stringifyruft wiederum die toJSON -Methode des Objekts auf, das an das Objekt übergeben wird.) Während das ursprüngliche Word.Hyperlink Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Word.Interfaces.HyperlinkData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.

toJSON(): Word.Interfaces.HyperlinkData;

Gibt zurück

Word.Interfaces.HyperlinkData

Nachverfolgung des Objekts zwecks automatischer Anpassung auf der Grundlage der umgebenden Änderungen im Dokument. Dieser Aufruf ist eine Kurzform für context.trackedObjects.add(thisObject). Wenn Sie dieses Objekt über .sync Aufrufe hinweg und außerhalb der sequenziellen Ausführung eines ".run"-Batches verwenden und beim Festlegen einer Eigenschaft oder beim Aufrufen einer Methode für das Objekt den Fehler "InvalidObjectPath" erhalten, müssen Sie das Objekt der nachverfolgten Objektauflistung hinzufügen, als das Objekt zum ersten Mal erstellt wurde. Wenn dieses Objekt Teil einer Auflistung ist, sollten Sie auch die übergeordnete Auflistung nachverfolgen.

track(): Word.Hyperlink;

Gibt zurück

Word.Hyperlink

Gibt den diesem Objekt zugewiesenen Arbeitsspeicher frei, wenn das Objekt zuvor nachverfolgt wurde. Dieser Aufruf ist die Kurzform für context.trackedObjects.remove(thisObject). Viele nachverfolgte Objekte verlangsamen die Ausführung der Hostanwendung, also achten Sie darauf, alle hinzugefügten Objekte nach abgeschlossener Verwendung freizugeben. Sie müssen aufrufen context.sync() , bevor die Speicherfreigabe wirksam wird.

untrack(): Word.Hyperlink;

Gibt zurück

Word.Hyperlink