Word.ThreeDimensionalFormat class

Paket:
word

Stellt die dreidimensionale Formatierung einer Form dar.

Extends
OfficeExtension.ClientObject

Hinweise

API-Satz: WordApiDesktop 1.3

Verwendet von

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/25-paragraph/apply-bevel-to-text.yaml

if (!Office.context.requirements.isSetSupported("WordApiDesktop", "1.3")) {
  console.error("This sample requires WordApiDesktop 1.3 or later.");
  return;
}

await Word.run(async (context) => {
  const paragraph: Word.Paragraph = context.document.body.insertParagraph(
    "Beveled text",
    Word.InsertLocation.start,
  );
  paragraph.font.size = 48;
  paragraph.font.bold = true;

  const threeDimensionalFormat: Word.ThreeDimensionalFormat = paragraph.font.threeDimensionalFormat;
  threeDimensionalFormat.isVisible = true;
  threeDimensionalFormat.bevelTopType = Word.BevelType.circle;
  threeDimensionalFormat.bevelTopDepth = 6;
  threeDimensionalFormat.bevelTopInset = 6;
  threeDimensionalFormat.load("bevelTopType,bevelTopDepth,bevelTopInset");

  await context.sync();

  console.log("Applied bevel formatting:", {
    type: threeDimensionalFormat.bevelTopType,
    depth: threeDimensionalFormat.bevelTopDepth,
    inset: threeDimensionalFormat.bevelTopInset,
  });
});

Eigenschaften

bevelBottomDepth

Gibt die Tiefe der unteren Fase an.
bevelBottomInset

Gibt die Einschubgröße für die untere Fase an.
bevelBottomType

Gibt einen BevelType Wert an, der den Fasentyp für die untere Fase darstellt.
bevelTopDepth

Gibt die Tiefe der oberen Abschrägung an.
bevelTopInset

Gibt die Einschubgröße für die obere Fase an.
bevelTopType

Gibt einen BevelType Wert an, der den Fasentyp für die obere Abschrägung darstellt.
context

Der dem Objekt zugeordnete Anforderungskontext. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.
contourColor

Gibt ein ColorFormat Objekt zurück, das die Farbe der Kontur einer Form darstellt.
contourWidth

Gibt die Breite der Kontur einer Form an.
depth

Gibt die Tiefe der Extrusion der Form an.
extrusionColor

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

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.
fieldOfView

Gibt den Perspektivgrad für ein Shape an.
isPerspective

Gibt an true , ob die Extrusion perspektivisch angezeigt wird, d. h. ob sich die Wände der Extrusion in Richtung eines Fluchtpunkts verengen, false ob die Extrusion eine parallele oder orthogonale Projektion ist, d. h., ob sich die Wände in Richtung eines Fluchtpunkts nicht verengen.
isVisible

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

Gibt den Beleuchtungswinkel an.
presetCamera

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

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

Gibt einen LightRigType Wert an, der die Beleuchtungsvoreinstellung darstellt.
presetLightingDirection

Gibt die Position der Lichtquelle relativ zur Extrusion an.
presetLightingSoftness

Gibt die Intensität der Extrusionsbeleuchtung an.
presetMaterial

Gibt das Oberflächenmaterial an.
presetThreeDimensionalFormat

Gibt das vordefinierte Extrusionsformat zurück.
projectText

Gibt an, ob sich Text auf einem Shape mit der Form dreht. true Dreht den Text.
rotationX

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

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

Gibt die Drehung der Kamera an der Z-Achse an.
z

Gibt die Position des Shapes auf der Z-Achse an.

Methoden

incrementRotationHorizontal(increment)

Dreht ein Shape horizontal auf der x-Achse. Die Anzahl der Grad, um die gedreht werden soll.
incrementRotationVertical(increment)

Dreht ein Shape vertikal auf der y-Achse. Die Anzahl der Grad, um die gedreht werden soll.
incrementRotationX(increment)

Ändert die Drehung um die x-Achse. Die Anzahl der Grad, um die gedreht werden soll.
incrementRotationY(increment)

Ändert die Drehung um die y-Achse. Die Anzahl der Grad, um die gedreht werden soll.
incrementRotationZ(increment)

Dreht ein Shape auf der Z-Achse. Die Anzahl der Grad, um die gedreht werden soll.
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(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(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.
resetRotation()

Setzt die Extrusionsdrehung um die x-Achse, y-Achse und z-Achse auf 0 zurück.
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.
setExtrusionDirection(presetExtrusionDirection)

Legt die Richtung des Sweep-Pfads der Extrusion fest.
setExtrusionDirection(presetExtrusionDirection)

Legt die Richtung des Sweep-Pfads der Extrusion fest.
setPresetCamera(presetCamera)

Legt die Kameravoreinstellung für die Form fest. Der voreingestellte Kameratyp.
setPresetCamera(presetCamera)

Legt die Kameravoreinstellung für die Form fest. Der voreingestellte Kameratyp.
setThreeDimensionalFormat(presetThreeDimensionalFormat)

Legt das voreingestellte Extrusionsformat fest. Das voreingestellte Format.
setThreeDimensionalFormat(presetThreeDimensionalFormat)

Legt das voreingestellte Extrusionsformat fest. Das voreingestellte Format.
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.ThreeDimensionalFormat Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (als Word.Interfaces.ThreeDimensionalFormatData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften des ursprünglichen Objekts enthält.
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.
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.

Details zur Eigenschaft

bevelBottomDepth

Gibt die Tiefe der unteren Fase an.

bevelBottomDepth: number;

Eigenschaftswert

number

Hinweise

API-Satz: WordApiDesktop 1.3

bevelBottomInset

Gibt die Einschubgröße für die untere Fase an.

bevelBottomInset: number;

Eigenschaftswert

number

Hinweise

API-Satz: WordApiDesktop 1.3

bevelBottomType

Gibt einen BevelType Wert an, der den Fasentyp für die untere Fase darstellt.

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

Eigenschaftswert

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

Hinweise

API-Satz: WordApiDesktop 1.3

bevelTopDepth

Gibt die Tiefe der oberen Abschrägung an.

bevelTopDepth: number;

Eigenschaftswert

number

Hinweise

API-Satz: WordApiDesktop 1.3

bevelTopInset

Gibt die Einschubgröße für die obere Fase an.

bevelTopInset: number;

Eigenschaftswert

number

Hinweise

API-Satz: WordApiDesktop 1.3

bevelTopType

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

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

Eigenschaftswert

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

Hinweise

API-Satz: WordApiDesktop 1.3

context

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

context: RequestContext;

Eigenschaftswert

Word.RequestContext

contourColor

Gibt ein ColorFormat Objekt zurück, das die Farbe der Kontur einer Form darstellt.

readonly contourColor: Word.ColorFormat;

Eigenschaftswert

Word.ColorFormat

Hinweise

API-Satz: WordApiDesktop 1.3

contourWidth

Gibt die Breite der Kontur einer Form an.

contourWidth: number;

Eigenschaftswert

number

Hinweise

API-Satz: WordApiDesktop 1.3

depth

Gibt die Tiefe der Extrusion der Form an.

depth: number;

Eigenschaftswert

number

Hinweise

API-Satz: WordApiDesktop 1.3

extrusionColor

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

readonly extrusionColor: Word.ColorFormat;

Eigenschaftswert

Word.ColorFormat

Hinweise

API-Satz: WordApiDesktop 1.3

extrusionColorType

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

Word.ExtrusionColorType | "mixed" | "automatic" | "custom"

Hinweise

API-Satz: WordApiDesktop 1.3

fieldOfView

Gibt den Perspektivgrad für ein Shape an.

fieldOfView: number;

Eigenschaftswert

number

Hinweise

API-Satz: WordApiDesktop 1.3

isPerspective

Gibt an true , ob die Extrusion perspektivisch angezeigt wird, d. h. ob sich die Wände der Extrusion in Richtung eines Fluchtpunkts verengen, false ob die Extrusion eine parallele oder orthogonale Projektion ist, d. h., ob sich die Wände in Richtung eines Fluchtpunkts nicht verengen.

isPerspective: boolean;

Eigenschaftswert

boolean

Hinweise

API-Satz: WordApiDesktop 1.3

isVisible

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

isVisible: boolean;

Eigenschaftswert

boolean

Hinweise

API-Satz: WordApiDesktop 1.3

lightAngle

Gibt den Beleuchtungswinkel an.

lightAngle: number;

Eigenschaftswert

number

Hinweise

API-Satz: WordApiDesktop 1.3

presetCamera

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

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"

Hinweise

API-Satz: WordApiDesktop 1.3

presetExtrusionDirection

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

Word.PresetExtrusionDirection | "Mixed" | "BottomRight" | "Bottom" | "BottomLeft" | "Right" | "None" | "Left" | "TopRight" | "Top" | "TopLeft"

Hinweise

API-Satz: WordApiDesktop 1.3

presetLighting

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

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"

Hinweise

API-Satz: WordApiDesktop 1.3

presetLightingDirection

Gibt die Position der Lichtquelle relativ zur Extrusion an.

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

Eigenschaftswert

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

Hinweise

API-Satz: WordApiDesktop 1.3

presetLightingSoftness

Gibt die Intensität der Extrusionsbeleuchtung an.

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

Eigenschaftswert

Word.PresetLightingSoftness | "Mixed" | "Dim" | "Normal" | "Bright"

Hinweise

API-Satz: WordApiDesktop 1.3

presetMaterial

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

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

Hinweise

API-Satz: WordApiDesktop 1.3

presetThreeDimensionalFormat

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

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

Hinweise

API-Satz: WordApiDesktop 1.3

projectText

Gibt an, ob sich Text auf einem Shape mit der Form dreht. true Dreht den Text.

projectText: boolean;

Eigenschaftswert

boolean

Hinweise

API-Satz: WordApiDesktop 1.3

rotationX

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

rotationX: number;

Eigenschaftswert

number

Hinweise

API-Satz: WordApiDesktop 1.3

rotationY

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

rotationY: number;

Eigenschaftswert

number

Hinweise

API-Satz: WordApiDesktop 1.3

rotationZ

Gibt die Drehung der Kamera an der Z-Achse an.

rotationZ: number;

Eigenschaftswert

number

Hinweise

API-Satz: WordApiDesktop 1.3

z

Gibt die Position des Shapes auf der Z-Achse an.

z: number;

Eigenschaftswert

number

Hinweise

API-Satz: WordApiDesktop 1.3

Details zur Methode

incrementRotationHorizontal(increment)

Dreht ein Shape horizontal auf der x-Achse. Die Anzahl der Grad, um die gedreht werden soll.

incrementRotationHorizontal(increment: number): void;

Parameter

increment

number

Gibt zurück

void

Hinweise

API-Satz: WordApiDesktop 1.3

incrementRotationVertical(increment)

Dreht ein Shape vertikal auf der y-Achse. Die Anzahl der Grad, um die gedreht werden soll.

incrementRotationVertical(increment: number): void;

Parameter

increment

number

Gibt zurück

void

Hinweise

API-Satz: WordApiDesktop 1.3

incrementRotationX(increment)

Ändert die Drehung um die x-Achse. Die Anzahl der Grad, um die gedreht werden soll.

incrementRotationX(increment: number): void;

Parameter

increment

number

Gibt zurück

void

Hinweise

API-Satz: WordApiDesktop 1.3

incrementRotationY(increment)

Ändert die Drehung um die y-Achse. Die Anzahl der Grad, um die gedreht werden soll.

incrementRotationY(increment: number): void;

Parameter

increment

number

Gibt zurück

void

Hinweise

API-Satz: WordApiDesktop 1.3

incrementRotationZ(increment)

Dreht ein Shape auf der Z-Achse. Die Anzahl der Grad, um die gedreht werden soll.

incrementRotationZ(increment: number): void;

Parameter

increment

number

Gibt zurück

void

Hinweise

API-Satz: WordApiDesktop 1.3

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

Parameter

options
Word.Interfaces.ThreeDimensionalFormatLoadOptions

Stellt Optionen für die zu ladenden Eigenschaften des Objekts bereit.

Gibt zurück

Word.ThreeDimensionalFormat

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

Parameter

propertyNames

string | string[]

Eine durch Trennzeichen getrennte Zeichenfolge oder ein Array von Zeichenfolgen, die die zu ladenden Eigenschaften angeben.

Gibt zurück

Word.ThreeDimensionalFormat

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

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

Word.ThreeDimensionalFormat

resetRotation()

Setzt die Extrusionsdrehung um die x-Achse, y-Achse und z-Achse auf 0 zurück.

resetRotation(): void;

Gibt zurück

void

Hinweise

API-Satz: WordApiDesktop 1.3

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

Parameter

properties
Word.Interfaces.ThreeDimensionalFormatUpdateData

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

Parameter

properties
Word.ThreeDimensionalFormat

Gibt zurück

void

setExtrusionDirection(presetExtrusionDirection)

Legt die Richtung des Sweep-Pfads der Extrusion fest.

setExtrusionDirection(presetExtrusionDirection: Word.PresetExtrusionDirection): void;

Parameter

presetExtrusionDirection
Word.PresetExtrusionDirection

Die voreingestellte Richtung.

Gibt zurück

void

Hinweise

API-Satz: WordApiDesktop 1.3

setExtrusionDirection(presetExtrusionDirection)

Legt die Richtung des Sweep-Pfads der Extrusion fest.

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

Parameter

presetExtrusionDirection

"Mixed" | "BottomRight" | "Bottom" | "BottomLeft" | "Right" | "None" | "Left" | "TopRight" | "Top" | "TopLeft"

Die voreingestellte Richtung.

Gibt zurück

void

Hinweise

API-Satz: WordApiDesktop 1.3

setPresetCamera(presetCamera)

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

setPresetCamera(presetCamera: Word.PresetCamera): void;

Parameter

presetCamera
Word.PresetCamera

Gibt zurück

void

Hinweise

API-Satz: WordApiDesktop 1.3

setPresetCamera(presetCamera)

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

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"

Gibt zurück

void

Hinweise

API-Satz: WordApiDesktop 1.3

setThreeDimensionalFormat(presetThreeDimensionalFormat)

Legt das voreingestellte Extrusionsformat fest. Das voreingestellte Format.

setThreeDimensionalFormat(presetThreeDimensionalFormat: Word.PresetThreeDimensionalFormat): void;

Parameter

presetThreeDimensionalFormat
Word.PresetThreeDimensionalFormat

Gibt zurück

void

Hinweise

API-Satz: WordApiDesktop 1.3

setThreeDimensionalFormat(presetThreeDimensionalFormat)

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

presetThreeDimensionalFormat

"Mixed" | "Format1" | "Format2" | "Format3" | "Format4" | "Format5" | "Format6" | "Format7" | "Format8" | "Format9" | "Format10" | "Format11" | "Format12" | "Format13" | "Format14" | "Format15" | "Format16" | "Format17" | "Format18" | "Format19" | "Format20"

Gibt zurück

void

Hinweise

API-Satz: WordApiDesktop 1.3

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

toJSON(): Word.Interfaces.ThreeDimensionalFormatData;

Gibt zurück

Word.Interfaces.ThreeDimensionalFormatData

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

Gibt zurück

Word.ThreeDimensionalFormat

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

Gibt zurück

Word.ThreeDimensionalFormat