Excel.CellPropertiesLoadOptions interface

Paquete:

excel

Representa las propiedades de celda que se van a cargar cuando se usan como parte de un método "range.getCellProperties".

[ Conjunto de API: ExcelApi 1.9 ]

Propiedades

address	Especifica si se va a cargar en la address propiedad . [ Conjunto de API: ExcelApi 1.9 ]
addressLocal	Especifica si se va a cargar en la addressLocal propiedad . [ Conjunto de API: ExcelApi 1.9 ]
format	Especifica si se va a cargar en la format propiedad . [ Conjunto de API: ExcelApi 1.9 ]
hidden	Especifica si se va a cargar en la hidden propiedad . [ Conjunto de API: ExcelApi 1.9 ]
hyperlink	Especifica si se va a cargar en la hyperlink propiedad . [ Conjunto de API: ExcelApi 1.9 ]
style	Especifica si se va a cargar en la style propiedad . [ Conjunto de API: ExcelApi 1.9 ]
textRuns	Especifica si se va a cargar en la textRuns propiedad . [ Conjunto de API: RangeTextRun ]

Detalles de las propiedades

address

Especifica si se va a cargar en la address propiedad .

[ Conjunto de API: ExcelApi 1.9 ]

address?: boolean;

Valor de propiedad

boolean

Ejemplos

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

Especifica si se va a cargar en la addressLocal propiedad .

[ Conjunto de API: ExcelApi 1.9 ]

addressLocal?: boolean;

Valor de propiedad

boolean

format

Especifica si se va a cargar en la format propiedad .

[ Conjunto de API: ExcelApi 1.9 ]

format?: Excel.CellPropertiesFormatLoadOptions;

Valor de propiedad

Excel.CellPropertiesFormatLoadOptions

hidden

Especifica si se va a cargar en la hidden propiedad .

[ Conjunto de API: ExcelApi 1.9 ]

hidden?: boolean;

Valor de propiedad

boolean

hyperlink

Especifica si se va a cargar en la hyperlink propiedad .

[ Conjunto de API: ExcelApi 1.9 ]

hyperlink?: boolean;

Valor de propiedad

boolean

style

Especifica si se va a cargar en la style propiedad .

[ Conjunto de API: ExcelApi 1.9 ]

style?: boolean;

Valor de propiedad

boolean

textRuns

Especifica si se va a cargar en la textRuns propiedad .

[ Conjunto de API: RangeTextRun ]

textRuns?: boolean;

Valor de propiedad

boolean