Word.ShadowFormat class

影付きフォーマットのぼかしレベルを、0.0 から 100.0 までの値で指定します。

blur: number;

プロパティ値

注釈

API セット: WordApiDesktop 1.3

オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。

context: RequestContext;

プロパティ値

塗りつぶし、線、または影の前景色を表す ColorFormat オブジェクトを返します。

readonly foregroundColor: Word.ColorFormat;

プロパティ値

注釈

API セット: WordApiDesktop 1.3

オブジェクトまたはそれに適用されている書式を表示するかどうかを指定します。

isVisible: boolean;

プロパティ値

注釈

API セット: WordApiDesktop 1.3

図形に塗りつぶしがない場合でも、図形の影が塗りつぶされていて図形によって覆われてしまう場合、false図形に塗りつぶしがない場合は影に塗りつぶしがなく、図形に塗りつぶしがない場合は影の輪郭が図形を通して見える場合のtrueを指定します。

obscured: boolean;

プロパティ値

注釈

API セット: WordApiDesktop 1.3

図形からの影の水平方向のオフセット (ポイント単位) を指定します。 正の値相対位置は図形の右側に負の値は、左側にオフセットします。

offsetX: number;

プロパティ値

注釈

API セット: WordApiDesktop 1.3

図形からの影の垂直方向のオフセット (ポイント単位) を指定します。 正の値を指定すると、影は図形の先頭にオフセットされます。負の値を指定すると、一番下にオフセットされます。

offsetY: number;

プロパティ値

注釈

API セット: WordApiDesktop 1.3

図形を回転させるときに影を回転させるかどうかを指定します。

rotateWithShape: boolean;

プロパティ値

注釈

API セット: WordApiDesktop 1.3

影の幅を指定します。

size: number;

プロパティ値

注釈

API セット: WordApiDesktop 1.3

図形に適用する影の書式の種類を指定します。

style: Word.ShadowStyle | "Mixed" | "OuterShadow" | "InnerShadow";

プロパティ値

注釈

API セット: WordApiDesktop 1.3

影の透明度を、0.0 (不透明) から 1.0 (クリア) の値で指定します。

transparency: number;

プロパティ値

注釈

API セット: WordApiDesktop 1.3

形状の影の種類を指定します。

type: Word.ShadowType | "Mixed" | "Type1" | "Type2" | "Type3" | "Type4" | "Type5" | "Type6" | "Type7" | "Type8" | "Type9" | "Type10" | "Type11" | "Type12" | "Type13" | "Type14" | "Type15" | "Type16" | "Type17" | "Type18" | "Type19" | "Type20" | "Type21" | "Type22" | "Type23" | "Type24" | "Type25" | "Type26" | "Type27" | "Type28" | "Type29" | "Type30" | "Type31" | "Type32" | "Type33" | "Type34" | "Type35" | "Type36" | "Type37" | "Type38" | "Type39" | "Type40" | "Type41" | "Type42" | "Type43";

プロパティ値

注釈

API セット: WordApiDesktop 1.3

影の水平方向のオフセットをポイント数で変更します。 増分: 調整するポイントの数。

incrementOffsetX(increment: number): void;

パラメーター

返品

注釈

API セット: WordApiDesktop 1.3

影の垂直方向の相対位置を、指定したポイント数だけ変更します。 増分: 調整するポイントの数。

incrementOffsetY(increment: number): void;

パラメーター

返品

注釈

API セット: WordApiDesktop 1.3

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

load(options?: Word.Interfaces.ShadowFormatLoadOptions): Word.ShadowFormat;

パラメーター

返品

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

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

パラメーター

返品

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

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

パラメーター

返品

オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクト、または同じ型の別の API オブジェクトを渡すことができます。

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

パラメーター

返品

既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。

set(properties: Word.ShadowFormat): void;

パラメーター

返品

API オブジェクトが JSON.stringify() に渡されるときに、より有用な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (次に、JSON.stringify渡されたオブジェクトの toJSON メソッドを呼び出します)。元の Word.ShadowFormat オブジェクトが API オブジェクトであるのに対し、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Word.Interfaces.ShadowFormatData と型指定) を返します。

toJSON(): Word.Interfaces.ShadowFormatData;

返品

ドキュメントの環境変更に基づいて自動的に調整する目的でオブジェクトを追跡します。 この呼び出しは、 context.trackedObjects.add(thisObject) の短縮形です。 このオブジェクトを .sync 呼び出しと ".run" バッチの連続実行の外部で使用していて、プロパティを設定したり、オブジェクトでメソッドを呼び出したりするときに "InvalidObjectPath" エラーが発生する場合は、オブジェクトが最初に作成されたときに、追跡対象のオブジェクト コレクションにオブジェクトを追加する必要があります。 このオブジェクトがコレクションの一部である場合は、親コレクションも追跡する必要があります。

track(): Word.ShadowFormat;

返品

前に追跡されていた場合、このオブジェクトに関連付けられているメモリを解放します。 この呼び出しは、 context.trackedObjects.remove(thisObject) の省略形です。 追跡対象オブジェクトが多いとホスト アプリケーションの動作が遅くなります。追加したオブジェクトが不要になったら、必ずそれを解放してください。 メモリ リリースを有効にする前に、 context.sync() を呼び出す必要があります。

untrack(): Word.ShadowFormat;

返品