public class VbaModule
extends java.lang.Object
implements java.lang.Cloneable
To learn more, visit the Working with VBA Macros documentation article.
Examples:
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 and Description |
|---|
VbaModule()
Creates an empty module.
|
| Modifier and Type | Method and Description |
|---|---|
VbaModule |
deepClone()
Performs a copy of the
VbaModule. |
java.lang.String |
getName()
Gets VBA project module name.
|
java.lang.String |
getSourceCode()
Gets VBA project module source code.
|
int |
getType()
Specifies whether the module is a procedural module, document module, class module, or designer module.
|
protected java.lang.Object |
memberwiseClone() |
void |
setName(java.lang.String value)
Sets VBA project module name.
|
void |
setSourceCode(java.lang.String value)
Sets VBA project module source code.
|
void |
setType(int value)
Specifies whether the module is a procedural module, document module, class module, or designer module.
|
public VbaModule()
Examples:
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");
public VbaModule deepClone()
VbaModule.
Examples:
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");
VbaModule.public java.lang.String getName()
Examples:
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");
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));
public void setName(java.lang.String value)
Examples:
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");
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));
value - VBA project module name.public java.lang.String getSourceCode()
Examples:
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");
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));
public void setSourceCode(java.lang.String value)
Examples:
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");
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));
value - VBA project module source code.public int getType()
Examples:
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");
int value. The returned value is one of VbaModuleType constants.public void setType(int value)
Examples:
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");
value - The corresponding int value. The value must be one of VbaModuleType constants.protected java.lang.Object memberwiseClone()