Word.LinkFormat class

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

context: RequestContext;

Eigenschaftswert

Gibt an, ob der Link automatisch aktualisiert wird, wenn die Containerdatei geöffnet oder die Quelldatei geändert wird.

isAutoUpdated: boolean;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.4 ]

Gibt an, ob ein Field-, InlineShape- oder Shape -Objekt gesperrt ist, um automatische Aktualisierungen zu verhindern.

isLocked: boolean;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.4 ]

Gibt an, ob das verknüpfte Bild mit dem Dokument gespeichert wird.

isPictureSavedWithDocument: boolean;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.4 ]

Gibt den Pfad und namen der Quelldatei für das verknüpfte OLE-Objekt, -Bild oder -Feld an.

sourceFullName: string;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.4 ]

Ruft den Namen der Quelldatei für das verknüpfte OLE-Objekt, -Bild oder -Feld ab.

readonly sourceName: string;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.4 ]

Ruft den Pfad der Quelldatei für das verknüpfte OLE-Objekt, -Bild oder -Feld ab.

readonly sourcePath: string;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.4 ]

Ruft den Linktyp ab.

readonly type: Word.LinkType | "Ole" | "Picture" | "Text" | "Reference" | "Include" | "Import" | "Dde" | "DdeAuto" | "Chart";

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.4 ]

Unterbricht die Verknüpfung zwischen der Quelldatei und dem OLE-Objekt, bild oder verknüpften Feld.

breakLink(): void;

Gibt zurück

Hinweise

[ API-Satz: WordApiDesktop 1.4 ]

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

Parameter

Gibt zurück

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.LinkFormat;

Parameter

Gibt zurück

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.LinkFormat;

Parameter

Gibt zurück

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.LinkFormatUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parameter

Gibt zurück

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

set(properties: Word.LinkFormat): void;

Parameter

Gibt zurück

Ü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.LinkFormat Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Word.Interfaces.LinkFormatData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.

toJSON(): Word.Interfaces.LinkFormatData;

Gibt zurück

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.LinkFormat;

Gibt zurück

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.LinkFormat;

Gibt zurück