Word.Hyperlink class
Stellt einen Link in einem Word-Dokument dar.
- Extends
Eigenschaften
| address | Gibt die Adresse (z. B. einen Dateinamen oder eine URL) des Links an. |
| context | Der dem Objekt zugeordnete Anforderungskontext. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden. |
| email |
Gibt die Textzeichenfolge für die Betreffzeile des Links an. |
| is |
Gibt zurück |
| name | Gibt den Namen des Objekts |
| range | Gibt ein |
| screen |
Gibt den Text an, der als QuickInfo angezeigt wird, wenn der Mauszeiger über dem Link positioniert wird. |
| sub |
Gibt einen benannten Speicherort am Ziel des Links an. |
| target | Gibt den Namen des Frames oder Fensters an, in dem der Hyperlink geladen werden soll. |
| text |
Gibt den sichtbaren Text des Links im Dokument an. |
| type | Gibt den Typ des Hyperlinks zurück. |
Methoden
| add |
Erstellt eine Verknüpfung zu dem Dokument oder Hyperlink und fügt sie dem Ordner "Favoriten" hinzu. |
| create |
Erstellt ein neues Dokument, das mit dem Link verknüpft ist. |
| delete() | Löscht den Hyperlink. |
| load(options) | Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| load(property |
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| load(property |
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| 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 |
| 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 aufrufübergreifend |
| 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 einen Aufruf durchführen |
Details zur Eigenschaft
address
Gibt die Adresse (z. B. einen Dateinamen oder eine URL) des Links an.
address: string;Eigenschaftswert
string
Hinweise
context
Der dem Objekt zugeordnete Anforderungskontext. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.
context: RequestContext;Eigenschaftswert
emailSubject
Gibt die Textzeichenfolge für die Betreffzeile des Links an.
emailSubject: string;Eigenschaftswert
string
Hinweise
isExtraInfoRequired
Gibt zurück true , wenn zusätzliche Informationen zum Auflösen des Links erforderlich sind.
readonly isExtraInfoRequired: boolean;Eigenschaftswert
boolean
Hinweise
name
Gibt den Namen des Objekts Hyperlink zurück.
readonly name: string;Eigenschaftswert
string
Hinweise
range
Gibt ein Range Objekt zurück, das den Teil des Dokuments darstellt, der im Hyperlink enthalten ist.
readonly range: Word.Range;Eigenschaftswert
Hinweise
screenTip
Gibt den Text an, der als QuickInfo angezeigt wird, wenn der Mauszeiger über dem Link positioniert wird.
screenTip: string;Eigenschaftswert
string
Hinweise
subAddress
Gibt einen benannten Speicherort am Ziel des Links an.
subAddress: string;Eigenschaftswert
string
Hinweise
target
Gibt den Namen des Frames oder Fensters an, in dem der Hyperlink geladen werden soll.
target: string;Eigenschaftswert
string
Hinweise
textToDisplay
Gibt den sichtbaren Text des Links im Dokument an.
textToDisplay: string;Eigenschaftswert
string
Hinweise
type
Gibt den Typ des Hyperlinks zurück.
readonly type: Word.HyperlinkType | "Range" | "Shape" | "InlineShape";Eigenschaftswert
Word.HyperlinkType | "Range" | "Shape" | "InlineShape"
Hinweise
Details zur Methode
addToFavorites()
Erstellt eine Verknüpfung zu dem Dokument oder Hyperlink und fügt sie dem Ordner "Favoriten" hinzu.
addToFavorites(): void;Gibt zurück
void
Hinweise
createNewDocument(fileName, editNow, overwrite)
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 zum Überschreiben, wenn es eine andere Datei mit demselben Namen gibt.
Gibt zurück
void
Hinweise
delete()
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(options?: Word.Interfaces.HyperlinkLoadOptions): Word.Hyperlink;Parameter
Stellt Optionen für die zu ladenden Eigenschaften des Objekts bereit.
Gibt zurück
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(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
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.
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Word.Hyperlink;Parameter
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select ist eine durch Kommas getrennte Zeichenfolge, die die zu ladenden Eigenschaften angibt, und propertyNamesAndPaths.expand eine durch Kommas getrennte Zeichenfolge, die die zu ladenden Navigationseigenschaften angibt.
Gibt zurück
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: 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
Bietet eine Option zum Unterdrücken von Fehlern, wenn das properties-Objekt versucht, schreibgeschützte Eigenschaften festzulegen.
Gibt zurück
void
set(properties)
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
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 sie übergeben wird.) Während das ursprüngliche Word.Hyperlink Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (als Word.Interfaces.HyperlinkData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften des ursprünglichen Objekts enthält.
toJSON(): Word.Interfaces.HyperlinkData;Gibt zurück
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 aufrufübergreifend .sync 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 ein "InvalidObjectPath"-Fehler angezeigt wird, müssen Sie das Objekt der nachverfolgten Objektsammlung hinzufügen, wenn das Objekt zum ersten Mal erstellt wurde. Wenn dieses Objekt Teil einer Sammlung ist, sollten Sie auch die übergeordnete Sammlung nachverfolgen.
track(): Word.Hyperlink;Gibt zurück
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 einen Aufruf durchführen context.sync() , bevor die Speicherfreigabe wirksam wird.
untrack(): Word.Hyperlink;