public class VbaModuleCollection
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(); ? 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));
Property Getters/Setters Summary | ||
---|---|---|
int | getCount() | |
Returns the number of VBA modules in the collection.
|
||
VbaModule | get(int index) | |
Retrieves a |
||
VbaModule | get(java.lang.String name) | |
Retrieves a |
Method Summary | ||
---|---|---|
void | add(VbaModule vbaModule) | |
Adds a module to the collection.
|
||
void | remove(VbaModule module) | |
Removes the specified module from the collection.
|
public int getCount()
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(); ? 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 VbaModule get(int index)
index
- Zero-based index of the module to retrieve.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(); ? 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 VbaModule get(java.lang.String name)
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(); ? 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 add(VbaModule vbaModule)
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");
public void remove(VbaModule module)
module
- The module to remove.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(); ? 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));