Word.ThreeDimensionalFormat class

Paquet:
word

Représente la mise en forme en trois dimensions de la forme.

Extends
OfficeExtension.ClientObject

Remarques

Jeu d’API : WordApiDesktop 1.3

Utilisateur

Exemples

// 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,
  });
});

Propriétés

bevelBottomDepth

Spécifie la profondeur du biseau inférieur.
bevelBottomInset

Spécifie la taille de l’encart pour le biseau inférieur.
bevelBottomType

Spécifie une BevelType valeur qui représente le type de biseau du biseau inférieur.
bevelTopDepth

Spécifie la profondeur du biseau supérieur.
bevelTopInset

Spécifie la taille en encart du biseau supérieur.
bevelTopType

Spécifie une BevelType valeur qui représente le type de biseau pour le biseau supérieur.
context

Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office.
contourColor

Renvoie un ColorFormat objet qui représente la couleur du contour d’une forme.
contourWidth

Spécifie la largeur du contour d’une forme.
depth

Spécifie la profondeur de l’extrusion de la forme.
extrusionColor

Renvoie un ColorFormat objet qui représente la couleur de l’extrusion de la forme.
extrusionColorType

Indique si la couleur de l'extrusion est basée sur le remplissage de la forme extrudée (face avant de l'extrusion) et si elle change automatiquement en même temps que le remplissage de la forme, ou si la couleur de l'extrusion est indépendante du remplissage de la forme.
fieldOfView

Spécifie le degré de perspective d’une forme.
isPerspective

Spécifie true si l’extrusion apparaît en perspective, c’est-à-dire si les parois de l’extrusion se rétrécissent vers un point de fuite, false si l’extrusion est une projection parallèle ou orthographique, c’est-à-dire si les murs ne se rétrécissent pas vers un point de fuite.
isVisible

Spécifie si l’objet spécifié, ou la mise en forme qui lui est appliquée, est visible.
lightAngle

Spécifie l’angle d’éclairage.
presetCamera

Renvoie une PresetCamera valeur qui représente les présélections de caméra.
presetExtrusionDirection

Renvoie la direction prise par le chemin de balayage de l'extrusion à partir de la forme extrudée (la face avant de l'extrusion).
presetLighting

Spécifie une LightRigType valeur qui représente la présélection d’éclairage.
presetLightingDirection

Spécifie la position de la source lumineuse par rapport à l’extrusion.
presetLightingSoftness

Spécifie l’intensité de l’éclairage de l’extrusion.
presetMaterial

Spécifie les caractéristiques de la surface de l'extrusion.
presetThreeDimensionalFormat

Renvoie le format d'extrusion prédéfini.
projectText

Indique si le texte d’une forme pivote avec la forme. true Fait pivoter le texte.
rotationX

Spécifie la rotation de la forme extrudée autour de l’axe x, en degrés.
rotationY

Spécifie la rotation de la forme extrudée autour de l’axe Y, en degrés.
rotationZ

Spécifie la rotation de la caméra sur l’axe z.
z

Spécifie la position de la forme sur l’axe z.

Méthodes

incrementRotationHorizontal(increment)

Fait pivoter horizontalement une forme sur l’axe des x. Nombre de degrés à faire pivoter.
incrementRotationVertical(increment)

Fait pivoter verticalement une forme sur l’axe Y. Nombre de degrés à faire pivoter.
incrementRotationX(increment)

Modifie la rotation autour de l’axe X. Nombre de degrés à faire pivoter.
incrementRotationY(increment)

Modifie la rotation autour de l’axe Y. Nombre de degrés à faire pivoter.
incrementRotationZ(increment)

Fait pivoter une forme sur l’axe z. Nombre de degrés à faire pivoter.
load(options)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.
load(propertyNames)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.
load(propertyNamesAndPaths)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.
resetRotation()

Réinitialise la rotation d’extrusion autour de l’axe x, de l’axe y et de l’axe z à 0.
set(properties, options)

Définit plusieurs propriétés d’un objet en même temps. Vous pouvez transmettre soit un objet ordinaire avec les propriétés appropriées, soit un autre objet API du même type.
set(properties)

Définit plusieurs propriétés sur l’objet en même temps, en fonction d’un objet chargé existant.
setExtrusionDirection(presetExtrusionDirection)

Définit la direction de la trajectoire de balayage de l’extrusion.
setExtrusionDirection(presetExtrusionDirection)

Définit la direction de la trajectoire de balayage de l’extrusion.
setPresetCamera(presetCamera)

Définit la présélection de l’appareil photo pour la forme. Type de caméra prédéfini.
setPresetCamera(presetCamera)

Définit la présélection de l’appareil photo pour la forme. Type de caméra prédéfini.
setThreeDimensionalFormat(presetThreeDimensionalFormat)

Cette méthode détermine le format d'extrusion prédéfini. Format prédéfini.
setThreeDimensionalFormat(presetThreeDimensionalFormat)

Cette méthode détermine le format d'extrusion prédéfini. Format prédéfini.
toJSON()

Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringify, à son tour, appelle la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine Word.ThreeDimensionalFormat est un objet API, la toJSON méthode renvoie un objet JavaScript simple (typé ) Word.Interfaces.ThreeDimensionalFormatDataqui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.
track()

Effectuer le suivi de l’objet pour l’ajustement automatique en fonction environnant des modifications dans le document. Cet appel est un raccourci pour context.trackedObjects.add(thisObject). Si vous utilisez cet objet entre des .sync appels et en dehors de l’exécution séquentielle d’un lot « .run » et que vous obtenez une erreur « InvalidObjectPath » lors de la définition d’une propriété ou de l’appel d’une méthode sur l’objet, vous devez ajouter l’objet à la collection d’objets suivis lors de la création initiale de l’objet. Si cet objet fait partie d’une collection, vous devez également suivre la collection parente.
untrack()

Publication mémoire associée à cet objet si elle a été précédemment suivie. Cet appel est l’abréviation de context.trackedObjects.remove(thisObject). Vous rencontrez de nombreux objets suivies ralentit l’application hôte, donc n’oubliez pas de libérer les objets que l'on ajoute, une fois que vous avez terminé à les utiliser. Vous devez appeler context.sync() avant que la libération de mémoire prenne effet.

Détails de la propriété

bevelBottomDepth

Spécifie la profondeur du biseau inférieur.

bevelBottomDepth: number;

Valeur de propriété

number

Remarques

Jeu d’API : WordApiDesktop 1.3

bevelBottomInset

Spécifie la taille de l’encart pour le biseau inférieur.

bevelBottomInset: number;

Valeur de propriété

number

Remarques

Jeu d’API : WordApiDesktop 1.3

bevelBottomType

Spécifie une BevelType valeur qui représente le type de biseau du biseau inférieur.

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

Valeur de propriété

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

Remarques

Jeu d’API : WordApiDesktop 1.3

bevelTopDepth

Spécifie la profondeur du biseau supérieur.

bevelTopDepth: number;

Valeur de propriété

number

Remarques

Jeu d’API : WordApiDesktop 1.3

bevelTopInset

Spécifie la taille en encart du biseau supérieur.

bevelTopInset: number;

Valeur de propriété

number

Remarques

Jeu d’API : WordApiDesktop 1.3

bevelTopType

Spécifie une BevelType valeur qui représente le type de biseau pour le biseau supérieur.

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

Valeur de propriété

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

Remarques

Jeu d’API : WordApiDesktop 1.3

context

Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office.

context: RequestContext;

Valeur de propriété

Word.RequestContext

contourColor

Renvoie un ColorFormat objet qui représente la couleur du contour d’une forme.

readonly contourColor: Word.ColorFormat;

Valeur de propriété

Word.ColorFormat

Remarques

Jeu d’API : WordApiDesktop 1.3

contourWidth

Spécifie la largeur du contour d’une forme.

contourWidth: number;

Valeur de propriété

number

Remarques

Jeu d’API : WordApiDesktop 1.3

depth

Spécifie la profondeur de l’extrusion de la forme.

depth: number;

Valeur de propriété

number

Remarques

Jeu d’API : WordApiDesktop 1.3

extrusionColor

Renvoie un ColorFormat objet qui représente la couleur de l’extrusion de la forme.

readonly extrusionColor: Word.ColorFormat;

Valeur de propriété

Word.ColorFormat

Remarques

Jeu d’API : WordApiDesktop 1.3

extrusionColorType

Indique si la couleur de l'extrusion est basée sur le remplissage de la forme extrudée (face avant de l'extrusion) et si elle change automatiquement en même temps que le remplissage de la forme, ou si la couleur de l'extrusion est indépendante du remplissage de la forme.

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

Valeur de propriété

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

Remarques

Jeu d’API : WordApiDesktop 1.3

fieldOfView

Spécifie le degré de perspective d’une forme.

fieldOfView: number;

Valeur de propriété

number

Remarques

Jeu d’API : WordApiDesktop 1.3

isPerspective

Spécifie true si l’extrusion apparaît en perspective, c’est-à-dire si les parois de l’extrusion se rétrécissent vers un point de fuite, false si l’extrusion est une projection parallèle ou orthographique, c’est-à-dire si les murs ne se rétrécissent pas vers un point de fuite.

isPerspective: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : WordApiDesktop 1.3

isVisible

Spécifie si l’objet spécifié, ou la mise en forme qui lui est appliquée, est visible.

isVisible: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : WordApiDesktop 1.3

lightAngle

Spécifie l’angle d’éclairage.

lightAngle: number;

Valeur de propriété

number

Remarques

Jeu d’API : WordApiDesktop 1.3

presetCamera

Renvoie une PresetCamera valeur qui représente les présélections de caméra.

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";

Valeur de propriété

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"

Remarques

Jeu d’API : WordApiDesktop 1.3

presetExtrusionDirection

Renvoie la direction prise par le chemin de balayage de l'extrusion à partir de la forme extrudée (la face avant de l'extrusion).

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

Valeur de propriété

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

Remarques

Jeu d’API : WordApiDesktop 1.3

presetLighting

Spécifie une LightRigType valeur qui représente la présélection d’éclairage.

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";

Valeur de propriété

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"

Remarques

Jeu d’API : WordApiDesktop 1.3

presetLightingDirection

Spécifie la position de la source lumineuse par rapport à l’extrusion.

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

Valeur de propriété

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

Remarques

Jeu d’API : WordApiDesktop 1.3

presetLightingSoftness

Spécifie l’intensité de l’éclairage de l’extrusion.

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

Valeur de propriété

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

Remarques

Jeu d’API : WordApiDesktop 1.3

presetMaterial

Spécifie les caractéristiques de la surface de l'extrusion.

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

Valeur de propriété

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

Remarques

Jeu d’API : WordApiDesktop 1.3

presetThreeDimensionalFormat

Renvoie le format d'extrusion prédéfini.

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";

Valeur de propriété

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

Remarques

Jeu d’API : WordApiDesktop 1.3

projectText

Indique si le texte d’une forme pivote avec la forme. true Fait pivoter le texte.

projectText: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : WordApiDesktop 1.3

rotationX

Spécifie la rotation de la forme extrudée autour de l’axe x, en degrés.

rotationX: number;

Valeur de propriété

number

Remarques

Jeu d’API : WordApiDesktop 1.3

rotationY

Spécifie la rotation de la forme extrudée autour de l’axe Y, en degrés.

rotationY: number;

Valeur de propriété

number

Remarques

Jeu d’API : WordApiDesktop 1.3

rotationZ

Spécifie la rotation de la caméra sur l’axe z.

rotationZ: number;

Valeur de propriété

number

Remarques

Jeu d’API : WordApiDesktop 1.3

z

Spécifie la position de la forme sur l’axe z.

z: number;

Valeur de propriété

number

Remarques

Jeu d’API : WordApiDesktop 1.3

Détails de la méthode

incrementRotationHorizontal(increment)

Fait pivoter horizontalement une forme sur l’axe des x. Nombre de degrés à faire pivoter.

incrementRotationHorizontal(increment: number): void;

Paramètres

increment

number

Retours

void

Remarques

Jeu d’API : WordApiDesktop 1.3

incrementRotationVertical(increment)

Fait pivoter verticalement une forme sur l’axe Y. Nombre de degrés à faire pivoter.

incrementRotationVertical(increment: number): void;

Paramètres

increment

number

Retours

void

Remarques

Jeu d’API : WordApiDesktop 1.3

incrementRotationX(increment)

Modifie la rotation autour de l’axe X. Nombre de degrés à faire pivoter.

incrementRotationX(increment: number): void;

Paramètres

increment

number

Retours

void

Remarques

Jeu d’API : WordApiDesktop 1.3

incrementRotationY(increment)

Modifie la rotation autour de l’axe Y. Nombre de degrés à faire pivoter.

incrementRotationY(increment: number): void;

Paramètres

increment

number

Retours

void

Remarques

Jeu d’API : WordApiDesktop 1.3

incrementRotationZ(increment)

Fait pivoter une forme sur l’axe z. Nombre de degrés à faire pivoter.

incrementRotationZ(increment: number): void;

Paramètres

increment

number

Retours

void

Remarques

Jeu d’API : WordApiDesktop 1.3

load(options)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(options?: Word.Interfaces.ThreeDimensionalFormatLoadOptions): Word.ThreeDimensionalFormat;

Paramètres

options
Word.Interfaces.ThreeDimensionalFormatLoadOptions

Fournit des options pour les propriétés de l’objet à charger.

Retours

Word.ThreeDimensionalFormat

load(propertyNames)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(propertyNames?: string | string[]): Word.ThreeDimensionalFormat;

Paramètres

propertyNames

string | string[]

Chaîne délimitée par des virgules ou tableau de chaînes spécifiant les propriétés à charger.

Retours

Word.ThreeDimensionalFormat

load(propertyNamesAndPaths)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Word.ThreeDimensionalFormat;

Paramètres

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select est une chaîne délimitée par des virgules qui spécifie les propriétés à charger, et propertyNamesAndPaths.expand est une chaîne délimitée par des virgules qui spécifie les propriétés de navigation à charger.

Retours

Word.ThreeDimensionalFormat

resetRotation()

Réinitialise la rotation d’extrusion autour de l’axe x, de l’axe y et de l’axe z à 0.

resetRotation(): void;

Retours

void

Remarques

Jeu d’API : WordApiDesktop 1.3

set(properties, options)

Définit plusieurs propriétés d’un objet en même temps. Vous pouvez transmettre soit un objet ordinaire avec les propriétés appropriées, soit un autre objet API du même type.

set(properties: Interfaces.ThreeDimensionalFormatUpdateData, options?: OfficeExtension.UpdateOptions): void;

Paramètres

properties
Word.Interfaces.ThreeDimensionalFormatUpdateData

Objet JavaScript dont les propriétés sont structurées de façon isomorphe par rapport aux propriétés de l’objet sur lequel la méthode est appelée.

options
OfficeExtension.UpdateOptions

Fournit une option permettant de supprimer les erreurs si l’objet de propriétés tente de définir des propriétés en lecture seule.

Retours

void

set(properties)

Définit plusieurs propriétés sur l’objet en même temps, en fonction d’un objet chargé existant.

set(properties: Word.ThreeDimensionalFormat): void;

Paramètres

properties
Word.ThreeDimensionalFormat

Retours

void

setExtrusionDirection(presetExtrusionDirection)

Définit la direction de la trajectoire de balayage de l’extrusion.

setExtrusionDirection(presetExtrusionDirection: Word.PresetExtrusionDirection): void;

Paramètres

presetExtrusionDirection
Word.PresetExtrusionDirection

Direction prédéfinie.

Retours

void

Remarques

Jeu d’API : WordApiDesktop 1.3

setExtrusionDirection(presetExtrusionDirection)

Définit la direction de la trajectoire de balayage de l’extrusion.

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

Paramètres

presetExtrusionDirection

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

Direction prédéfinie.

Retours

void

Remarques

Jeu d’API : WordApiDesktop 1.3

setPresetCamera(presetCamera)

Définit la présélection de l’appareil photo pour la forme. Type de caméra prédéfini.

setPresetCamera(presetCamera: Word.PresetCamera): void;

Paramètres

presetCamera
Word.PresetCamera

Retours

void

Remarques

Jeu d’API : WordApiDesktop 1.3

setPresetCamera(presetCamera)

Définit la présélection de l’appareil photo pour la forme. Type de caméra prédéfini.

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;

Paramètres

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"

Retours

void

Remarques

Jeu d’API : WordApiDesktop 1.3

setThreeDimensionalFormat(presetThreeDimensionalFormat)

Cette méthode détermine le format d'extrusion prédéfini. Format prédéfini.

setThreeDimensionalFormat(presetThreeDimensionalFormat: Word.PresetThreeDimensionalFormat): void;

Paramètres

presetThreeDimensionalFormat
Word.PresetThreeDimensionalFormat

Retours

void

Remarques

Jeu d’API : WordApiDesktop 1.3

setThreeDimensionalFormat(presetThreeDimensionalFormat)

Cette méthode détermine le format d'extrusion prédéfini. Format prédéfini.

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

Paramètres

presetThreeDimensionalFormat

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

Retours

void

Remarques

Jeu d’API : WordApiDesktop 1.3

toJSON()

Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringify, à son tour, appelle la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine Word.ThreeDimensionalFormat est un objet API, la toJSON méthode renvoie un objet JavaScript simple (typé ) Word.Interfaces.ThreeDimensionalFormatDataqui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.

toJSON(): Word.Interfaces.ThreeDimensionalFormatData;

Retours

Word.Interfaces.ThreeDimensionalFormatData

track()

Effectuer le suivi de l’objet pour l’ajustement automatique en fonction environnant des modifications dans le document. Cet appel est un raccourci pour context.trackedObjects.add(thisObject). Si vous utilisez cet objet entre des .sync appels et en dehors de l’exécution séquentielle d’un lot « .run » et que vous obtenez une erreur « InvalidObjectPath » lors de la définition d’une propriété ou de l’appel d’une méthode sur l’objet, vous devez ajouter l’objet à la collection d’objets suivis lors de la création initiale de l’objet. Si cet objet fait partie d’une collection, vous devez également suivre la collection parente.

track(): Word.ThreeDimensionalFormat;

Retours

Word.ThreeDimensionalFormat

untrack()

Publication mémoire associée à cet objet si elle a été précédemment suivie. Cet appel est l’abréviation de context.trackedObjects.remove(thisObject). Vous rencontrez de nombreux objets suivies ralentit l’application hôte, donc n’oubliez pas de libérer les objets que l'on ajoute, une fois que vous avez terminé à les utiliser. Vous devez appeler context.sync() avant que la libération de mémoire prenne effet.

untrack(): Word.ThreeDimensionalFormat;

Retours

Word.ThreeDimensionalFormat