Excel.RangeBorder class

オブジェクトの輪郭を表します。

Extends

注釈

[ API セット: ExcelApi 1.1 ]

プロパティ

color

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

context

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

sideIndex

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

style

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

tintAndShade

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

weight

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

メソッド

load(options)

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

load(propertyNames)

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

load(propertyNamesAndPaths)

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

set(properties, options)

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

set(properties)

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

toJSON()

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

プロパティの詳細

color

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

color: string;

プロパティ値

string

注釈

[ API セット: ExcelApi 1.1 ]

context

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

context: RequestContext;

プロパティ値

sideIndex

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

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

プロパティ値

Excel.BorderIndex | "EdgeTop" | "EdgeBottom" | "EdgeLeft" | "EdgeRight" | "InsideVertical" | "InsideHorizontal" | "DiagonalDown" | "DiagonalUp"

注釈

[ API セット: ExcelApi 1.1 ]

style

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

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

プロパティ値

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(); 
});

tintAndShade

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

tintAndShade: number;

プロパティ値

number

注釈

[ API セット: ExcelApi 1.9 ]

weight

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

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

プロパティ値

Excel.BorderWeight | "Hairline" | "Thin" | "Medium" | "Thick"

注釈

[ API セット: ExcelApi 1.1 ]

メソッドの詳細

load(options)

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

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

パラメーター

options
Excel.Interfaces.RangeBorderLoadOptions

読み込むオブジェクトのプロパティのオプションを提供します。

戻り値

load(propertyNames)

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

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

パラメーター

propertyNames

string | string[]

読み込むプロパティを指定するコンマ区切り文字列または文字列の配列。

戻り値

load(propertyNamesAndPaths)

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

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

パラメーター

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select は読み込むプロパティを指定するコンマ区切りの文字列で、 propertyNamesAndPaths.expand は読み込むナビゲーション プロパティを指定するコンマ区切りの文字列です。

戻り値

set(properties, options)

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

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

パラメーター

properties
Excel.Interfaces.RangeBorderUpdateData

メソッドが呼び出されるオブジェクトのプロパティに等形的に構造化されたプロパティを持つ JavaScript オブジェクト。

options
OfficeExtension.UpdateOptions

properties オブジェクトが読み取り専用プロパティを設定しようとした場合にエラーを抑制するオプションを提供します。

戻り値

void

set(properties)

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

set(properties: Excel.RangeBorder): void;

パラメーター

properties
Excel.RangeBorder

戻り値

void

toJSON()

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

toJSON(): Excel.Interfaces.RangeBorderData;

戻り値