Word.ThreeDimensionalFormat class

指定底部棱台的深度。

bevelBottomDepth: number;

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

指定底部凹凸的嵌入大小。

bevelBottomInset: number;

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

指定一个 BevelType 值，该值表示底部棱台的棱台类型。

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

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

指定顶部棱台的深度。

bevelTopDepth: number;

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

指定顶部棱台的嵌入大小。

bevelTopInset: number;

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

指定一个 BevelType 值，该值表示顶部棱台的棱台类型。

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

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。

context: RequestContext;

属性值

返回一个 ColorFormat 对象，该对象表示形状轮廓的颜色。

readonly contourColor: Word.ColorFormat;

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

指定形状轮廓的宽度。

contourWidth: number;

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

指定形状延伸的深度。

depth: number;

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

返回一个 ColorFormat 对象，该对象表示形状延伸的颜色。

readonly extrusionColor: Word.ColorFormat;

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

指定延伸区域的颜色是否基于原图形的填充（延伸区域的正面），并随着图形填充的改变而自动改变，或者延伸区域的颜色是否与图形填充无关。

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

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

指定形状的透视量。

fieldOfView: number;

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

指定 true 延伸是否以透视形式显示（即，如果延伸的壁向消失点变窄， false 如果延伸为平行或正交投影），即如果延伸的墙壁不向消失点变窄。

isPerspective: boolean;

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

指定指定对象或应用于该对象的格式是否可见。

isVisible: boolean;

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

指定照明的角度。

lightAngle: number;

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

返回一个 PresetCamera 值，该值表示相机预设。

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

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

返回延伸经过的路径前导离延伸形状 (延伸的正面) 的方向。

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

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

指定表示 LightRigType 照明预设的值。

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

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

指定光源相对于延伸的位置。

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

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

指定延伸照明的强度。

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

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

指定延伸表面的材料。

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

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

返回预设的延伸格式。

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

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

指定形状上的文本是否随形状一起旋转。 true 旋转文本。

projectText: boolean;

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

指定延伸形状围绕 x 轴的旋转（以度为单位）。

rotationX: number;

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

指定延伸形状围绕 y 轴旋转（以度为单位）。

rotationY: number;

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

指定相机的 Z 轴旋转。

rotationZ: number;

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

指定形状的 z 轴上的位置。

z: number;

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

水平旋转 x 轴上的形状。 要旋转的度数。

incrementRotationHorizontal(increment: number): void;

参数

返回

注解

[ API 集：WordApiDesktop 1.3 ]

垂直旋转 y 轴上的形状。 要旋转的度数。

incrementRotationVertical(increment: number): void;

参数

返回

注解

[ API 集：WordApiDesktop 1.3 ]

更改围绕 x 轴的旋转。 要旋转的度数。

incrementRotationX(increment: number): void;

参数

返回

注解

[ API 集：WordApiDesktop 1.3 ]

更改围绕 y 轴的旋转。 要旋转的度数。

incrementRotationY(increment: number): void;

参数

返回

注解

[ API 集：WordApiDesktop 1.3 ]

在 z 轴上旋转形状。 要旋转的度数。

incrementRotationZ(increment: number): void;

参数

返回

注解

[ API 集：WordApiDesktop 1.3 ]

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

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

参数

返回

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

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

参数

返回

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

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

参数

返回

将围绕 x 轴、y 轴和 z 轴的延伸旋转重置为 0。

resetRotation(): void;

返回

注解

[ API 集：WordApiDesktop 1.3 ]

同时设置对象的多个属性。 可以传递具有相应属性的纯对象，也可以传递同一类型的另一个 API 对象。

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

参数

返回

基于现有的已加载对象，同时对对象设置多个属性。

set(properties: Word.ThreeDimensionalFormat): void;

参数

返回

设置延伸的扫描路径的方向。

setExtrusionDirection(presetExtrusionDirection: Word.PresetExtrusionDirection): void;

参数

返回

注解

[ API 集：WordApiDesktop 1.3 ]

设置延伸的扫描路径的方向。

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

参数

返回

注解

[ API 集：WordApiDesktop 1.3 ]

设置形状的相机预设。 预设相机类型。

setPresetCamera(presetCamera: Word.PresetCamera): void;

参数

返回

注解

[ API 集：WordApiDesktop 1.3 ]

设置形状的相机预设。 预设相机类型。

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;

参数

返回

注解

[ API 集：WordApiDesktop 1.3 ]

返回预设的延伸格式。 预设格式。

setThreeDimensionalFormat(presetThreeDimensionalFormat: Word.PresetThreeDimensionalFormat): void;

参数

返回

注解

[ API 集：WordApiDesktop 1.3 ]

返回预设的延伸格式。 预设格式。

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

参数

返回

注解

[ API 集：WordApiDesktop 1.3 ]

重写 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 JSON.stringify (，依次调用toJSON传递给它的 对象的 方法。) 虽然原始Word.ThreeDimensionalFormat对象是 API 对象，toJSON但该方法返回一个纯 JavaScript 对象， (类型为 Word.Interfaces.ThreeDimensionalFormatData) ，其中包含从原始对象加载的任何子属性的浅表副本。

toJSON(): Word.Interfaces.ThreeDimensionalFormatData;

返回

根据文档中的相应更改来跟踪对象，以便进行自动调整。 此调用是 context.trackedObjects.add (thisObject) 的简写。 如果跨 .sync 调用和“.run”批处理的顺序执行外部使用此对象，并在设置属性或调用对象方法时收到“InvalidObjectPath”错误，则需要在首次创建对象时将该对象添加到跟踪的对象集合。 如果此对象是集合的一部分，则还应跟踪父集合。

track(): Word.ThreeDimensionalFormat;

返回

释放与此对象关联的内存（如果先前已跟踪过）。 此调用是 context.trackedObjects.remove (thisObject) 的简写。 拥有许多跟踪对象会降低主机应用程序的速度，因此请在使用完毕后释放所添加的任何对象。 在内存发布生效之前，需要调用 context.sync() 。

untrack(): Word.ThreeDimensionalFormat;

返回