Excel.FormattedNumberCellValue interface

  • Referencia
Paquete:
excel

Representa el valor de una celda que contiene un número con una cadena de formato. Las cadenas de formato de número deben cumplir las instrucciones de Excel. Para obtener más información, consulte Directrices de revisión para personalizar un formato de número. En este escenario, el formato se aplica al valor y no a la celda, por lo que el valor conserva su cadena de formato durante todo el cálculo.

Comentarios

[ Conjunto de API: ExcelApi 1.16 ]

Propiedades

basicType

Representa el valor que devolvería Range.valueTypes para una celda con este valor.
basicValue

Representa el valor que devolvería Range.values para una celda con este valor.
numberFormat

Devuelve la cadena de formato de número que se usa para mostrar este valor. Cuando se accede a ella a través de una valuesAsJson propiedad, esta cadena de formato numérico se encuentra en la configuración regional en-US. Cuando se accede a ella a través de una valuesAsJsonLocal propiedad, este formato de número se encuentra en la configuración regional para mostrar del usuario. Las cadenas de formato de número deben cumplir las instrucciones de Excel. Para obtener más información, consulte Directrices de revisión para personalizar un formato de número.
type

Representa el tipo de este valor de celda.

Detalles de las propiedades

basicType

Representa el valor que devolvería Range.valueTypes para una celda con este valor.

basicType?: RangeValueType.double | "Double";

Valor de propiedad

double | "Double"

Comentarios

[ Conjunto de API: ExcelApi 1.16 ]

basicValue

Representa el valor que devolvería Range.values para una celda con este valor.

basicValue: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: ExcelApi 1.16 ]

numberFormat

Devuelve la cadena de formato de número que se usa para mostrar este valor. Cuando se accede a ella a través de una valuesAsJson propiedad, esta cadena de formato numérico se encuentra en la configuración regional en-US. Cuando se accede a ella a través de una valuesAsJsonLocal propiedad, este formato de número se encuentra en la configuración regional para mostrar del usuario. Las cadenas de formato de número deben cumplir las instrucciones de Excel. Para obtener más información, consulte Directrices de revisión para personalizar un formato de número.

numberFormat: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: ExcelApi 1.16 ]

Ejemplos

// 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 el tipo de este valor de celda.

type: CellValueType.formattedNumber | "FormattedNumber";

Valor de propiedad

formattedNumber | "FormattedNumber"

Comentarios

[ Conjunto de API: ExcelApi 1.16 ]

Ejemplos

// 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();
});