Working with VBA Macros

Visual Basic for Applications (VBA) for Microsoft Word is a simple but powerful programming language that can be used to extend the functionality. Aspose.Words API provides three classes to get access to the VBA project source code:

• The VBAProject class provides access to the VBA project information
• The VBAModulesCollection class returns the collection of VBA project modules
• The VbaModule class provides access to the VBA project module

Create a VBA Project

Aspose.Words API provides the VbaProject property to get or set VbaProject in the document.

The following code example demonstrates how to create a VBA project and VBA Module along with basic properties e.g. Name and Type:

// For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-Java
Document doc = new Document();

// Create a new VBA project.
VbaProject project = new VbaProject();
project.setName("AsposeProject");
doc.setVbaProject(project);

// Create a new module and specify a macro source code.
VbaModule module = new VbaModule();
module.setName("AsposeModule");
module.setType(VbaModuleType.PROCEDURAL_MODULE);
module.setSourceCode("New source code");

// Add module to the VBA project.
doc.getVbaProject().getModules().add(module);

doc.save(dataDir + "VbaProject_out.docm");

Read Macros

Aspose.Words also provides users with the ability to read VBA macros.

The following code example shows how to read VBA Macros from the document:

// For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-Java
Document doc = new Document(dataDir + "VbaProject_out.docm");

for (VbaModule module : doc.getVbaProject().getModules()) {
    System.out.println(module.getSourceCode());
}
        
doc.save(dataDir + "VbaProject_out.docm");

Modify Macros

Using Aspose.Words, users can modify VBA macros.

The following code example shows how to modify VBA Macros using the SourceCode property:

// For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-Java
Document doc = new Document(dataDir + "VbaProject_out.docm");
VbaProject project = doc.getVbaProject();

String newSourceCode = "Test change source code";

// Choose a module, and set a new source code.
project.getModules().get(0).setSourceCode(newSourceCode);

Clone VBA Project

With Aspose.Words it is also possible to clone VBA projects.

The following code example demonstrates how to clone the VBA Project using the Clone property which creates a copy of the existing project:

// For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-Java
Document doc = new Document(dataDir + "VbaProject_out.docm");
VbaProject project = doc.getVbaProject();

Document destDoc = new Document();

// Clone the whole project.
destDoc.setVbaProject(doc.getVbaProject().deepClone());

destDoc.save(dataDir + "output.docm");

Clone VBA Module

You can also clone VBA modules if needed.

The following code example demonstrates how to clone the VBA Module using the Clone property which creates a copy of the existing project. 

// For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-Java
Document doc = new Document(dataDir + "VbaProject_out.docm");
      VbaProject project = doc.getVbaProject();

      Document destDoc = new Document();

      destDoc.setVbaProject(new VbaProject());

      // Clone a single module.
      VbaModule copyModule = doc.getVbaProject().getModules().get("Module1").deepClone();
      destDoc.getVbaProject().getModules().add(copyModule);

      destDoc.save(dataDir + "output.docm");