Excel.CellPropertiesLoadOptions interface

  • Referenz
Paket:
excel

Gibt an, welche Zelleneigenschaften geladen werden sollen, wenn sie als Teil einer Range.getCellProperties-Methode verwendet werden.

[ API-Satz: ExcelApi 1.9 ]

Eigenschaften

address

Gibt an, ob für die address -Eigenschaft geladen werden soll.

[ API-Satz: ExcelApi 1.9 ]
addressLocal

Gibt an, ob für die addressLocal -Eigenschaft geladen werden soll.

[ API-Satz: ExcelApi 1.9 ]
format

Gibt an, ob für die format -Eigenschaft geladen werden soll.

[ API-Satz: ExcelApi 1.9 ]
hidden

Gibt an, ob für die hidden -Eigenschaft geladen werden soll.

[ API-Satz: ExcelApi 1.9 ]
hyperlink

Gibt an, ob für die hyperlink -Eigenschaft geladen werden soll.

[ API-Satz: ExcelApi 1.9 ]
style

Gibt an, ob für die style -Eigenschaft geladen werden soll.

[ API-Satz: ExcelApi 1.9 ]

Details zur Eigenschaft

address

Gibt an, ob für die address -Eigenschaft geladen werden soll.

[ API-Satz: ExcelApi 1.9 ]

address?: boolean;

Eigenschaftswert

boolean

Beispiele

// 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

Gibt an, ob für die addressLocal -Eigenschaft geladen werden soll.

[ API-Satz: ExcelApi 1.9 ]

addressLocal?: boolean;

Eigenschaftswert

boolean

format

Gibt an, ob für die format -Eigenschaft geladen werden soll.

[ API-Satz: ExcelApi 1.9 ]

format?: Excel.CellPropertiesFormatLoadOptions;

Eigenschaftswert

Excel.CellPropertiesFormatLoadOptions

hidden

Gibt an, ob für die hidden -Eigenschaft geladen werden soll.

[ API-Satz: ExcelApi 1.9 ]

hidden?: boolean;

Eigenschaftswert

boolean

Gibt an, ob für die hyperlink -Eigenschaft geladen werden soll.

[ API-Satz: ExcelApi 1.9 ]

hyperlink?: boolean;

Eigenschaftswert

boolean

style

Gibt an, ob für die style -Eigenschaft geladen werden soll.

[ API-Satz: ExcelApi 1.9 ]

style?: boolean;

Eigenschaftswert

boolean