ExcelScript.CheckboxCellControl interface

Remarks

Examples

/**
 * This script creates a task list and displays the completion values as checkboxes.
 */
function main(workbook: ExcelScript.Workbook) {
  const sheet = workbook.addWorksheet();
  const taskRange = sheet.getRange("A1:B4");

  // Add tasks and their completion values.
  taskRange.setValues([
    ["Task", "Complete"],
    ["Review data", true],
    ["Update chart", false],
    ["Send report", false]
  ]);

  // Display the Boolean values in the Complete column as checkboxes.
  const checkboxRange = sheet.getRange("B2:B4");
  const checkboxControl: ExcelScript.CellControl = {
    type: ExcelScript.CellControlType.checkbox
  };
  checkboxRange.setControl(checkboxControl);

  taskRange.getFormat().autofitColumns();
}

Properties

type

type: CellControlType.checkbox;