com.aspose.words
Class VbaModule

java.lang.Object
    extended by com.aspose.words.VbaModule
All Implemented Interfaces:
java.lang.Cloneable

public class VbaModule 
extends java.lang.Object

Provides access to VBA project module.

Example:

Shows how to access a document's VBA project information.
Document doc = new Document(getMyDir() + "VBA project.docm");

// A VBA project contains a collection of VBA modules.
VbaProject vbaProject = doc.getVbaProject();
System.out.println(vbaProject.isSigned()
        ? MessageFormat.format("Project name: {0} signed; Project code page: {1}; Modules count: {2}\n", vbaProject.getName(), vbaProject.getCodePage(), vbaProject.getModules().getCount())
        : MessageFormat.format("Project name: {0} not signed; Project code page: {1}; Modules count: {2}\n", vbaProject.getName(), vbaProject.getCodePage(), vbaProject.getModules().getCount()));

VbaModuleCollection vbaModules = doc.getVbaProject().getModules();

Assert.assertEquals(vbaModules.getCount(), 3);

for (VbaModule module : vbaModules) {
    System.out.println(MessageFormat.format("Module name: {0};\nModule code:\n{1}\n", module.getName(), module.getSourceCode()));
}

// Set new source code for VBA module. You can access VBA modules in the collection either by index or by name.
vbaModules.get(0).setSourceCode("Your VBA code...");
vbaModules.get("Module1").setSourceCode("Your VBA code...");

// Remove a module from the collection.
vbaModules.remove(vbaModules.get(2));

Constructor Summary
VbaModule()
           Creates an empty module.
 
Property Getters/Setters Summary
java.lang.StringgetName()
voidsetName(java.lang.String value)
           Gets or sets VBA project module name.
java.lang.StringgetSourceCode()
voidsetSourceCode(java.lang.String value)
           Gets or sets VBA project module source code.
intgetType()
voidsetType(int value)
           Specifies whether the module is a procedural module, document module, class module, or designer module. The value of the property is VbaModuleType integer constant.
 
Method Summary
VbaModuledeepClone()
           Performs a copy of the VbaModule.
 

Constructor Detail

VbaModule

public VbaModule()
Creates an empty module.

Example:

Shows how to create a VBA project using macros.
Document doc = new Document();

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

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

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

doc.save(getArtifactsDir() + "VbaProject.CreateVBAMacros.docm");

Property Getters/Setters Detail

getName/setName

public java.lang.String getName() / public void setName(java.lang.String value)
Gets or sets VBA project module name.

Example:

Shows how to create a VBA project using macros.
Document doc = new Document();

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

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

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

doc.save(getArtifactsDir() + "VbaProject.CreateVBAMacros.docm");

Example:

Shows how to access a document's VBA project information.
Document doc = new Document(getMyDir() + "VBA project.docm");

// A VBA project contains a collection of VBA modules.
VbaProject vbaProject = doc.getVbaProject();
System.out.println(vbaProject.isSigned()
        ? MessageFormat.format("Project name: {0} signed; Project code page: {1}; Modules count: {2}\n", vbaProject.getName(), vbaProject.getCodePage(), vbaProject.getModules().getCount())
        : MessageFormat.format("Project name: {0} not signed; Project code page: {1}; Modules count: {2}\n", vbaProject.getName(), vbaProject.getCodePage(), vbaProject.getModules().getCount()));

VbaModuleCollection vbaModules = doc.getVbaProject().getModules();

Assert.assertEquals(vbaModules.getCount(), 3);

for (VbaModule module : vbaModules) {
    System.out.println(MessageFormat.format("Module name: {0};\nModule code:\n{1}\n", module.getName(), module.getSourceCode()));
}

// Set new source code for VBA module. You can access VBA modules in the collection either by index or by name.
vbaModules.get(0).setSourceCode("Your VBA code...");
vbaModules.get("Module1").setSourceCode("Your VBA code...");

// Remove a module from the collection.
vbaModules.remove(vbaModules.get(2));

getSourceCode/setSourceCode

public java.lang.String getSourceCode() / public void setSourceCode(java.lang.String value)
Gets or sets VBA project module source code.

Example:

Shows how to create a VBA project using macros.
Document doc = new Document();

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

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

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

doc.save(getArtifactsDir() + "VbaProject.CreateVBAMacros.docm");

Example:

Shows how to access a document's VBA project information.
Document doc = new Document(getMyDir() + "VBA project.docm");

// A VBA project contains a collection of VBA modules.
VbaProject vbaProject = doc.getVbaProject();
System.out.println(vbaProject.isSigned()
        ? MessageFormat.format("Project name: {0} signed; Project code page: {1}; Modules count: {2}\n", vbaProject.getName(), vbaProject.getCodePage(), vbaProject.getModules().getCount())
        : MessageFormat.format("Project name: {0} not signed; Project code page: {1}; Modules count: {2}\n", vbaProject.getName(), vbaProject.getCodePage(), vbaProject.getModules().getCount()));

VbaModuleCollection vbaModules = doc.getVbaProject().getModules();

Assert.assertEquals(vbaModules.getCount(), 3);

for (VbaModule module : vbaModules) {
    System.out.println(MessageFormat.format("Module name: {0};\nModule code:\n{1}\n", module.getName(), module.getSourceCode()));
}

// Set new source code for VBA module. You can access VBA modules in the collection either by index or by name.
vbaModules.get(0).setSourceCode("Your VBA code...");
vbaModules.get("Module1").setSourceCode("Your VBA code...");

// Remove a module from the collection.
vbaModules.remove(vbaModules.get(2));

getType/setType

public int getType() / public void setType(int value)
Specifies whether the module is a procedural module, document module, class module, or designer module. The value of the property is VbaModuleType integer constant.

Example:

Shows how to create a VBA project using macros.
Document doc = new Document();

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

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

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

doc.save(getArtifactsDir() + "VbaProject.CreateVBAMacros.docm");

Method Detail

deepClone

public VbaModule deepClone()
Performs a copy of the VbaModule.
Returns:
The cloned VbaModule.

Example:

Shows how to deep clone a VBA project and module.
Document doc = new Document(getMyDir() + "VBA project.docm");
Document destDoc = new Document();

VbaProject copyVbaProject = doc.getVbaProject().deepClone();
destDoc.setVbaProject(copyVbaProject);

// In the destination document, we already have a module named "Module1"
// because we cloned it along with the project. We will need to remove the module.
VbaModule oldVbaModule = destDoc.getVbaProject().getModules().get("Module1");
VbaModule copyVbaModule = doc.getVbaProject().getModules().get("Module1").deepClone();
destDoc.getVbaProject().getModules().remove(oldVbaModule);
destDoc.getVbaProject().getModules().add(copyVbaModule);

destDoc.save(getArtifactsDir() + "VbaProject.CloneVbaProject.docm");

See Also:
          Aspose.Words Documentation - the home page for the Aspose.Words Product Documentation.
          Aspose.Words Support Forum - our preferred method of support.