Snippets - Worksheets

link - docs.microsoft.com/en-us/office/dev/add-ins/excel/excel-add-ins-worksheets

Exists

Excel.run(function (context) { 
   var _worksheet = context.workbook.worksheets.getItemOrNullObject("Sheet 1"); 
   if (_worksheet.IsNullObject) { 
      // does not exist, needs to be created 
   } 
}); 

from range

Excel.run(function (context) { 
    var selectedRangeWorksheet = context.workbook.getSelectedRange().worksheet.load("name"); 
    return context.sync() 
        .then(function () { console.log(selectedRangeWorksheet.name); }) 
        .catch(function (error) {  console.log(error); }); 
}); 

create worksheet

Excel.run(function (context) { 
                context.workbook.worksheets.add("Sheet" + Math.floor(Math.random()*100000).toString()); 
                return context.sync();             
}).catch(function (error) { 
   console.log(error); 
}); 

get worksheets in workbook

Excel.run(function (context) { 
                var worksheets = context.workbook.worksheets.load("name"); 
                return context.sync().then(function () { 
                                for (var i = 0; i < worksheets.items.length; i++) { 
                                                console.log(worksheets.items[i].name); 
                                } 
                                console.log("done"); 
                });           
}).catch(function (error) { 
   console.log(error); 
}); 

get active worksheet

Excel.run(function (context) { 
                var activeWorksheet = context.workbook.worksheets.getActiveWorksheet().load("name"); 
                return context.sync().then(function () { 
                                console.log(activeWorksheet.name); 
                }); 
}).catch(function (error) { 
   console.log(error); 
}); 

delete active worksheet

Excel.run(function (context) { 
                context.workbook.worksheets.getActiveWorksheet().delete(); 
                return context.sync();             
}).catch(function (error) { 
   console.log(error); 
}); 

Get a list of all worksheets

var sheetNames = []; 
for (var sheetindex in context.workbook.worksheets.items) { 
   var sheet = context.workbook.worksheets.items[sheetindex]; 
   sheetNames.push(sheet.name); 
}