Excel.CellPropertiesLoadOptions interface

Pacote:

excel

Representa quais propriedades de célula carregar, quando usadas como parte de um método "range.getCellProperties".

[ Conjunto de API: ExcelApi 1.9 ]

Propriedades

address	Especifica se é necessário carregar na address propriedade. [ Conjunto de API: ExcelApi 1.9 ]
addressLocal	Especifica se é necessário carregar na addressLocal propriedade. [ Conjunto de API: ExcelApi 1.9 ]
format	Especifica se é necessário carregar na format propriedade. [ Conjunto de API: ExcelApi 1.9 ]
hidden	Especifica se é necessário carregar na hidden propriedade. [ Conjunto de API: ExcelApi 1.9 ]
hyperlink	Especifica se é necessário carregar na hyperlink propriedade. [ Conjunto de API: ExcelApi 1.9 ]
style	Especifica se é necessário carregar na style propriedade. [ Conjunto de API: ExcelApi 1.9 ]

Detalhes da propriedade

address

Especifica se é necessário carregar na address propriedade.

[ Conjunto de API: ExcelApi 1.9 ]

address?: boolean;

Valor da propriedade

boolean

Exemplos

// 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 se é necessário carregar na addressLocal propriedade.

[ Conjunto de API: ExcelApi 1.9 ]

addressLocal?: boolean;

Valor da propriedade

boolean

format

Especifica se é necessário carregar na format propriedade.

[ Conjunto de API: ExcelApi 1.9 ]

format?: Excel.CellPropertiesFormatLoadOptions;

Valor da propriedade

Excel.CellPropertiesFormatLoadOptions

hidden

Especifica se é necessário carregar na hidden propriedade.

[ Conjunto de API: ExcelApi 1.9 ]

hidden?: boolean;

Valor da propriedade

boolean

hyperlink

Especifica se é necessário carregar na hyperlink propriedade.

[ Conjunto de API: ExcelApi 1.9 ]

hyperlink?: boolean;

Valor da propriedade

boolean

style

Especifica se é necessário carregar na style propriedade.

[ Conjunto de API: ExcelApi 1.9 ]

style?: boolean;

Valor da propriedade

boolean