Excel.CellPropertiesLoadOptions interface

Paket:

excel

Stellt dar, welche Zelleigenschaften geladen werden sollen, wenn sie als Teil einer "range.getCellProperties"-Methode verwendet werden.

API-Satz: ExcelApi 1.9

Hinweise

Verwendet von

• Excel.Range: getCellProperties, getDisplayedCellProperties

Eigenschaften

address	Gibt an, ob auf die address Eigenschaft geladen werden soll. API-Satz: ExcelApi 1.9
addressLocal	Gibt an, ob auf die addressLocal Eigenschaft geladen werden soll. API-Satz: ExcelApi 1.9
format	Gibt an, ob auf die format Eigenschaft geladen werden soll. API-Satz: ExcelApi 1.9
hidden	Gibt an, ob auf die hidden Eigenschaft geladen werden soll. API-Satz: ExcelApi 1.9
hyperlink	Gibt an, ob auf die hyperlink Eigenschaft geladen werden soll. API-Satz: ExcelApi 1.9
style	Gibt an, ob auf die style Eigenschaft geladen werden soll. API-Satz: ExcelApi 1.9
textRuns	Gibt an, ob auf die textRuns Eigenschaft geladen werden soll.

Details zur Eigenschaft

address

Gibt an, ob auf 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();

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

Gibt an, ob auf die addressLocal Eigenschaft geladen werden soll.

API-Satz: ExcelApi 1.9

addressLocal?: boolean;

Eigenschaftswert

boolean

format

Gibt an, ob auf die format Eigenschaft geladen werden soll.

API-Satz: ExcelApi 1.9

format?: Excel.CellPropertiesFormatLoadOptions;

Eigenschaftswert

Excel.CellPropertiesFormatLoadOptions

hidden

Gibt an, ob auf die hidden Eigenschaft geladen werden soll.

API-Satz: ExcelApi 1.9

hidden?: boolean;

Eigenschaftswert

boolean

hyperlink

Gibt an, ob auf die hyperlink Eigenschaft geladen werden soll.

API-Satz: ExcelApi 1.9

hyperlink?: boolean;

Eigenschaftswert

boolean

style

Gibt an, ob auf die style Eigenschaft geladen werden soll.

API-Satz: ExcelApi 1.9

style?: boolean;

Eigenschaftswert

boolean

textRuns

Gibt an, ob auf die textRuns Eigenschaft geladen werden soll.

textRuns?: boolean;

Eigenschaftswert

boolean

Hinweise

API-Satz: ExcelApi 1.18