Excel.FormattedNumberCellValue interface

包:

excel

表示包含带格式字符串的数字的单元格的值。 数字格式字符串必须符合 Excel 指南。 若要了解详细信息，请参阅 查看自定义数字格式的指南。 在此方案中，格式应用于值而不是单元格，因此该值在整个计算过程中会保留其格式字符串。

注解

[ API 集：ExcelApi 1.16 ]

属性

basicType	表示将为具有此值的单元格返回 Range.valueTypes 的值。
basicValue	表示将为具有此值的单元格返回 Range.values 的值。
numberFormat	返回用于显示此值的数字格式字符串。 通过 valuesAsJson 属性访问时，此数字格式字符串位于 en-US 区域设置中。 通过 valuesAsJsonLocal 属性访问时，此数字格式位于用户的显示区域设置中。 数字格式字符串必须符合 Excel 指南。 若要了解详细信息，请参阅 查看自定义数字格式的指南。
type	表示此单元格值的类型。

属性详细信息

basicType

表示将为具有此值的单元格返回 Range.valueTypes 的值。

basicType?: RangeValueType.double | "Double";

属性值

double | "Double"

注解

[ API 集：ExcelApi 1.16 ]

basicValue

表示将为具有此值的单元格返回 Range.values 的值。

basicValue: number;

属性值

number

注解

[ API 集：ExcelApi 1.16 ]

numberFormat

返回用于显示此值的数字格式字符串。 通过 valuesAsJson 属性访问时，此数字格式字符串位于 en-US 区域设置中。 通过 valuesAsJsonLocal 属性访问时，此数字格式位于用户的显示区域设置中。 数字格式字符串必须符合 Excel 指南。 若要了解详细信息，请参阅 查看自定义数字格式的指南。

numberFormat: string;

属性值

string

注解

[ API 集：ExcelApi 1.16 ]

示例

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

表示此单元格值的类型。

type: CellValueType.formattedNumber | "FormattedNumber";

属性值

formattedNumber | "FormattedNumber"

注解

[ API 集：ExcelApi 1.16 ]

示例

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