Spire.XLS for Java 16.11.1 Adds Support for VBA Macro Management

2026-11-20 10:28:22

We're pleased to announce the release of Spire.XLS for Java 16.11.1. This version adds support for adding, retrieving, setting, and copying VBA macros. It also fixes an issue where TextBox content was lost during Excel to PDF and OFD conversion. More details are listed below.

Here is a list of changes made in this release

Category ID Description
New Feature - Supports adding VBA macros.
Workbook workbook = new Workbook();
Workbook workbook = new Workbook();
//Add a VBA project to the document
IVbaProject vbaProject = workbook.getVbaProject();
vbaProject.setName("SampleVBAMacro");
vbaProject.setCodePage(936); //Set the encoding to support Chinese

//Add a module to the VBA project
IVbaModule vbaModule = vbaProject.getModules().add("frmDataEntry", VbaModuleType.UserForm);

workbook.saveToFile(outputFile, FileFormat.Xlsm);
workbook.dispose();
New Feature - Supports getting and setting VBA macros.
Workbook wb = new Workbook();
wb.loadFromFile(inputFile);
Worksheet ws = wb.getWorksheets().get(0);

IVbaProject vbaProject = wb.getVbaProject();
// Project properties
vbaProject.setPassword("1234");
vbaProject.setName("modify");
vbaProject.setDescription("Description");
vbaProject.setHelpFileName("image1.png");
vbaProject.setConditionalCompilation("DEBUG = 2");
vbaProject.setLockProjectView(true);
String text = "Password: " + vbaProject.getPassword() + "\n";//The set password can be retrieved
TestUtil.writeAllText(outputFile_TXT, text);
// Sheet properties
IVbaModule mod = vbaProject.getModules().getWorksheetModule(ws);
mod.setName("IVbaModule");
mod.setSourceCode("Dim lRow As Long");
mod.setType(VbaModuleType.Module);

wb.saveToFile(outputFile);
wb.dispose();
New Feature - Supports copying VBA macros.
Workbook wb1 = new Workbook();
wb1.loadFromFile(inputFile_1);
IVbaProject vbaProject1 = wb1.getVbaProject();

Workbook wb2 = new Workbook();
wb2.loadFromFile(inputFile_2);
IVbaProject vbaProject2 = wb2.getVbaProject();

Workbook wb3 = new Workbook();
wb3.loadFromFile(inputFile_3);
IVbaProject vbaProject3 = wb3.getVbaProject();

Workbook wb4 = new Workbook();
wb4.loadFromFile(inputFile_4);
IVbaProject vbaProject4 = wb4.getVbaProject();

Workbook dest = new Workbook();
dest.getVbaProject().getModules().add(vbaProject1.getModules().get("SampleModule").clone(dest.getVbaProject().getModules()));
dest.getVbaProject().getModules().add(vbaProject2.getModules().get("Employee").clone(dest.getVbaProject().getModules()));
dest.getVbaProject().getModules().add(vbaProject2.getModules().get(1).clone(dest.getVbaProject().getModules()));
dest.getVbaProject().getModules().add(vbaProject3.getModules().get(0).clone(dest.getVbaProject().getModules()));
dest.getVbaProject().getModules().add(vbaProject4.getModules().get(0).clone(dest.getVbaProject().getModules()));
dest.saveToFile(outputFile);
Bug Fix - Fixed the issue where textBox content was lost when converting Excel to PDF and OFD.
Click the link below to download Spire.XLS for Java 16.11.1: