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

浮き出しの色が 3-d 図形の塗りつぶし (浮き出しの前面) に基づくかどうかを指定し、図形の塗りつぶしを変更するとき、または浮き出しの色は、図形の塗りつぶしの独立したかどうかを自動的に変更します。

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

プロパティ値

注釈

API セット: WordApiDesktop 1.3

図形のパースペクティブの量を指定します。

fieldOfView: number;

プロパティ値

注釈

API セット: WordApiDesktop 1.3

押し出しがパースペクティブで表示される場合 (つまり、押し出しの壁が消失点に向かって狭い場合)、押し出しが平行または正投影の場合はfalsetrueを指定します。つまり、壁が消失点に向かって狭くない場合です。

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

既定の 3-d 書式を返します。

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

既定の 3-D 書式を設定します。 プリセット形式。

setThreeDimensionalFormat(presetThreeDimensionalFormat: Word.PresetThreeDimensionalFormat): void;

パラメーター

返品

注釈

API セット: WordApiDesktop 1.3

既定の 3-D 書式を設定します。 プリセット形式。

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

API オブジェクトがJSON.stringify()に渡されたときにより便利な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (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;

返品