Excel.RangeFill class

背景色を表す HTML カラー コード。形式は #RRGGBB (例: "FFA500")、または名前付き HTML カラー (例: "オレンジ") です

color: string;

プロパティ値

注釈

API セット: ExcelApi 1.1

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

context: RequestContext;

プロパティ値

範囲のパターン。 詳細は「Excel.FillPattern」をご覧ください。 LinearGradient と RectangularGradient はサポートされていません。 null値は、範囲全体に統一されたパターン設定がないことを示します。

pattern: Excel.FillPattern | "None" | "Solid" | "Gray50" | "Gray75" | "Gray25" | "Horizontal" | "Vertical" | "Down" | "Up" | "Checker" | "SemiGray75" | "LightHorizontal" | "LightVertical" | "LightDown" | "LightUp" | "Grid" | "CrissCross" | "Gray16" | "Gray8" | "LinearGradient" | "RectangularGradient";

プロパティ値

注釈

API セット: ExcelApi 1.9

範囲パターンの色を表す HTML カラー コード。形式は #RRGGBB (例: "FFA500")、または名前付き HTML カラー (例: "オレンジ") です。

patternColor: string;

プロパティ値

注釈

API セット: ExcelApi 1.9

範囲塗りつぶしのパターンの色を明るくするか暗くする倍精度浮動小数点数を指定します。 値は -1 (最も暗い) から 1 (最も明るい) の間です。元の色は 0 です。 null値は、範囲に統一されたpatternTintAndShade設定がないことを示します。

patternTintAndShade: number;

プロパティ値

注釈

API セット: ExcelApi 1.9

範囲塗りつぶしの色を明るくするか暗くする double を指定します。 値は -1 (最も暗い) から 1 (最も明るい) の間です。元の色は 0 です。 null値は、範囲に統一されたtintAndShade設定がないことを示します。

tintAndShade: number;

プロパティ値

注釈

API セット: ExcelApi 1.9

範囲の背景をリセットします。

clear(): void;

返品

注釈

API セット: ExcelApi 1.1

例

await Excel.run(async (context) => { 
    const sheetName = "Sheet1";
    const rangeAddress = "F:G";
    const worksheet = context.workbook.worksheets.getItem(sheetName);
    const range = worksheet.getRange(rangeAddress);
    const rangeFill = range.format.fill;
    rangeFill.clear();
    await context.sync(); 
});

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

load(options?: Excel.Interfaces.RangeFillLoadOptions): Excel.RangeFill;

パラメーター

返品

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

load(propertyNames?: string | string[]): Excel.RangeFill;

パラメーター

返品

例

await Excel.run(async (context) => { 
    const sheetName = "Sheet1";
    const rangeAddress = "F:G";
    const worksheet = context.workbook.worksheets.getItem(sheetName);
    const range = worksheet.getRange(rangeAddress);
    const rangeFill = range.format.fill;
    rangeFill.load('color');
    await context.sync();
    console.log(rangeFill.color);
});

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

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.RangeFill;

パラメーター

返品

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

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

パラメーター

返品

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

set(properties: Excel.RangeFill): void;

パラメーター

返品

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

toJSON(): Excel.Interfaces.RangeFillData;

返品