Class VbaProjectReferenceCollection

Namespace: Aspose.Cells.Vba
Assembly: Aspose.Cells.dll (25.2.0)

Represents all references of VBA project.

public class VbaProjectReferenceCollection : CollectionBase<vbaprojectreference>, IList<vbaprojectreference>, ICollection<vbaprojectreference>, IEnumerable<vbaprojectreference>, ICollection, IEnumerable

Inheritance

object ← CollectionBase<vbaprojectreference> ← VbaProjectReferenceCollection

Implements

IList<vbaprojectreference>, ICollection<vbaprojectreference>, IEnumerable<vbaprojectreference>, ICollection, IEnumerable

Inherited Members

CollectionBase<vbaprojectreference>.BinarySearch(VbaProjectReference), CollectionBase<vbaprojectreference>.BinarySearch(VbaProjectReference, IComparer<vbaprojectreference>), CollectionBase<vbaprojectreference>.BinarySearch(int, int, VbaProjectReference, IComparer<vbaprojectreference>), CollectionBase<vbaprojectreference>.Contains(VbaProjectReference), CollectionBase<vbaprojectreference>.CopyTo(VbaProjectReference[]), CollectionBase<vbaprojectreference>.CopyTo(VbaProjectReference[], int), CollectionBase<vbaprojectreference>.CopyTo(int, VbaProjectReference[], int, int), CollectionBase<vbaprojectreference>.Exists(Predicate<vbaprojectreference>), CollectionBase<vbaprojectreference>.Find(Predicate<vbaprojectreference>), CollectionBase<vbaprojectreference>.FindAll(Predicate<vbaprojectreference>), CollectionBase<vbaprojectreference>.FindIndex(Predicate<vbaprojectreference>), CollectionBase<vbaprojectreference>.FindIndex(int, Predicate<vbaprojectreference>), CollectionBase<vbaprojectreference>.FindIndex(int, int, Predicate<vbaprojectreference>), CollectionBase<vbaprojectreference>.FindLast(Predicate<vbaprojectreference>), CollectionBase<vbaprojectreference>.FindLastIndex(Predicate<vbaprojectreference>), CollectionBase<vbaprojectreference>.FindLastIndex(int, Predicate<vbaprojectreference>), CollectionBase<vbaprojectreference>.FindLastIndex(int, int, Predicate<vbaprojectreference>), CollectionBase<vbaprojectreference>.IndexOf(VbaProjectReference), CollectionBase<vbaprojectreference>.IndexOf(VbaProjectReference, int), CollectionBase<vbaprojectreference>.IndexOf(VbaProjectReference, int, int), CollectionBase<vbaprojectreference>.LastIndexOf(VbaProjectReference), CollectionBase<vbaprojectreference>.LastIndexOf(VbaProjectReference, int), CollectionBase<vbaprojectreference>.LastIndexOf(VbaProjectReference, int, int), CollectionBase<vbaprojectreference>.GetEnumerator(), CollectionBase<vbaprojectreference>.Clear(), CollectionBase<vbaprojectreference>.RemoveAt(int), CollectionBase<vbaprojectreference>.OnClearComplete(), CollectionBase<vbaprojectreference>.OnClear(), CollectionBase<vbaprojectreference>.Capacity, CollectionBase<vbaprojectreference>.Count, CollectionBase<vbaprojectreference>.InnerList, CollectionBase<vbaprojectreference>.this[int], object.GetType(), object.MemberwiseClone(), object.ToString(), object.Equals(object?), object.Equals(object?, object?), object.ReferenceEquals(object?, object?), object.GetHashCode()

Examples

//Instantiating a Workbook object
Workbook workbook = new Workbook();
 // Init VBA project.
VbaProject vbaProject = workbook.VbaProject;
// Add vba project reference
vbaProject.References.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");

'Instantiating a Workbook object
Dim workbook As Workbook = New Workbook()
'Init VBA project.
Dim vbaProject as VbaProject  = workbook.VbaProject
'Add vba project reference
vbaProject.References.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")

Properties

this[int]

Get the reference in the list by the index.

public VbaProjectReference this[int i] { get; }

Property Value

VbaProjectReference

Methods

AddControlRefrernce(string, string, string, string)

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

public int AddControlRefrernce(string name, string libid, string twiddledlibid, string extendedLibid)

Parameters

name string

The name of reference.

libid string

The identifier of an Automation type library.

twiddledlibid string

The identifier of a twiddled type library

extendedLibid string

The identifier of an extended type library

Returns

int

AddProjectRefrernce(string, string, string)

Adds a reference to an external VBA project.

public int AddProjectRefrernce(string name, string absoluteLibid, string relativeLibid)

Parameters

name string

The name of reference.

absoluteLibid string

The referenced VBA project’s identifier with an absolute path.

relativeLibid string

The referenced VBA project’s identifier with an relative path.

Returns

int

AddRegisteredReference(string, string)

Add a reference to an Automation type library.

public int AddRegisteredReference(string name, string libid)

Parameters

name string

The name of reference.

libid string

The identifier of an Automation type library.

Returns

int

Copy(VbaProjectReferenceCollection)

Copies references from other VBA project.

public void Copy(VbaProjectReferenceCollection source)

Parameters

source VbaProjectReferenceCollection

The source references. </vbaprojectreference></vbaprojectreference></vbaprojectreference></vbaprojectreference></vbaprojectreference></vbaprojectreference></vbaprojectreference></vbaprojectreference></vbaprojectreference></vbaprojectreference></vbaprojectreference></vbaprojectreference></vbaprojectreference></vbaprojectreference></vbaprojectreference></vbaprojectreference></vbaprojectreference></vbaprojectreference></vbaprojectreference></vbaprojectreference></vbaprojectreference></vbaprojectreference></vbaprojectreference></vbaprojectreference></vbaprojectreference></vbaprojectreference></vbaprojectreference></vbaprojectreference></vbaprojectreference></vbaprojectreference></vbaprojectreference></vbaprojectreference></vbaprojectreference></vbaprojectreference></vbaprojectreference></vbaprojectreference></vbaprojectreference></vbaprojectreference></vbaprojectreference></vbaprojectreference></vbaprojectreference></vbaprojectreference></vbaprojectreference></vbaprojectreference></vbaprojectreference></vbaprojectreference></vbaprojectreference></vbaprojectreference>