XL97: How to Programmatically Create a Collection

This article was previously published under Q161215
This article has been archived. It is offered "as is" and will no longer be updated.
SUMMARY
New programming functionality in Microsoft Excel 97 allows you to create acollection. A collection is a predefined object that stores groups ofrelated objects. A collection makes it easier to work with the objectgroup. For example, you can use a For Each looping structure to loopthrough the collection. Each time the macro executes the loop it referencesa different object in the collection until all objects in the collectionare referenced once.

This article includes a sample Visual Basic for Applications macro thatcreates and references a collection.
MORE INFORMATION
Microsoft provides programming examples for illustration only, without warranty either expressed or implied, including, but not limited to, the implied warranties of merchantability and/or fitness for a particular purpose. This article assumes that you are familiar with the programming language being demonstrated and the tools used to create and debug procedures. Microsoft support professionals can help explain the functionality of a particular procedure, but they will not modify these examples to provide added functionality or construct procedures to meet your specific needs.
If you have limited programming experience, you may want to contact a Microsoft Certified Partner or Microsoft Advisory Services. For more information, visit these Microsoft Web sites:

Microsoft Certified Partners - https://partner.microsoft.com/global/30000104

Microsoft Advisory Services - http://support.microsoft.com/gp/advisoryservice

For more information about the support options that are available and about how to contact Microsoft, visit the following Microsoft Web site:http://support.microsoft.com/default.aspx?scid=fh;EN-US;CNTACTMSIn general, declare an object as a new collection to create the collection.After you create the Collection object, add items to the collection usingthe Add method or remove items using the Remove method.

  1. Create a new workbook and start the Visual Basic Editor (press ALT+F11).
  2. On the Insert menu, click Class Module.
  3. In the class module, type the following declaration:
           Public EmployeeName As String						
    You typically use a public variable in a class modules to define properties for the class.
  4. If the Properties window is not visible, click Properties on the View menu.
  5. If the Project Explorer window is not visible, click Project Explorer on the view menu.
  6. In the Project Explorer, click the class module you inserted in the project in step 2.
  7. In the Properties window, change the (Name) property of the class module to EmpClass.
  8. On the Insert menu, click Module.
  9. In this module, type the following code:
                  Sub MyCollection()           Dim employees As New Collection   'Create the collection object.           Dim num As Integer           num = 0    'Counter for number of employees added to the                      'collection.           Do               Dim employee As New EmpClass    'Create new instance of the                                               'EmpClass class.               num = num + 1               newname = InputBox("Enter new employee name" & Chr(13) _                   & "or press Cancel to see list of employees.")               If newname <> "" Then   'You did not press Cancel.                   employee.EmployeeName = newname                   employees.Add Item:=employee, key:=CStr(num)                   Set employee = Nothing    'Clear the current reference                                             'in preparation for next one.               End If           Loop Until newname = ""  'You pressed Cancel.           For Each x In employees               MsgBox x.EmployeeName 'Display the employee name.           Next           MsgBox employees.Count  'Current number of employees incollection.           For Each x In employees               employees.Remove 1   'Remove each employee from thecollection.           Next           MsgBox employees.Count 'Display a count of zero because                                  'all employees were removed from the                                  'collection.       End Sub
  10. Run the MyCollection macro.
  11. When you are prompted, type any names, and then click Cancel to stop typing names.
Message boxes that display each of the names you typed appear. Then, amessage box that displays a count of the names you typed appears. Anothermessage box with a count of zero appears because the last For Each loopremoves each employee from the collection.
REFERENCES
For more information about the Add Method, click the Index tab inVisual Basic for Applications Help, type the following text
add method
and then double-click the selected text to go to the "Add Method (VisualBasic for Applications)" topic.

For more information about Collections, click the Index tab inVisual Basic for Applications Help, type the following text
collections, described
and then double-click the selected text to go to the "Collection Object"topic.
97 for Windows XL97
Properties

Article ID: 161215 - Last Review: 10/04/2013 18:09:37 - Revision: 2.4

  • Microsoft Excel 97 Standard Edition
  • kbnosurvey kbarchive kbdtacode kbprogramming KB161215
Feedback