Excel.FormattedNumberCellValue interface

  • Référence
Paquet:
excel

Représente la valeur d’une cellule contenant un nombre avec une chaîne de format. Les chaînes de format numérique doivent être conformes aux instructions Excel. Pour plus d’informations, consultez Consulter les instructions relatives à la personnalisation d’un format de nombre. Dans ce scénario, le format est appliqué à la valeur et non à la cellule, de sorte que la valeur conserve sa chaîne de format tout au long du calcul.

Remarques

[ Ensemble d’API : ExcelApi 1.16 ]

Propriétés

basicType

Représente la valeur qui serait retournée par Range.valueTypes pour une cellule avec cette valeur.
basicValue

Représente la valeur qui serait retournée par Range.values pour une cellule avec cette valeur.
numberFormat

Retourne la chaîne de format numérique utilisée pour afficher cette valeur. Lorsqu’elle est accessible via une valuesAsJson propriété, cette chaîne de format numérique se trouve dans les paramètres régionaux en-US. Lorsqu’il est accessible via une valuesAsJsonLocal propriété, ce format de nombre se trouve dans les paramètres régionaux d’affichage de l’utilisateur. Les chaînes de format numérique doivent être conformes aux instructions Excel. Pour plus d’informations, consultez Consulter les instructions relatives à la personnalisation d’un format de nombre.
type

Représente le type de cette valeur de cellule.

Détails de la propriété

basicType

Représente la valeur qui serait retournée par Range.valueTypes pour une cellule avec cette valeur.

basicType?: RangeValueType.double | "Double";

Valeur de propriété

double | "Double"

Remarques

[ Ensemble d’API : ExcelApi 1.16 ]

basicValue

Représente la valeur qui serait retournée par Range.values pour une cellule avec cette valeur.

basicValue: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : ExcelApi 1.16 ]

numberFormat

Retourne la chaîne de format numérique utilisée pour afficher cette valeur. Lorsqu’elle est accessible via une valuesAsJson propriété, cette chaîne de format numérique se trouve dans les paramètres régionaux en-US. Lorsqu’il est accessible via une valuesAsJsonLocal propriété, ce format de nombre se trouve dans les paramètres régionaux d’affichage de l’utilisateur. Les chaînes de format numérique doivent être conformes aux instructions Excel. Pour plus d’informations, consultez Consulter les instructions relatives à la personnalisation d’un format de nombre.

numberFormat: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : ExcelApi 1.16 ]

Exemples

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

Représente le type de cette valeur de cellule.

type: CellValueType.formattedNumber | "FormattedNumber";

Valeur de propriété

formattedNumber | "FormattedNumber"

Remarques

[ Ensemble d’API : ExcelApi 1.16 ]

Exemples

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