Word.FillFormat class

塗りつぶしの背景色を表す ColorFormat オブジェクトを返します。

readonly backgroundColor: Word.ColorFormat;

プロパティ値

注釈

API セット: WordApiDesktop 1.3

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

context: RequestContext;

プロパティ値

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

readonly foregroundColor: Word.ColorFormat;

プロパティ値

注釈

API セット: WordApiDesktop 1.3

グラデーションの塗りつぶしの角度を指定します。 有効な値の範囲は 0 から 359.9 です。

gradientAngle: number;

プロパティ値

注釈

API セット: WordApiDesktop 1.3

グラデーションの色の種類を取得します。

readonly gradientColorType: Word.GradientColorType | "Mixed" | "OneColor" | "TwoColors" | "PresetColors" | "MultiColor";

プロパティ値

注釈

API セット: WordApiDesktop 1.3

単色グラデーションの塗りつぶしの暗さまたは明るさを返します。 値 0 は、黒が図形の前景色と混合されてグラデーションが形成されることを意味します。 値 1 は白が混ざっていることを意味します。 0 から 1 までの値は、前景色の暗い色合いまたは明るい色合いが混ざっていることを意味します。

readonly gradientDegree: number;

プロパティ値

注釈

API セット: WordApiDesktop 1.3

塗りつぶしのグラデーション スタイルを返します。

readonly gradientStyle: Word.GradientStyle | "Mixed" | "Horizontal" | "Vertical" | "DiagonalUp" | "DiagonalDown" | "FromCorner" | "FromTitle" | "FromCenter";

プロパティ値

注釈

API セット: WordApiDesktop 1.3

ほとんどのグラデーション塗りつぶしに対して、塗りつぶしのグラデーションバリアントを 1 から 4 の整数値として返します。

readonly gradientVariant: number;

プロパティ値

注釈

API セット: WordApiDesktop 1.3

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

isVisible: boolean;

プロパティ値

注釈

API セット: WordApiDesktop 1.3

塗りつぶしまたは線に適用されるパターンを表す PatternType 値を返します。

readonly pattern: Word.PatternType | "Mixed" | "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" | "Percent80" | "Percent90" | "DarkHorizontal" | "DarkVertical" | "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "SmallCheckerBoard" | "Trellis" | "LightHorizontal" | "LightVertical" | "LightDownwardDiagonal" | "LightUpwardDiagonal" | "SmallGrid" | "DottedDiamond" | "WideDownwardDiagonal" | "WideUpwardDiagonal" | "DashedUpwardDiagonal" | "DashedDownwardDiagonal" | "NarrowVertical" | "NarrowHorizontal" | "DashedVertical" | "DashedHorizontal" | "LargeConfetti" | "LargeGrid" | "HorizontalBrick" | "LargeCheckerBoard" | "SmallConfetti" | "ZigZag" | "SolidDiamond" | "DiagonalBrick" | "OutlinedDiamond" | "Plaid" | "Sphere" | "Weave" | "DottedGrid" | "Divot" | "Shingle" | "Wave" | "Horizontal" | "Vertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" | "DiagonalCross";

プロパティ値

注釈

API セット: WordApiDesktop 1.3

塗りつぶしにプリセットされたグラデーションの種類を返します。

readonly presetGradientType: Word.PresetGradientType | "Mixed" | "EarlySunset" | "LateSunset" | "Nightfall" | "Daybreak" | "Horizon" | "Desert" | "Ocean" | "CalmWater" | "Fire" | "Fog" | "Moss" | "Peacock" | "Wheat" | "Parchment" | "Mahogany" | "Rainbow" | "RainbowII" | "Gold" | "GoldII" | "Brass" | "Chrome" | "ChromeII" | "Silver" | "Sapphire";

プロパティ値

注釈

API セット: WordApiDesktop 1.3

プリセット テクスチャを取得します。

readonly presetTexture: Word.PresetTexture | "Mixed" | "Papyrus" | "Canvas" | "Denim" | "WovenMat" | "WaterDroplets" | "PaperBag" | "FishFossil" | "Sand" | "GreenMarble" | "WhiteMarble" | "BrownMarble" | "Granite" | "Newsprint" | "RecycledPaper" | "Parchment" | "Stationery" | "BlueTissuePaper" | "PinkTissuePaper" | "PurpleMesh" | "Bouquet" | "Cork" | "Walnut" | "Oak" | "MediumWood";

プロパティ値

注釈

API セット: WordApiDesktop 1.3

塗りつぶしが図形と共に回転するかどうかを指定します。

rotateWithObject: boolean;

プロパティ値

注釈

API セット: WordApiDesktop 1.3

テクスチャの塗りつぶしを並べて表示する場合の配置 (座標グリッドの原点) を表します。

textureAlignment: Word.TextureAlignment | "Mixed" | "TopLeft" | "Top" | "TopRight" | "Left" | "Center" | "Right" | "BottomLeft" | "Bottom" | "BottomRight";

プロパティ値

注釈

API セット: WordApiDesktop 1.3

テクスチャ フィルの水平方向のスケーリング 係数を指定します。

textureHorizontalScale: number;

プロパティ値

注釈

API セット: WordApiDesktop 1.3

塗りつぶしのカスタム テクスチャ ファイルの名前を返します。

readonly textureName: string;

プロパティ値

注釈

API セット: WordApiDesktop 1.3

原点からのテクスチャの水平方向のオフセットをポイント単位で指定します。

textureOffsetX: number;

プロパティ値

注釈

API セット: WordApiDesktop 1.3

テクスチャの垂直方向のオフセットを指定します。

textureOffsetY: number;

プロパティ値

注釈

API セット: WordApiDesktop 1.3

テクスチャをタイル化するかどうかを指定します。

textureTile: boolean;

プロパティ値

注釈

API セット: WordApiDesktop 1.3

塗りつぶしのテクスチャの種類を返します。

readonly textureType: Word.TextureType | "Mixed" | "Preset" | "UserDefined";

プロパティ値

注釈

API セット: WordApiDesktop 1.3

テクスチャ塗りつぶしの垂直方向のスケーリング係数を、0.0 から 1.0 までの値で指定します。

textureVerticalScale: number;

プロパティ値

注釈

API セット: WordApiDesktop 1.3

図形の塗りつぶしの透明度を、0.0 (不透明) から 1.0 (クリア) の値で指定します。

transparency: number;

プロパティ値

注釈

API セット: WordApiDesktop 1.3

塗りつぶし形式の種類を取得します。

readonly type: Word.FillType | "Mixed" | "Solid" | "Patterned" | "Gradient" | "Textured" | "Background" | "Picture";

プロパティ値

注釈

API セット: WordApiDesktop 1.3

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

load(options?: Word.Interfaces.FillFormatLoadOptions): Word.FillFormat;

パラメーター

返品

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

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

パラメーター

返品

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

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

パラメーター

返品

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

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

パラメーター

返品

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

set(properties: Word.FillFormat): void;

パラメーター

返品

塗りつぶしを単色グラデーションに設定します。

setOneColorGradient(style: Word.GradientStyle, variant: number, degree: number): void;

パラメーター

返品

注釈

API セット: WordApiDesktop 1.3

塗りつぶしを単色グラデーションに設定します。

setOneColorGradient(style: "Mixed" | "Horizontal" | "Vertical" | "DiagonalUp" | "DiagonalDown" | "FromCorner" | "FromTitle" | "FromCenter", variant: number, degree: number): void;

パラメーター

返品

注釈

API セット: WordApiDesktop 1.3

塗りつぶしをパターンに設定します。

setPatterned(pattern: Word.PatternType): void;

パラメーター

返品

注釈

API セット: WordApiDesktop 1.3

塗りつぶしをパターンに設定します。

setPatterned(pattern: "Mixed" | "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" | "Percent80" | "Percent90" | "DarkHorizontal" | "DarkVertical" | "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "SmallCheckerBoard" | "Trellis" | "LightHorizontal" | "LightVertical" | "LightDownwardDiagonal" | "LightUpwardDiagonal" | "SmallGrid" | "DottedDiamond" | "WideDownwardDiagonal" | "WideUpwardDiagonal" | "DashedUpwardDiagonal" | "DashedDownwardDiagonal" | "NarrowVertical" | "NarrowHorizontal" | "DashedVertical" | "DashedHorizontal" | "LargeConfetti" | "LargeGrid" | "HorizontalBrick" | "LargeCheckerBoard" | "SmallConfetti" | "ZigZag" | "SolidDiamond" | "DiagonalBrick" | "OutlinedDiamond" | "Plaid" | "Sphere" | "Weave" | "DottedGrid" | "Divot" | "Shingle" | "Wave" | "Horizontal" | "Vertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" | "DiagonalCross"): void;

パラメーター

返品

注釈

API セット: WordApiDesktop 1.3

塗りつぶしをプリセット グラデーションに設定します。 グラデーション スタイル。グラデーションのバリアント。 1 から 4 の値を指定できます。プリセット グラデーションの種類。

setPresetGradient(style: Word.GradientStyle, variant: number, presetGradientType: Word.PresetGradientType): void;

パラメーター

返品

注釈

API セット: WordApiDesktop 1.3

塗りつぶしをプリセット グラデーションに設定します。 グラデーション スタイル。グラデーションのバリアント。 1 から 4 の値を指定できます。プリセット グラデーションの種類。

setPresetGradient(style: "Mixed" | "Horizontal" | "Vertical" | "DiagonalUp" | "DiagonalDown" | "FromCorner" | "FromTitle" | "FromCenter", variant: number, presetGradientType: "Mixed" | "EarlySunset" | "LateSunset" | "Nightfall" | "Daybreak" | "Horizon" | "Desert" | "Ocean" | "CalmWater" | "Fire" | "Fog" | "Moss" | "Peacock" | "Wheat" | "Parchment" | "Mahogany" | "Rainbow" | "RainbowII" | "Gold" | "GoldII" | "Brass" | "Chrome" | "ChromeII" | "Silver" | "Sapphire"): void;

パラメーター

返品

注釈

API セット: WordApiDesktop 1.3

塗りつぶしをプリセット テクスチャに設定します。

setPresetTextured(presetTexture: Word.PresetTexture): void;

パラメーター

返品

注釈

API セット: WordApiDesktop 1.3

塗りつぶしをプリセット テクスチャに設定します。

setPresetTextured(presetTexture: "Mixed" | "Papyrus" | "Canvas" | "Denim" | "WovenMat" | "WaterDroplets" | "PaperBag" | "FishFossil" | "Sand" | "GreenMarble" | "WhiteMarble" | "BrownMarble" | "Granite" | "Newsprint" | "RecycledPaper" | "Parchment" | "Stationery" | "BlueTissuePaper" | "PinkTissuePaper" | "PurpleMesh" | "Bouquet" | "Cork" | "Walnut" | "Oak" | "MediumWood"): void;

パラメーター

返品

注釈

API セット: WordApiDesktop 1.3

塗りつぶしを 2 色のグラデーションに設定します。

setTwoColorGradient(style: Word.GradientStyle, variant: number): void;

パラメーター

返品

注釈

API セット: WordApiDesktop 1.3

塗りつぶしを 2 色のグラデーションに設定します。

setTwoColorGradient(style: "Mixed" | "Horizontal" | "Vertical" | "DiagonalUp" | "DiagonalDown" | "FromCorner" | "FromTitle" | "FromCenter", variant: number): void;

パラメーター

返品

注釈

API セット: WordApiDesktop 1.3

塗りつぶしを均一の色に設定します。

solid(): void;

返品

注釈

API セット: WordApiDesktop 1.3

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

toJSON(): Word.Interfaces.FillFormatData;

返品

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

track(): Word.FillFormat;

返品

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

untrack(): Word.FillFormat;

返品