Excel.CellPropertiesLoadOptions interface

Пакет:

excel

Представляет, какие свойства ячейки необходимо загрузить при использовании в составе метода "range.getCellProperties".

Набор API: ExcelApi 1.9

Комментарии

Используется

• Excel.Range: getCellProperties, getDisplayedCellProperties

Свойства

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

    // Get only the properties requested in this load-options object.
    const propertiesToGet: Excel.CellPropertiesLoadOptions = {
        address: true,
        format: {
            fill: {
                color: true
            },
            font: {
                bold: true,
                color: true
            }
        },
        style: true
    };
    const cellProperties = cell.getCellProperties(propertiesToGet);

    await context.sync();
    const activeCellProperties: Excel.CellProperties = cellProperties.value[0][0];
    console.log(JSON.stringify(activeCellProperties, null, 2));
});

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