Compartilhar via

Excel.FormattedNumberCellValue interface

  • Referência
Pacote:
excel

Representa o valor de uma célula que contém um número com uma cadeia de formato. As cadeias de formato de número têm de estar em conformidade com as diretrizes do Excel. Para saber mais, veja Rever diretrizes para personalizar um formato de número. Neste cenário, o formato é aplicado ao valor e não à célula, pelo que o valor mantém a cadeia de formato ao longo do cálculo.

Comentários

[ Conjunto de API: ExcelApi 1.16 ]

Propriedades

basicType

Representa o valor que seria devolvido por para Range.valueTypes uma célula com este valor.
basicValue

Representa o valor que seria devolvido por para Range.values uma célula com este valor.
numberFormat

Devolve a cadeia de formato de número que é utilizada para apresentar este valor. Quando acedido através de uma valuesAsJson propriedade, esta cadeia de formato de número encontra-se na região en-US. Quando acedido através de uma valuesAsJsonLocal propriedade, este formato de número encontra-se na região de apresentação do utilizador. As cadeias de formato de número têm de estar em conformidade com as diretrizes do Excel. Para saber mais, veja Rever diretrizes para personalizar um formato de número.
type

Representa o tipo deste valor de célula.

Detalhes da propriedade

basicType

Representa o valor que seria devolvido por para Range.valueTypes uma célula com este valor.

basicType?: RangeValueType.double | "Double";

Valor da propriedade

double | "Double"

Comentários

[ Conjunto de API: ExcelApi 1.16 ]

basicValue

Representa o valor que seria devolvido por para Range.values uma célula com este valor.

basicValue: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.16 ]

numberFormat

Devolve a cadeia de formato de número que é utilizada para apresentar este valor. Quando acedido através de uma valuesAsJson propriedade, esta cadeia de formato de número encontra-se na região en-US. Quando acedido através de uma valuesAsJsonLocal propriedade, este formato de número encontra-se na região de apresentação do utilizador. As cadeias de formato de número têm de estar em conformidade com as diretrizes do Excel. Para saber mais, veja Rever diretrizes para personalizar um formato de número.

numberFormat: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi 1.16 ]

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/20-data-types/data-types-formatted-number.yaml

// This function creates a formatted number data type,
// and sets the format of this data type as a currency.
await Excel.run(async (context) => {
  // Get the Sample worksheet and a range on that sheet.
  const sheet = context.workbook.worksheets.getItemOrNullObject("Sample");
  const currencyRange = sheet.getRange("A2");

  // Write a number formatted as currency to cell A2.
  currencyRange.valuesAsJson = [
    [
      {
        type: Excel.CellValueType.formattedNumber,
        basicValue: 12.34,
        numberFormat: "$* #,##0.00"
      }
    ]
  ];

  await context.sync();
});

type

Representa o tipo deste valor de célula.

type: CellValueType.formattedNumber | "FormattedNumber";

Valor da propriedade

formattedNumber | "FormattedNumber"

Comentários

[ Conjunto de API: ExcelApi 1.16 ]

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/20-data-types/data-types-formatted-number.yaml

// This function creates a formatted number data type,
// and sets the format of this data type as a date.
await Excel.run(async (context) => {
  // Get the Sample worksheet and a range on that sheet.
  const sheet = context.workbook.worksheets.getItemOrNullObject("Sample");
  const dateRange = sheet.getRange("A1");

  // Write a number formatted as a date to cell A1.
  dateRange.valuesAsJson = [
    [
      {
        type: Excel.CellValueType.formattedNumber,
        basicValue: 32889.0,
        numberFormat: "m/d/yyyy"
      }
    ]
  ];
  await context.sync();
});