Excel.FormattedNumberCellValue interface

  • Referenz
Paket:
excel

Stellt den Wert einer Zelle dar, die eine Zahl mit einer Formatzeichenfolge enthält. Zahlenformatzeichenfolgen müssen den Excel-Richtlinien entsprechen. Weitere Informationen finden Sie unter Überprüfen von Richtlinien zum Anpassen eines Zahlenformats. In diesem Szenario wird das Format auf den Wert und nicht auf die Zelle angewendet, sodass der Wert seine Formatzeichenfolge während der gesamten Berechnung beibehält.

Hinweise

[ API-Satz: ExcelApi 1.16 ]

Eigenschaften

basicType

Stellt den Wert dar, der von Range.valueTypes für eine Zelle mit diesem Wert zurückgegeben wird.
basicValue

Stellt den Wert dar, der von Range.values für eine Zelle mit diesem Wert zurückgegeben wird.
numberFormat

Gibt die Zahlenformatzeichenfolge zurück, die zum Anzeigen dieses Werts verwendet wird. Beim Zugriff über eine valuesAsJson Eigenschaft befindet sich diese Zahlenformatzeichenfolge im Gebietsschema en-US. Beim Zugriff über eine valuesAsJsonLocal Eigenschaft befindet sich dieses Zahlenformat im Anzeigegebietsschema des Benutzers. Zahlenformatzeichenfolgen müssen den Excel-Richtlinien entsprechen. Weitere Informationen finden Sie unter Überprüfen von Richtlinien zum Anpassen eines Zahlenformats.
type

Stellt den Typ dieses Zellwerts dar.

Details zur Eigenschaft

basicType

Stellt den Wert dar, der von Range.valueTypes für eine Zelle mit diesem Wert zurückgegeben wird.

basicType?: RangeValueType.double | "Double";

Eigenschaftswert

double | "Double"

Hinweise

[ API-Satz: ExcelApi 1.16 ]

basicValue

Stellt den Wert dar, der von Range.values für eine Zelle mit diesem Wert zurückgegeben wird.

basicValue: number;

Eigenschaftswert

number

Hinweise

[ API-Satz: ExcelApi 1.16 ]

numberFormat

Gibt die Zahlenformatzeichenfolge zurück, die zum Anzeigen dieses Werts verwendet wird. Beim Zugriff über eine valuesAsJson Eigenschaft befindet sich diese Zahlenformatzeichenfolge im Gebietsschema en-US. Beim Zugriff über eine valuesAsJsonLocal Eigenschaft befindet sich dieses Zahlenformat im Anzeigegebietsschema des Benutzers. Zahlenformatzeichenfolgen müssen den Excel-Richtlinien entsprechen. Weitere Informationen finden Sie unter Überprüfen von Richtlinien zum Anpassen eines Zahlenformats.

numberFormat: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: ExcelApi 1.16 ]

Beispiele

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

Stellt den Typ dieses Zellwerts dar.

type: CellValueType.formattedNumber | "FormattedNumber";

Eigenschaftswert

formattedNumber | "FormattedNumber"

Hinweise

[ API-Satz: ExcelApi 1.16 ]

Beispiele

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