Sheet
| API | Description | Example |
|---|---|---|
| Workbook.ActiveSheet | Property that returns the active sheet object within the integrated document | let workbook = instance.Application.ActiveWorkbook; let worksheet = workbook.ActiveSheet; |
| Worksheet.Cells | Property that returns a range object that manages all cells within the sheet | let workbook = instance.Application.ActiveWorkbook; let worksheet = workbook.ActiveSheet; let cells = worksheet.Cells; |
| Worksheet.Columns | Property that returns a range object that manages columns within the sheet | let workbook = instance.Application.ActiveWorkbook; let worksheet = workbook.ActiveSheet; let columns = worksheet.Columns; |
| Worksheet.Index | Property that returns the sheet index within the workbook | let workbook = instance.Application.ActiveWorkbook; let worksheet = workbook.ActiveSheet; console.log(worksheet.Index); |
| Worksheet.Name | Property that returns the name of the sheet | let workbook = instance.Application.ActiveWorkbook; let worksheet = workbook.ActiveSheet; console.log(worksheet.Name); |
| Worksheet.Next | Property that returns the next sheet object | let workbook = instance.Application.ActiveWorkbook; let worksheet = workbook.ActiveSheet; let nextSheet = worksheet.Next; |
| Worksheet.Previous | Property that returns the previous sheet object | let workbook = instance.Application.ActiveWorkbook; let worksheet = workbook.ActiveSheet; let previousSheet = worksheet.Previous; |
| Worksheet.Rows | Property that returns a range object that manages rows within the sheet | let workbook = instance.Application.ActiveWorkbook; let worksheet = workbook.ActiveSheet; let rows = worksheet.Rows; |
| Worksheet.UsedRange | Property that returns the range object containing data within the sheet | let workbook = instance.Application.ActiveWorkbook; let worksheet = workbook.ActiveSheet; let range = worksheet.UsedRange; |
| Worksheet.Visible | Property that returns or changes the visibility state of the sheet | let workbook = instance.Application.ActiveWorkbook; let worksheet = workbook.ActiveSheet; console.log(worksheet.Visible); worksheet.Visible = instance.Enums.XlSheetVisibility.xlSheetHidden; |
| Worksheet.Activate | Function that activates the sheet | let workbook = instance.Application.ActiveWorkbook; let worksheet = workbook.ActiveSheet; worksheet.Activate(); |
| Worksheet.Calculate | Function that recalculates changed formulas within the sheet | let workbook = instance.Application.ActiveWorkbook; let worksheet = workbook.ActiveSheet; worksheet.Calculate(); |
| Worksheet.Copy | Function that copies the sheet to a specific location | let workbook = instance.Application.ActiveWorkbook; let worksheet = workbook.Worksheets.Item(1); worksheet.Copy(); // Duplicate by creating a new workbook worksheet.Copy({ After: workbook.ActiveSheet }); // Duplicate within the current workbook |
| Worksheet.Delete | Function that deletes the sheet | let workbook = instance.Application.ActiveWorkbook; let worksheet = workbook.ActiveSheet; worksheet.Delete(); |
| Worksheet.Move | Function that moves the sheet to a specific location | let workbook = instance.Application.ActiveWorkbook; let worksheet = workbook.Worksheets.Item(1); worksheet.Move(); // Move by creating a new workbook worksheet.Move({ After: workbook.ActiveSheet }); // Move within the current workbook |
| Worksheet.Select | Function that selects the sheet | let workbook = instance.Application.ActiveWorkbook; let worksheet = workbook.ActiveSheet; worksheet.Select(); |
Related Features
Spreadsheet Basic Functions , Engine Global Management , Integrated Document Management , Integrated Document , Sheet Management , Range , Area , Engine Object Common