Word.Frame class
Stellt einen Frame dar. Das Frame Objekt ist ein Member von Word. FrameCollection-Objekt.
- Extends
Hinweise
Verwendet von
Eigenschaften
| borders | Gibt ein |
| context | Der dem Objekt zugeordnete Anforderungskontext. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden. |
| height | Gibt die Höhe (in Punkt) des Rahmens an. |
| height |
Gibt einen |
| horizontal |
Gibt den horizontalen Abstand zwischen dem Rahmen und dem umgebenden Text in Punkten an. |
| horizontal |
Gibt den horizontalen Abstand zwischen dem Rand des Rahmens und dem durch die |
| lock |
Gibt an, ob der Rahmen gesperrt ist. |
| range | Gibt ein |
| relative |
Gibt die relative horizontale Position des Rahmens an. |
| relative |
Gibt die relative vertikale Position des Rahmens an. |
| shading | Gibt ein |
| text |
Gibt an, ob Dokumenttext den Rahmen umfließt. |
| vertical |
Gibt den vertikalen Abstand (in Punkt) zwischen dem Rahmen und dem umgebenden Text an. |
| vertical |
Gibt den vertikalen Abstand zwischen dem Rand des Rahmens und dem durch die |
| width | Gibt die Breite (in Punkt) des Rahmens an. |
| width |
Gibt die Regel an, die zum Bestimmen der Breite des Rahmens verwendet wird. |
Methoden
| copy() | Kopiert den Rahmen in die Zwischenablage. |
| cut() | Entfernt den Rahmen aus dem Dokument und platziert ihn in der Zwischenablage. |
| delete() | Löscht den Rahmen. |
| 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 " |
| select() | Wählt den Rahmen aus. |
| 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
borders
Gibt ein BorderUniversalCollection Objekt zurück, das alle Rahmen des Rahmens darstellt.
readonly borders: Word.BorderUniversalCollection;Eigenschaftswert
Hinweise
context
Der dem Objekt zugeordnete Anforderungskontext. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.
context: RequestContext;Eigenschaftswert
height
Gibt die Höhe (in Punkt) des Rahmens an.
height: number;Eigenschaftswert
number
Hinweise
heightRule
Gibt einen FrameSizeRule Wert an, der die Regel zur Bestimmung der Rahmenhöhe darstellt.
heightRule: Word.FrameSizeRule | "Auto" | "AtLeast" | "Exact";Eigenschaftswert
Word.FrameSizeRule | "Auto" | "AtLeast" | "Exact"
Hinweise
horizontalDistanceFromText
Gibt den horizontalen Abstand zwischen dem Rahmen und dem umgebenden Text in Punkten an.
horizontalDistanceFromText: number;Eigenschaftswert
number
Hinweise
horizontalPosition
Gibt den horizontalen Abstand zwischen dem Rand des Rahmens und dem durch die relativeHorizontalPosition Eigenschaft angegebenen Element an.
horizontalPosition: number;Eigenschaftswert
number
Hinweise
lockAnchor
Gibt an, ob der Rahmen gesperrt ist.
lockAnchor: boolean;Eigenschaftswert
boolean
Hinweise
range
Gibt ein Range Objekt zurück, das den Teil des Dokuments darstellt, der im Rahmen enthalten ist.
readonly range: Word.Range;Eigenschaftswert
Hinweise
relativeHorizontalPosition
Gibt die relative horizontale Position des Rahmens an.
relativeHorizontalPosition: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin";Eigenschaftswert
Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin"
Hinweise
relativeVerticalPosition
Gibt die relative vertikale Position des Rahmens an.
relativeVerticalPosition: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin";Eigenschaftswert
Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"
Hinweise
shading
Gibt ein ShadingUniversal Objekt zurück, das auf die Schattierungsformatierung für den Rahmen verweist.
readonly shading: Word.ShadingUniversal;Eigenschaftswert
Hinweise
textWrap
Gibt an, ob Dokumenttext den Rahmen umfließt.
textWrap: boolean;Eigenschaftswert
boolean
Hinweise
verticalDistanceFromText
Gibt den vertikalen Abstand (in Punkt) zwischen dem Rahmen und dem umgebenden Text an.
verticalDistanceFromText: number;Eigenschaftswert
number
Hinweise
verticalPosition
Gibt den vertikalen Abstand zwischen dem Rand des Rahmens und dem durch die relativeVerticalPosition Eigenschaft angegebenen Element an.
verticalPosition: number;Eigenschaftswert
number
Hinweise
width
Gibt die Breite (in Punkt) des Rahmens an.
width: number;Eigenschaftswert
number
Hinweise
widthRule
Gibt die Regel an, die zum Bestimmen der Breite des Rahmens verwendet wird.
widthRule: Word.FrameSizeRule | "Auto" | "AtLeast" | "Exact";Eigenschaftswert
Word.FrameSizeRule | "Auto" | "AtLeast" | "Exact"
Hinweise
Details zur Methode
copy()
Kopiert den Rahmen in die Zwischenablage.
copy(): void;Gibt zurück
void
Hinweise
cut()
Entfernt den Rahmen aus dem Dokument und platziert ihn in der Zwischenablage.
cut(): void;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.FrameLoadOptions): Word.Frame;Parameter
- options
- Word.Interfaces.FrameLoadOptions
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.Frame;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.Frame;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
select()
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.FrameUpdateData, options?: OfficeExtension.UpdateOptions): void;Parameter
- properties
- Word.Interfaces.FrameUpdateData
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.Frame): void;Parameter
- properties
- Word.Frame
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.Frame Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (als Word.Interfaces.FrameData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften des ursprünglichen Objekts enthält.
toJSON(): Word.Interfaces.FrameData;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.Frame;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.Frame;