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 свойство .

Сведения о свойстве

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 свойство .

textRuns?: boolean;

Значение свойства

boolean

Комментарии

[ Набор API: ExcelApi 1.18 ]