VbaProjectReferenceCollection

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

public class VbaProjectReferenceCollection extends CollectionBase

Represents all references of VBA project.

Example

         //Instantiating a Workbook object
         Workbook workbook = new Workbook();
          // Init VBA project.
         VbaProject vbaProject = workbook.getVbaProject();
         // Add vba project reference
         vbaProject.getReferences().addRegisteredReference("stdole", "*\\G{00020430-0000-0000-C000-000000000046}#2.0#0#C:\\Windows\\system32\\stdole2.tlb#OLE Automation");
         //Saving the Excel file
         workbook.save("book1.xlsm");

Methods

MethodDescription
add(Object o)Adds an item to the CollectionBase instance.
addControlRefrernce(String name, String libid, String twiddledlibid, String extendedLibid)Add a reference to a twiddled type library and its extended type library.
addProjectRefrernce(String name, String absoluteLibid, String relativeLibid)Adds a reference to an external VBA project.
addRegisteredReference(String name, String libid)Add a reference to an Automation type library.
clear()Removes all objects from the CollectionBase instance.
contains(Object o)Return whether instance contains this object
copy(VbaProjectReferenceCollection source)Copies references from other VBA project.
equals(Object arg0)
get(int i)Get the reference in the list by the index.
getClass()
getCount()Gets the number of elements contained in the CollectionBase instance.
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()
removeAt(int index)Removes the item at the specified index.
toString()
wait()
wait(long arg0)
wait(long arg0, int arg1)

add(Object o)

public int add(Object o)

Adds an item to the CollectionBase instance.

Parameters:

ParameterTypeDescription
ojava.lang.ObjectThe Object to add to the CollectionBase instance.

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

addControlRefrernce(String name, String libid, String twiddledlibid, String extendedLibid)

public int addControlRefrernce(String name, String libid, String twiddledlibid, String extendedLibid)

Add a reference to a twiddled type library and its extended type library.

Parameters:

ParameterTypeDescription
namejava.lang.StringThe name of reference.
libidjava.lang.StringThe identifier of an Automation type library.
twiddledlibidjava.lang.StringThe identifier of a twiddled type library
extendedLibidjava.lang.StringThe identifier of an extended type library

Returns: int -

addProjectRefrernce(String name, String absoluteLibid, String relativeLibid)

public int addProjectRefrernce(String name, String absoluteLibid, String relativeLibid)

Adds a reference to an external VBA project.

Parameters:

ParameterTypeDescription
namejava.lang.StringThe name of reference.
absoluteLibidjava.lang.StringThe referenced VBA project’s identifier with an absolute path.
relativeLibidjava.lang.StringThe referenced VBA project’s identifier with an relative path.

Returns: int -

addRegisteredReference(String name, String libid)

public int addRegisteredReference(String name, String libid)

Add a reference to an Automation type library.

Parameters:

ParameterTypeDescription
namejava.lang.StringThe name of reference.
libidjava.lang.StringThe identifier of an Automation type library.

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:

ParameterTypeDescription
ojava.lang.Objecttest object

Returns: boolean - Whether instance contains this object

copy(VbaProjectReferenceCollection source)

public void copy(VbaProjectReferenceCollection source)

Copies references from other VBA project.

Parameters:

ParameterTypeDescription
sourceVbaProjectReferenceCollectionThe source references.

equals(Object arg0)

public boolean equals(Object arg0)

Parameters:

ParameterTypeDescription
arg0java.lang.Object

Returns: boolean

get(int i)

public VbaProjectReference get(int i)

Get the reference in the list by the index.

Parameters:

ParameterTypeDescription
iintThe index.

Returns: VbaProjectReference -

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.

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:

ParameterTypeDescription
ojava.lang.ObjectDetermines 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()

removeAt(int index)

public void removeAt(int index)

Removes the item at the specified index.

Parameters:

ParameterTypeDescription
indexintThe 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:

ParameterTypeDescription
arg0long

wait(long arg0, int arg1)

public final void wait(long arg0, int arg1)

Parameters:

ParameterTypeDescription
arg0long
arg1int