Word.ThreeDimensionalFormat class

Spécifie la profondeur du biseau inférieur.

bevelBottomDepth: number;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

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

bevelBottomInset: number;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

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

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

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Spécifie la profondeur du biseau supérieur.

bevelTopDepth: number;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Spécifie la taille de l’incrustation pour le biseau supérieur.

bevelTopInset: number;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

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é

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.

context: RequestContext;

Valeur de propriété

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

readonly contourColor: Word.ColorFormat;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

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

contourWidth: number;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

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

depth: number;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

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

readonly extrusionColor: Word.ColorFormat;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

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é

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Spécifie la quantité de perspective d’une forme.

fieldOfView: number;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

true Spécifie si l’extrusion apparaît en perspective, c’est-à-dire si les murs de l’extrusion se rétrécissent vers un point de disparaître, 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 disparaître.

isPerspective: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

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é

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Spécifie l’angle de l’éclairage.

lightAngle: number;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Retourne une PresetCamera valeur qui représente les présélections de l’appareil photo.

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é

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

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é

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

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é

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

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é

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

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

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

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

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é

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

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é

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Spécifie si le texte d’une forme pivote avec la forme. true fait pivoter le texte.

projectText: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

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

rotationX: number;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

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

rotationY: number;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

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

rotationZ: number;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

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

z: number;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

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

incrementRotationHorizontal(increment: number): void;

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Effectue une rotation verticale d’une forme sur l’axe y. Nombre de degrés à pivoter.

incrementRotationVertical(increment: number): void;

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

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

incrementRotationX(increment: number): void;

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

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

incrementRotationY(increment: number): void;

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

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

incrementRotationZ(increment: number): void;

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

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

Retours

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

Retours

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

Retours

Rétablit la rotation d’extrusion autour de l’axe X, de l’axe Y et de l’axe z à 0.

resetRotation(): void;

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Définit plusieurs propriétés d’un objet en même temps. Vous pouvez passer un objet brut avec les propriétés appropriées ou un autre objet API du même type.

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

Paramètres

Retours

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

Retours

Définit la direction du chemin de balayage de l’extrusion.

setExtrusionDirection(presetExtrusionDirection: Word.PresetExtrusionDirection): void;

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Définit la direction du chemin de balayage de l’extrusion.

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

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

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

setPresetCamera(presetCamera: Word.PresetCamera): void;

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Définit la présélection de l’appareil photo pour la forme. Type d’appareil photo 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

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

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

setThreeDimensionalFormat(presetThreeDimensionalFormat: Word.PresetThreeDimensionalFormat): void;

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

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

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

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 brut (typé en tant Word.Interfaces.ThreeDimensionalFormatDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.

toJSON(): Word.Interfaces.ThreeDimensionalFormatData;

Retours

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 sur 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 suivie lors de la première création de l’objet. Si cet objet fait partie d’une collection, vous devez également suivre la collection parente.

track(): Word.ThreeDimensionalFormat;

Retours

Publication mémoire associée à cet objet si elle a été précédemment suivie. Cet appel est abrégé pour 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 mise en production de la mémoire ne prenne effet.

untrack(): Word.ThreeDimensionalFormat;

Retours