Module - Workbook

Sample Code:

//Open a specific workbook irpa_excel.workbook.openExistingWorkbook('C:\\folder1\\folder2\\workbookName.xlsx', {updateLinks: 'updateLinks'});

Sample Code:

//Save and close the workbook const workbook = irpa_excel.workbook.close(true);

Sample Code:

//Close the workbook without to save it. const workbook = irpa_excel.workbook.close(false);

Sample Code:

irpa_excel.workbook.setSensitivity('51e9b6e7-e4bc-422b-b136-be52bca82e7c');

Note:

The labelId parameter is a GUID, specific to your organisation for each sensitivity label. Use the activity Get Sensitivity labelId to get a valid GUID.

Sample Code:

const labelId = irpa_excel.workbook.getSensitivity();

Note:

This activity is especially useful in design mode to know which labelId has to be set int Set Sensitivity activity.

Sample Code:

//Save the active workbook irpa_excel.workbook.save();

Sample Code:

//Save as the active workbook under a new file. irpa_excel.workbook.saveAs("C:\\myFolder\\fileName.xlsx");

Note:

The csv format might produce a loss of values and some features could not work as expected. Note that only the active worksheet is saved with this format.

Sample Code:

//Export the active workbook as pdf. irpa_excel.workbook.exportAs("C:\\myFolder\\fileName.pdf");

Sample Code:

//Export the active workbook as xps. irpa_excel.workbook.exportAs("C:\\myFolder\\fileName.xps", irpa_excel.enums.exportAsFormat.xps);

Sample Code:

//Create a new active workbook. irpa_excel.workbook.addNewWorkbook();

Sample Code:

//Activate the workbook defined in input. irpa_excel.workbook.activateWorkbook("myWorkbookName.xlsx");

Sample Code:

//Get the names of the visible worksheets in the workbook. const myWorksheetNames = irpa_excel.workbook.getWorksheetsName();

Sample Code:

//Get the names of the hidden worksheets in the workbook. const myWorksheetNames = irpa_excel.workbook.getWorksheetsName(irpa_excel.enums.visibilitySelection.onlyHiddenWorksheets);

Sample Code:

//Get the count of the visible worksheets in the workbook. const numberOfSheets = irpa_excel.workbook.getWorksheetsCount();

Sample Code:

//Get the count of hidden worksheets in the workbook. const numberOfSheets = irpa_excel.workbook.getWorksheetsCount(irpa_excel.enums.visibilitySelection.onlyHiddenWorksheets);