Excel.CellPropertiesLoadOptions interface

パッケージ:

excel

"range.getCellProperties" メソッドの一部として使用する場合に読み込むセル プロパティを表します。

[ API セット: ExcelApi 1.9 ]

プロパティ

address	address プロパティに読み込むかどうかを指定します。 [ API セット: ExcelApi 1.9 ]
addressLocal	addressLocal プロパティに読み込むかどうかを指定します。 [ API セット: ExcelApi 1.9 ]
format	format プロパティに読み込むかどうかを指定します。 [ API セット: ExcelApi 1.9 ]
hidden	hidden プロパティに読み込むかどうかを指定します。 [ API セット: ExcelApi 1.9 ]
hyperlink	hyperlink プロパティに読み込むかどうかを指定します。 [ API セット: ExcelApi 1.9 ]
style	style プロパティに読み込むかどうかを指定します。 [ API セット: ExcelApi 1.9 ]
textRuns	textRuns プロパティに読み込むかどうかを指定します。 [ API set: RangeTextRun ]

プロパティの詳細

address

address プロパティに読み込むかどうかを指定します。

[ API セット: ExcelApi 1.9 ]

address?: boolean;

プロパティ値

boolean

例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/cell-properties.yaml

await Excel.run(async (context) => {
    const cell = context.workbook.getActiveCell();

    // Define the cell properties to get by setting the matching LoadOptions to true.
    const propertiesToGet = cell.getCellProperties({
        address: true,
        format: {
            fill: {
                color: true
            },
            font: {
                color: true
            }
        },
        style: true
    });

    // Sync to get the data from the workbook.
    await context.sync();
    const cellProperties = propertiesToGet.value[0][0];
    console.log(
        `Address: ${cellProperties.address}\nStyle: ${cellProperties.style}\nFill Color: ${cellProperties.format.fill.color}\nFont Color: ${cellProperties.format.font.color}`);
});

addressLocal

addressLocal プロパティに読み込むかどうかを指定します。

[ API セット: ExcelApi 1.9 ]

addressLocal?: boolean;

プロパティ値

boolean

format

format プロパティに読み込むかどうかを指定します。

[ API セット: ExcelApi 1.9 ]

format?: Excel.CellPropertiesFormatLoadOptions;

プロパティ値

Excel.CellPropertiesFormatLoadOptions

hidden

hidden プロパティに読み込むかどうかを指定します。

[ API セット: ExcelApi 1.9 ]

hidden?: boolean;

プロパティ値

boolean

hyperlink

hyperlink プロパティに読み込むかどうかを指定します。

[ API セット: ExcelApi 1.9 ]

hyperlink?: boolean;

プロパティ値

boolean

style

style プロパティに読み込むかどうかを指定します。

[ API セット: ExcelApi 1.9 ]

style?: boolean;

プロパティ値

boolean

textRuns

textRuns プロパティに読み込むかどうかを指定します。

[ API set: RangeTextRun ]

textRuns?: boolean;

プロパティ値

boolean