Manage VBA codes of Excel Macro-Enabled workbook

Add a VBA Module in Node.js

Aspose.Cells allows you to add a new VBA Module and Macro Code using Aspose.Cells for Node.js via C++. Please use the Workbook.add(Worksheet) method to add the new VBA Module inside the workbook

The following sample code creates a new workbook and adds a new VBA Module and Macro Code and saves the output in the XLSM format. Once you open the output XLSM file in Microsoft Excel and click the Developer > Visual Basic menu commands, you will see a module named “TestModule” and inside it, you will see the following macro code.

Sub ShowMessage() {
    MsgBox "Welcome to Aspose!"
}

Here is the sample code to generate the output XLSM file with VBA Module and Macro Code.

const path = require("path");
const AsposeCells = require("aspose.cells.node");

// The path to the documents directory.
const dataDir = path.join(__dirname, "data");

// Create new workbook
const workbook = new AsposeCells.Workbook();

// Access first worksheet
const worksheet = workbook.getWorksheets().get(0);

// Add VBA Module
const idx = workbook.getVbaProject().getModules().add(worksheet);

// Access the VBA Module, set its name and codes
const module = workbook.getVbaProject().getModules().get(idx);
module.setName("TestModule");

module.setCodes("Sub ShowMessage()" + "\r\n" +
"    MsgBox \"Welcome to Aspose!\"" + "\r\n" +
"End Sub");

// Save the workbook
workbook.save(path.join(dataDir, "output_out.xlsm"), AsposeCells.SaveFormat.Xlsm);

Modify VBA or Macro in Node.js

You can modify VBA or Macro Code using Aspose.Cells for Node.js via C++. Aspose.Cells has added the following module and classes to read and modify the VBA project in the Excel file.

• Aspose.Cells.Vba
• VbaProject
• VbaModuleCollection
• VbaModule

This article will show you how to change the VBA or Macro Code inside the source Excel file using Aspose.Cells.

The following sample code loads the source Excel file which has the following VBA or Macro code inside it

Sub Button1_Click() {
    MsgBox "This is test message."
}

After the execution of Aspose.Cells sample code, the VBA or Macro code will be modified like this

Sub Button1_Click() {
    MsgBox "This is Aspose.Cells message."
}

You can download the source Excel file and the output Excel file from the given links.

const path = require("path");
const AsposeCells = require("aspose.cells.node");

// The path to the documents directory.
const dataDir = path.join(__dirname, "data");
// Create workbook object from source Excel file
const workbook = new AsposeCells.Workbook(path.join(dataDir, "sample.xlsm"));

// Change the VBA Module Code
workbook.getVbaProject().getModules().forEach(module => {
    let code = module.getCodes();

    // Replace the original message with the modified message
    if (code.includes("This is test message.")) {
        code = code.replace("This is test message.", "This is Aspose.Cells message.");
        module.setCodes(code);
    }
});

// Save the output Excel file
workbook.save(path.join(dataDir, "output_out.xlsm"));

Advance topics

• Add a library reference to VBA project in workbook
• Assign Macro to Form Control
• Check if Digital Signature of VBA Code is Valid
• Check if VBA Code is Signed
• Check if VBA project in a Workbook is Signed
• Check if VBA Project is Protected and Locked for Viewing
• Copy VBA Macro UserForm DesignerStorage from Template to Target Workbook
• Digitally Sign a VBA Code Project with Certificate
• Export VBA Certificate to File or Stream
• Filter VBA Project while loading a workbook
• Find out if VBA Project is Protected
• Password Protect the VBA Project of Excel Workbook