com.aspose.cells

Class VbaModuleCollection

java.lang.Object

com.aspose.cells.CollectionBase

com.aspose.cells.VbaModuleCollection

All Implemented Interfaces:

java.lang.Iterable

public class VbaModuleCollection
extends CollectionBase

Represents the list of VbaModule

Example

 
         //Instantiating a Workbook object
         Workbook workbook = new Workbook();
          // Init VBA project.
         VbaProject vbaProject = workbook.getVbaProject(); 
         // Add a new module.
         vbaProject.getModules().add(VbaModuleType.CLASS, "test");
         //Saving the Excel file
         workbook.save("book1.xlsm");
 

Method Summary

Methods

Modifier and Type	Method and Description
int	add(int type, java.lang.String name) Adds module.
int	add(Worksheet sheet) Adds module for a worksheet.
void	addDesignerStorage(java.lang.String name, byte[] data)
int	addUserForm(java.lang.String name, java.lang.String codes, byte[] designerStorage) Inser user form into VBA Project.
VbaModule	get(int index) Gets VbaModule in the list by the index.
VbaModule	get(java.lang.String name) Gets VbaModule in the list by the name.
byte[]	getDesignerStorage(java.lang.String name) Represents the data of Designer.
void	remove(java.lang.String name) Remove the module by the name
void	remove(Worksheet sheet) Removes module for a worksheet.

Methods inherited from class com.aspose.cells.CollectionBase

add, clear, contains, getCount, indexOf, iterator, removeAt

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

addDesignerStorage

public void addDesignerStorage(java.lang.String name,
                      byte[] data)

Parameters:

name -

data -

getDesignerStorage

public byte[] getDesignerStorage(java.lang.String name)

Represents the data of Designer.

Remarks

We do not support to parse them. Just only for copying.

add

public int add(Worksheet sheet)

Adds module for a worksheet.

Parameters:

sheet - The worksheet

Returns:

add

public int add(int type,
      java.lang.String name)

Adds module.

Parameters:

type - VbaModuleType. The type of module.

name - The name of module.

Returns:

addUserForm

public int addUserForm(java.lang.String name,
              java.lang.String codes,
              byte[] designerStorage)

Inser user form into VBA Project.

Parameters:

name - The name of user form

codes - The codes for the user form

designerStorage - the designer setting about the user form

Returns:

get

public VbaModule get(int index)

Gets VbaModule in the list by the index.

Overrides:

get in class CollectionBase

Parameters:

index - The index.

Returns:

remove

public void remove(Worksheet sheet)

Removes module for a worksheet.

Parameters:

sheet - The worksheet

remove

public void remove(java.lang.String name)

Remove the module by the name

Parameters:

name -

get

public VbaModule get(java.lang.String name)

Gets VbaModule in the list by the name.

Parameters:

name - The name of module.

Returns: