Word.OleFormat class

Gibt den Klassentyp für das angegebene OLE-Objekt, -Bild oder -Feld an.

classType: string;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.4 ]

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 das Symbol an, das verwendet wird, wenn die displayAsIcon -Eigenschaft ist true.

iconIndex: number;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.4 ]

Gibt den Text an, der unter dem Symbol für das OLE-Objekt angezeigt wird.

iconLabel: string;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.4 ]

Gibt die Programmdatei an, in der das Symbol für das OLE-Objekt gespeichert ist.

iconName: string;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.4 ]

Ruft den Pfad der Datei ab, in der das Symbol für das OLE-Objekt gespeichert ist.

readonly iconPath: string;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.4 ]

Ruft ab, ob das angegebene Objekt als Symbol angezeigt wird.

readonly isDisplayedAsIcon: boolean;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.4 ]

Gibt an, ob die Formatierung, die in Microsoft Word für das verknüpfte OLE-Objekt erfolgt, beibehalten wird.

isFormattingPreservedOnUpdate: boolean;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.4 ]

Ruft eine Zeichenfolge ab, die verwendet wird, um den Teil der Quelldatei zu identifizieren, der verknüpft wird.

readonly label: string;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.4 ]

Ruft den programmgesteuerten Bezeichner (ProgId) für das angegebene OLE-Objekt ab.

readonly progId: string;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.4 ]

Aktiviert das OleFormat -Objekt.

activate(): void;

Gibt zurück

Hinweise

[ API-Satz: WordApiDesktop 1.4 ]

Legt den Windows-Registrierungswert fest, der die Standardanwendung zum Aktivieren des angegebenen OLE-Objekts bestimmt.

activateAs(classType: string): void;

Parameter

Gibt zurück

Hinweise

[ API-Satz: WordApiDesktop 1.4 ]

Fordert an, dass das OLE-Objekt eines seiner verfügbaren Verben ausführt.

doVerb(verbIndex: Word.OleVerb): void;

Parameter

Gibt zurück

Hinweise

[ API-Satz: WordApiDesktop 1.4 ]

Fordert an, dass das OLE-Objekt eines seiner verfügbaren Verben ausführt.

doVerb(verbIndex: "Primary" | "Show" | "Open" | "Hide" | "UiActivate" | "InPlaceActivate" | "DiscardUndoState"): void;

Parameter

Gibt zurück

Hinweise

[ API-Satz: WordApiDesktop 1.4 ]

Öffnet das OLE-Objekt zur Bearbeitung in der Anwendung, in der es erstellt wurde.

edit(): 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.OleFormatLoadOptions): Word.OleFormat;

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

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

Parameter

Gibt zurück

Öffnet das OleFormat -Objekt.

open(): void;

Gibt zurück

Hinweise

[ API-Satz: WordApiDesktop 1.4 ]

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

toJSON(): Word.Interfaces.OleFormatData;

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

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

Gibt zurück