Word.ThreeDimensionalFormat class

Gibt die Tiefe der unteren Abgeschrägung an.

bevelBottomDepth: number;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Gibt die Einsetgröße für die untere Abgeschrägung an.

bevelBottomInset: number;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Gibt einen BevelType Wert an, der den Abgeschrägungstyp für die untere Abgeschrägung darstellt.

bevelBottomType: Word.BevelType | "mixed" | "none" | "relaxedInset" | "circle" | "slope" | "cross" | "angle" | "softRound" | "convex" | "coolSlant" | "divot" | "riblet" | "hardEdge" | "artDeco";

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Gibt die Tiefe der oberen Abgeschrägung an.

bevelTopDepth: number;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Gibt die Einsetgröße für die obere Abgeschrägung an.

bevelTopInset: number;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Gibt einen BevelType Wert an, der den Abgeschrägungstyp für die obere Abgeschrägung darstellt.

bevelTopType: Word.BevelType | "mixed" | "none" | "relaxedInset" | "circle" | "slope" | "cross" | "angle" | "softRound" | "convex" | "coolSlant" | "divot" | "riblet" | "hardEdge" | "artDeco";

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 ein ColorFormat -Objekt zurück, das die Farbe der Kontur einer Form darstellt.

readonly contourColor: Word.ColorFormat;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Gibt die Breite der Kontur einer Form an.

contourWidth: number;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Gibt die Tiefe der Extrusion der Form an.

depth: number;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Gibt ein ColorFormat -Objekt zurück, das die Farbe der Extrusion der Form darstellt.

readonly extrusionColor: Word.ColorFormat;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Gibt an, ob die Farbe der Extrusion auf der Füllung der Form (der Vorderseite der Extrusion) basiert, und ändert automatisch, wenn die Füllung des Shapes geändert wird, oder ob die Farbe der Extrusion von der Füllung der Form unabhängig ist.

extrusionColorType: Word.ExtrusionColorType | "mixed" | "automatic" | "custom";

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Gibt die Größe der Perspektive für ein Shape an.

fieldOfView: number;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Gibt an true , ob die Extrusion perspektivisch angezeigt wird, d. h. wenn sich die Wände der Extrusion zu einem Fluchtpunkt verengen, false wenn die Extrusion eine parallele oder orthografische Projektion ist, d. h., wenn sich die Wände nicht zu einem Fluchtpunkt verengen.

isPerspective: boolean;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Gibt an, ob das angegebene Objekt oder die darauf angewendete Formatierung sichtbar ist.

isVisible: boolean;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Gibt den Winkel der Beleuchtung an.

lightAngle: number;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Gibt einen PresetCamera Wert zurück, der die Kameravoreinstellungen darstellt.

readonly presetCamera: Word.PresetCamera | "Mixed" | "LegacyObliqueTopLeft" | "LegacyObliqueTop" | "LegacyObliqueTopRight" | "LegacyObliqueLeft" | "LegacyObliqueFront" | "LegacyObliqueRight" | "LegacyObliqueBottomLeft" | "LegacyObliqueBottom" | "LegacyObliqueBottomRight" | "LegacyPerspectiveTopLeft" | "LegacyPerspectiveTop" | "LegacyPerspectiveTopRight" | "LegacyPerspectiveLeft" | "LegacyPerspectiveFront" | "LegacyPerspectiveRight" | "LegacyPerspectiveBottomLeft" | "LegacyPerspectiveBottom" | "LegacyPerspectiveBottomRight" | "OrthographicFront" | "IsometricTopUp" | "IsometricTopDown" | "IsometricBottomUp" | "IsometricBottomDown" | "IsometricLeftUp" | "IsometricLeftDown" | "IsometricRightUp" | "IsometricRightDown" | "IsometricOffAxis1Left" | "IsometricOffAxis1Right" | "IsometricOffAxis1Top" | "IsometricOffAxis2Left" | "IsometricOffAxis2Right" | "IsometricOffAxis2Top" | "IsometricOffAxis3Left" | "IsometricOffAxis3Right" | "IsometricOffAxis3Bottom" | "IsometricOffAxis4Left" | "IsometricOffAxis4Right" | "IsometricOffAxis4Bottom" | "ObliqueTopLeft" | "ObliqueTop" | "ObliqueTopRight" | "ObliqueLeft" | "ObliqueRight" | "ObliqueBottomLeft" | "ObliqueBottom" | "ObliqueBottomRight" | "PerspectiveFront" | "PerspectiveLeft" | "PerspectiveRight" | "PerspectiveAbove" | "PerspectiveBelow" | "PerspectiveAboveLeftFacing" | "PerspectiveAboveRightFacing" | "PerspectiveContrastingLeftFacing" | "PerspectiveContrastingRightFacing" | "PerspectiveHeroicLeftFacing" | "PerspectiveHeroicRightFacing" | "PerspectiveHeroicExtremeLeftFacing" | "PerspectiveHeroicExtremeRightFacing" | "PerspectiveRelaxed" | "PerspectiveRelaxedModerately";

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Gibt die Richtung zurück, in die die Extrusion von der extrudierten Form weggeführt werden soll (von der Vorderansicht der Extrusion aus gesehen).

readonly presetExtrusionDirection: Word.PresetExtrusionDirection | "Mixed" | "BottomRight" | "Bottom" | "BottomLeft" | "Right" | "None" | "Left" | "TopRight" | "Top" | "TopLeft";

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Gibt einen LightRigType Wert an, der die Beleuchtungsvoreinstellung darstellt.

presetLighting: Word.LightRigType | "Mixed" | "LegacyFlat1" | "LegacyFlat2" | "LegacyFlat3" | "LegacyFlat4" | "LegacyNormal1" | "LegacyNormal2" | "LegacyNormal3" | "LegacyNormal4" | "LegacyHarsh1" | "LegacyHarsh2" | "LegacyHarsh3" | "LegacyHarsh4" | "ThreePoint" | "Balanced" | "Soft" | "Harsh" | "Flood" | "Contrasting" | "Morning" | "Sunrise" | "Sunset" | "Chilly" | "Freezing" | "Flat" | "TwoPoint" | "Glow" | "BrightRoom";

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Gibt die Position der Lichtquelle relativ zur Extrusion an.

presetLightingDirection: Word.PresetLightingDirection | "Mixed" | "TopLeft" | "Top" | "TopRight" | "Left" | "None" | "Right" | "BottomLeft" | "Bottom" | "BottomRight";

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Gibt die Intensität der Extrusionsbeleuchtung an.

presetLightingSoftness: Word.PresetLightingSoftness | "Mixed" | "Dim" | "Normal" | "Bright";

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Gibt das Oberflächenmaterial an.

presetMaterial: Word.PresetMaterial | "Mixed" | "Matte" | "Plastic" | "Metal" | "WireFrame" | "Matte2" | "Plastic2" | "Metal2" | "WarmMatte" | "TranslucentPowder" | "Powder" | "DarkEdge" | "SoftEdge" | "Clear" | "Flat" | "SoftMetal";

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Gibt das vordefinierte Extrusionsformat zurück.

readonly presetThreeDimensionalFormat: Word.PresetThreeDimensionalFormat | "Mixed" | "Format1" | "Format2" | "Format3" | "Format4" | "Format5" | "Format6" | "Format7" | "Format8" | "Format9" | "Format10" | "Format11" | "Format12" | "Format13" | "Format14" | "Format15" | "Format16" | "Format17" | "Format18" | "Format19" | "Format20";

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Gibt an, ob Text auf einer Form mit einer Form gedreht wird. true dreht den Text.

projectText: boolean;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Gibt die Drehung der extrudierten Form um die X-Achse in Grad an.

rotationX: number;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Gibt die Drehung der extrudierten Form um die y-Achse in Grad an.

rotationY: number;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Gibt die Drehung der Z-Achse der Kamera an.

rotationZ: number;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Gibt die Position auf der Z-Achse für das Shape an.

z: number;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Dreht eine Form horizontal auf der X-Achse. Die Anzahl der Grad, die gedreht werden sollen.

incrementRotationHorizontal(increment: number): void;

Parameter

Gibt zurück

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Dreht eine Form vertikal auf der Y-Achse. Die Anzahl der Grad, die gedreht werden sollen.

incrementRotationVertical(increment: number): void;

Parameter

Gibt zurück

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Ändert die Drehung um die X-Achse. Die Anzahl der Grad, die gedreht werden sollen.

incrementRotationX(increment: number): void;

Parameter

Gibt zurück

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Ändert die Drehung um die Y-Achse. Die Anzahl der Grad, die gedreht werden sollen.

incrementRotationY(increment: number): void;

Parameter

Gibt zurück

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Dreht eine Form auf der Z-Achse. Die Anzahl der Grad, die gedreht werden sollen.

incrementRotationZ(increment: number): void;

Parameter

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.ThreeDimensionalFormatLoadOptions): Word.ThreeDimensionalFormat;

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

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

Parameter

Gibt zurück

Setzt die Extrusionsdrehung um die X-Achse, y-Achse und Z-Achse auf 0 zurück.

resetRotation(): 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.ThreeDimensionalFormatUpdateData, 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.ThreeDimensionalFormat): void;

Parameter

Gibt zurück

Legt die Richtung des Strangpfads der Extrusion fest.

setExtrusionDirection(presetExtrusionDirection: Word.PresetExtrusionDirection): void;

Parameter

Gibt zurück

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Legt die Richtung des Strangpfads der Extrusion fest.

setExtrusionDirection(presetExtrusionDirection: "Mixed" | "BottomRight" | "Bottom" | "BottomLeft" | "Right" | "None" | "Left" | "TopRight" | "Top" | "TopLeft"): void;

Parameter

Gibt zurück

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Legt die Kameravoreinstellung für die Form fest. Der voreingestellte Kameratyp.

setPresetCamera(presetCamera: Word.PresetCamera): void;

Parameter

Gibt zurück

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Legt die Kameravoreinstellung für die Form fest. Der voreingestellte Kameratyp.

setPresetCamera(presetCamera: "Mixed" | "LegacyObliqueTopLeft" | "LegacyObliqueTop" | "LegacyObliqueTopRight" | "LegacyObliqueLeft" | "LegacyObliqueFront" | "LegacyObliqueRight" | "LegacyObliqueBottomLeft" | "LegacyObliqueBottom" | "LegacyObliqueBottomRight" | "LegacyPerspectiveTopLeft" | "LegacyPerspectiveTop" | "LegacyPerspectiveTopRight" | "LegacyPerspectiveLeft" | "LegacyPerspectiveFront" | "LegacyPerspectiveRight" | "LegacyPerspectiveBottomLeft" | "LegacyPerspectiveBottom" | "LegacyPerspectiveBottomRight" | "OrthographicFront" | "IsometricTopUp" | "IsometricTopDown" | "IsometricBottomUp" | "IsometricBottomDown" | "IsometricLeftUp" | "IsometricLeftDown" | "IsometricRightUp" | "IsometricRightDown" | "IsometricOffAxis1Left" | "IsometricOffAxis1Right" | "IsometricOffAxis1Top" | "IsometricOffAxis2Left" | "IsometricOffAxis2Right" | "IsometricOffAxis2Top" | "IsometricOffAxis3Left" | "IsometricOffAxis3Right" | "IsometricOffAxis3Bottom" | "IsometricOffAxis4Left" | "IsometricOffAxis4Right" | "IsometricOffAxis4Bottom" | "ObliqueTopLeft" | "ObliqueTop" | "ObliqueTopRight" | "ObliqueLeft" | "ObliqueRight" | "ObliqueBottomLeft" | "ObliqueBottom" | "ObliqueBottomRight" | "PerspectiveFront" | "PerspectiveLeft" | "PerspectiveRight" | "PerspectiveAbove" | "PerspectiveBelow" | "PerspectiveAboveLeftFacing" | "PerspectiveAboveRightFacing" | "PerspectiveContrastingLeftFacing" | "PerspectiveContrastingRightFacing" | "PerspectiveHeroicLeftFacing" | "PerspectiveHeroicRightFacing" | "PerspectiveHeroicExtremeLeftFacing" | "PerspectiveHeroicExtremeRightFacing" | "PerspectiveRelaxed" | "PerspectiveRelaxedModerately"): void;

Parameter

Gibt zurück

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Legt das voreingestellte Extrusionsformat fest. Das voreingestellte Format.

setThreeDimensionalFormat(presetThreeDimensionalFormat: Word.PresetThreeDimensionalFormat): void;

Parameter

Gibt zurück

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Legt das voreingestellte Extrusionsformat fest. Das voreingestellte Format.

setThreeDimensionalFormat(presetThreeDimensionalFormat: "Mixed" | "Format1" | "Format2" | "Format3" | "Format4" | "Format5" | "Format6" | "Format7" | "Format8" | "Format9" | "Format10" | "Format11" | "Format12" | "Format13" | "Format14" | "Format15" | "Format16" | "Format17" | "Format18" | "Format19" | "Format20"): void;

Parameter

Gibt zurück

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

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

toJSON(): Word.Interfaces.ThreeDimensionalFormatData;

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

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

Gibt zurück