Excel.RangeBorderCollection class

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

context: RequestContext;

プロパティ値

コレクションに含まれる境界線オブジェクトの数。

readonly count: number;

プロパティ値

注釈

API セット: ExcelApi 1.1

このコレクション内に読み込まれた子アイテムを取得します。

readonly items: Excel.RangeBorder[];

プロパティ値

範囲の境界線の色を明るくするか暗くする double を指定します。 値は -1 (最も暗い) から 1 (最も明るい) の間です。元の色は 0 です。 null値は、罫線コレクション全体に統一されたtintAndShade設定がないことを示します。

tintAndShade: number;

プロパティ値

注釈

API セット: ExcelApi 1.9

オブジェクトの名前を使用して、境界線オブジェクトを取得します。

getItem(index: Excel.BorderIndex): Excel.RangeBorder;

パラメーター

返品

注釈

API セット: ExcelApi 1.1

例

await Excel.run(async (context) => {
    const sheetName = "Sheet1";
    const rangeAddress = "A1:F8";
    const worksheet = context.workbook.worksheets.getItem(sheetName);
    const range = worksheet.getRange(rangeAddress);
    const border = range.format.borders.getItem(Excel.BorderIndex.edgeTop);
    border.load('style');
    await context.sync();

    console.log(border.style);
});

オブジェクトの名前を使用して、境界線オブジェクトを取得します。

getItem(index: "EdgeTop" | "EdgeBottom" | "EdgeLeft" | "EdgeRight" | "InsideVertical" | "InsideHorizontal" | "DiagonalDown" | "DiagonalUp"): Excel.RangeBorder;

パラメーター

返品

注釈

API セット: ExcelApi 1.1

オブジェクトのインデックスを使用して、境界線オブジェクトを取得します。

getItemAt(index: number): Excel.RangeBorder;

パラメーター

返品

注釈

API セット: ExcelApi 1.1

例

await Excel.run(async (context) => { 
    const sheetName = "Sheet1";
    const rangeAddress = "A1:F8";
    const worksheet = context.workbook.worksheets.getItem(sheetName);
    const range = worksheet.getRange(rangeAddress);
    const border = range.format.borders.getItemAt(0);
    border.load('sideIndex');
    await context.sync();
    
    console.log(border.sideIndex);
});

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

load(options?: Excel.Interfaces.RangeBorderCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.RangeBorderCollection;

パラメーター

返品

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

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

パラメーター

返品

例

await Excel.run(async (context) => { 
    const sheetName = "Sheet1";
    const rangeAddress = "A1:F8";
    const worksheet = context.workbook.worksheets.getItem(sheetName);
    const range = worksheet.getRange(rangeAddress);
    const borders = range.format.borders;
    borders.load('items');
    await context.sync();
    
    console.log(borders.count);
    for (let i = 0; i < borders.items.length; i++) {
        console.log(borders.items[i].sideIndex);
    }
});

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

load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.RangeBorderCollection;

パラメーター

返品

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

toJSON(): Excel.Interfaces.RangeBorderCollectionData;

返品