Excel.RangeBorder class

境界線の色を表す HTML カラー コードは、#RRGGBB 形式 (例: "FFA500")、または名前付き HTML の色 (例: "オレンジ") として表されます。

color: string;

プロパティ値

注釈

[ API セット: ExcelApi 1.1 ]

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

context: RequestContext;

プロパティ値

罫線の特定の辺を表す定数値。 詳細は「Excel.BorderIndex」をご覧ください。

readonly sideIndex: Excel.BorderIndex | "EdgeTop" | "EdgeBottom" | "EdgeLeft" | "EdgeRight" | "InsideVertical" | "InsideHorizontal" | "DiagonalDown" | "DiagonalUp";

プロパティ値

注釈

[ API セット: ExcelApi 1.1 ]

罫線の線スタイルを指定する、線スタイル定数のいずれか 1 つ。 詳細は「Excel.BorderLineStyle」をご覧ください。

style: Excel.BorderLineStyle | "None" | "Continuous" | "Dash" | "DashDot" | "DashDotDot" | "Dot" | "Double" | "SlantDashDot";

プロパティ値

注釈

[ API セット: ExcelApi 1.1 ]

例

// Add grid borders around the range.
await Excel.run(async (context) => { 
    const sheetName = "Sheet1";
    const rangeAddress = "A1:F8";
    const range = context.workbook.worksheets.getItem(sheetName).getRange(rangeAddress);
    range.format.borders.getItem('InsideHorizontal').style = 'Continuous';
    range.format.borders.getItem('InsideVertical').style = 'Continuous';
    range.format.borders.getItem('EdgeBottom').style = 'Continuous';
    range.format.borders.getItem('EdgeLeft').style = 'Continuous';
    range.format.borders.getItem('EdgeRight').style = 'Continuous';
    range.format.borders.getItem('EdgeTop').style = 'Continuous';
    await context.sync(); 
});

範囲の境界線の色を明るくまたは暗くする二重を指定します。値は -1 (最も暗い) から 1 (最も明るい) の間で、元の色の場合は 0 です。 null値は、境界線に均一なtintAndShade設定がないことを示します。

tintAndShade: number;

プロパティ値

注釈

[ API セット: ExcelApi 1.9 ]

範囲周辺の罫線の太さを指定します。 詳細は「Excel.BorderWeight」をご覧ください。

weight: Excel.BorderWeight | "Hairline" | "Thin" | "Medium" | "Thick";

プロパティ値

注釈

[ API セット: ExcelApi 1.1 ]

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

load(options?: Excel.Interfaces.RangeBorderLoadOptions): Excel.RangeBorder;

パラメーター

戻り値

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

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

パラメーター

戻り値

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

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

パラメーター

戻り値

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

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

パラメーター

戻り値

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

set(properties: Excel.RangeBorder): void;

パラメーター

戻り値

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

toJSON(): Excel.Interfaces.RangeBorderData;

戻り値