Word.Frame class

Gibt ein BorderUniversalCollection -Objekt zurück, das alle Rahmen für den Frame darstellt.

readonly borders: Word.BorderUniversalCollection;

Eigenschaftswert

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

Gibt die Höhe (in Punkt) des Frames an.

height: number;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Gibt einen FrameSizeRule Wert an, der die Regel zum Bestimmen der Höhe des Frames darstellt.

heightRule: Word.FrameSizeRule | "Auto" | "AtLeast" | "Exact";

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Gibt den horizontalen Abstand zwischen dem Rahmen und dem umgebenden Text in Punkt an.

horizontalDistanceFromText: number;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Gibt den horizontalen Abstand zwischen dem Rand des Rahmens und dem durch die relativeHorizontalPosition -Eigenschaft angegebenen Element an.

horizontalPosition: number;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Gibt an, ob der Frame gesperrt ist.

lockAnchor: boolean;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

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

readonly range: Word.Range;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Gibt die relative horizontale Position des Frames an.

relativeHorizontalPosition: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin";

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Gibt die relative vertikale Position des Frames an.

relativeVerticalPosition: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin";

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Gibt ein ShadingUniversal -Objekt zurück, das auf die Schattierungsformatierung für den Frame verweist.

readonly shading: Word.ShadingUniversal;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Gibt an, ob Dokumenttext um den Rahmen umbrochen wird.

textWrap: boolean;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Gibt den vertikalen Abstand (in Punkt) zwischen dem Frame und dem umgebenden Text an.

verticalDistanceFromText: number;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Gibt den vertikalen Abstand zwischen dem Rand des Rahmens und dem durch die relativeVerticalPosition -Eigenschaft angegebenen Element an.

verticalPosition: number;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Gibt die Breite (in Punkt) des Frames an.

width: number;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Gibt die Regel an, die verwendet wird, um die Breite des Frames zu bestimmen.

widthRule: Word.FrameSizeRule | "Auto" | "AtLeast" | "Exact";

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Kopiert den Frame in die Zwischenablage.

copy(): void;

Gibt zurück

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Entfernt den Rahmen aus dem Dokument und platziert ihn in der Zwischenablage.

cut(): void;

Gibt zurück

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Löscht den Frame.

delete(): void;

Gibt zurück

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.FrameLoadOptions): Word.Frame;

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

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

Parameter

Gibt zurück

Wählt den Frame aus.

select(): void;

Gibt zurück

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

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

toJSON(): Word.Interfaces.FrameData;

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

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

Gibt zurück