Edit

Share via

Excel.CellValueType enum

  • Reference
Package:
excel

Represents the types of the CellValue object.

Remarks

[ API set: ExcelApi 1.16 ]

Examples

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

// This function sets the value of cell A1 to a #BUSY! error using data types.
await Excel.run(async (context) => {
  // Retrieve the Sample worksheet and cell A1 on that sheet.
  const sheet = context.workbook.worksheets.getItemOrNullObject("Sample");
  const range = sheet.getRange("A1");

  // Get the error data type and set its type to `busy`.
  const error: Excel.ErrorCellValue = {
    type: Excel.CellValueType.error,
    errorType: Excel.ErrorCellValueType.busy
  };

  // Set cell A1 as the busy error.
  range.valuesAsJson = [[error]];
  await context.sync();
});

Fields

array = "Array"

Represents an ArrayCellValue.
boolean = "Boolean"

Represents a BooleanCellValue.
double = "Double"

Represents a DoubleCellValue.
empty = "Empty"

Represents an EmptyCellValue.
entity = "Entity"

Represents an EntityCellValue.
error = "Error"

Represents an ErrorCellValue.
externalCodeServiceObject = "ExternalCodeServiceObject"

Represents an ExternalCodeServiceObjectCellValue.
formattedNumber = "FormattedNumber"

Represents a FormattedNumberCellValue.
linkedEntity = "LinkedEntity"

Represents a LinkedEntityCellValue.
localImage = "LocalImage"

Represents a LocalImageCellValue.
notAvailable = "NotAvailable"

Represents a ValueTypeNotAvailableCellValue.
reference = "Reference"

Represents a ReferenceCellValue.
string = "String"

Represents a StringCellValue.
webImage = "WebImage"

Represents a WebImageCellValue.