VbaModuleCollection

Inheritance: java.lang.Object, com.aspose.cells.CollectionBase

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");

Methods

Method	Description
add(Worksheet sheet)	Adds module for a worksheet.
add(int type, String name)	Adds module.
add(Object o)	Adds an item to the CollectionBase instance.
addDesignerStorage(String name, byte[] data)
addUserForm(String name, String codes, byte[] designerStorage)	Inser user form into VBA Project.
clear()	Removes all objects from the CollectionBase instance.
contains(Object o)	Return whether instance contains this object
equals(Object arg0)
get(int index)	Gets VbaModule in the list by the index.
get(String name)	Gets VbaModule in the list by the name.
getClass()
getCount()	Gets the number of elements contained in the CollectionBase instance.
getDesignerStorage(String name)	Represents the data of Designer.
hashCode()
indexOf(Object o)	Determines the index of a specific item in the CollectionBase instance.
iterator()	Returns an enumerator that iterates through the CollectionBase instance.
notify()
notifyAll()
remove(Worksheet sheet)	Removes module for a worksheet.
remove(String name)	Remove the module by the name
removeAt(int index)	Removes the item at the specified index.
toString()
wait()
wait(long arg0)
wait(long arg0, int arg1)

add(Worksheet sheet)

public int add(Worksheet sheet)

Adds module for a worksheet.

Parameters:

Parameter	Type	Description
sheet	Worksheet	The worksheet

Returns: int -

add(int type, String name)

public int add(int type, String name)

Adds module.

Parameters:

Parameter	Type	Description
type	int	VbaModuleType. The type of module.
name	java.lang.String	The name of module.

Returns: int -

add(Object o)

public int add(Object o)

Adds an item to the CollectionBase instance.

Parameters:

Parameter	Type	Description
o	java.lang.Object	The Object to add to the CollectionBase instance.

Returns: int - The position into which the new element was inserted.

addDesignerStorage(String name, byte[] data)

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

Parameters:

Parameter	Type	Description
name	java.lang.String
data	byte[]

addUserForm(String name, String codes, byte[] designerStorage)

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

Inser user form into VBA Project.

Parameters:

Parameter	Type	Description
name	java.lang.String	The name of user form
codes	java.lang.String	The codes for the user form
designerStorage	byte[]	the designer setting about the user form

Returns: int -

clear()

public void clear()

Removes all objects from the CollectionBase instance.

contains(Object o)

public boolean contains(Object o)

Return whether instance contains this object

Parameters:

Parameter	Type	Description
o	java.lang.Object	test object

Returns: boolean - Whether instance contains this object

equals(Object arg0)

public boolean equals(Object arg0)

Parameters:

Parameter	Type	Description
arg0	java.lang.Object

Returns: boolean

get(int index)

public VbaModule get(int index)

Gets VbaModule in the list by the index.

Parameters:

Parameter	Type	Description
index	int	The index.

Returns: VbaModule -

get(String name)

public VbaModule get(String name)

Gets VbaModule in the list by the name.

Parameters:

Parameter	Type	Description
name	java.lang.String	The name of module.

Returns: VbaModule -

getClass()

public final native Class<?> getClass()

Returns: java.lang.Class

getCount()

public int getCount()

Gets the number of elements contained in the CollectionBase instance.

Returns: int - The number of elements contained in the CollectionBase instance.

getDesignerStorage(String name)

public byte[] getDesignerStorage(String name)

Represents the data of Designer.

Remarks

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

Parameters:

Parameter	Type	Description
name	java.lang.String

Returns: byte[]

hashCode()

public native int hashCode()

Returns: int

indexOf(Object o)

public int indexOf(Object o)

Determines the index of a specific item in the CollectionBase instance.

Parameters:

Parameter	Type	Description
o	java.lang.Object	Determines the index of a specific item in the CollectionBase instance.

Returns: int - The index of value if found in the list; otherwise, -1.

iterator()

public Iterator iterator()

Returns an enumerator that iterates through the CollectionBase instance.

Returns: java.util.Iterator - An iterator for the CollectionBase instance.

notify()

public final native void notify()

notifyAll()

public final native void notifyAll()

remove(Worksheet sheet)

public void remove(Worksheet sheet)

Removes module for a worksheet.

Parameters:

Parameter	Type	Description
sheet	Worksheet	The worksheet

remove(String name)

public void remove(String name)

Remove the module by the name

Parameters:

Parameter	Type	Description
name	java.lang.String

removeAt(int index)

public void removeAt(int index)

Removes the item at the specified index.

Parameters:

Parameter	Type	Description
index	int	The zero-based index of the item to remove.

toString()

public String toString()

Returns: java.lang.String

wait()

public final void wait()

wait(long arg0)

public final native void wait(long arg0)

Parameters:

Parameter	Type	Description
arg0	long

wait(long arg0, int arg1)

public final void wait(long arg0, int arg1)

Parameters:

Parameter	Type	Description
arg0	long
arg1	int