View source for AddressBookGroup

{{DeprecatedItem|version=2019r2}}
{{ClassBox
| super=[[AddressBookRecord]]
| platform=mac
| scope=global
}}
{{Description
|text=Manages an Address Book group.
}}

<dynamicTable id="Properties" super="AddressBookRecord" class="propertyTable" title="Properties" columns="3">
{{Property | name=Name | type=String | platform=all | description=( String)&nbsp;&nbsp;The name of the group. }}
</dynamicTable>

<dynamicTable id="Methods" super="AddressBookRecord" class="methodTable" title="Methods" columns="3">
{{Method | name=Add | params=Record as [[AddressBookRecord]] | description=Add(Record as AddressBookRecord)&#10;Adds the record or group to the Address Book.  }}
{{Method | name=Contacts | returntype=[[AddressBookContact]] | description=Contacts() as AddressBookContact&#10;Returns an AddressBookContact array of people in the group. }}
{{Method | name=Groups | returntype='''AddressBookGroup''' | description=Groups() as AddressBookGroup&#10;Returns an AddressBookGroup array of subgroups in the group. }}
{{Method | name=Remove | params=Record as [[AddressBookRecord]] | description=Remove(Record as AddressBookRecord)&#10;Removes the passed record, whether it is a contact or a subgroup. }}
</dynamicTable>

== Sample Code ==
This example gets the names of the groups in the current user's Address Book and displays them in a [[ListBox]].
<rbcode>
Dim book As AddressBook
Dim groups() As AddressBookGroup
Dim i As Integer

book = System.AddressBook
groups = book.Groups
For i = 0 To Ubound(groups)
  ListBox1.addrow groups(i).Name
Next
</rbcode>

This code gets two Contact fields from the first group and displays them in a [[ListBox]].
<rbcode>
Dim book As AddressBook
Dim groups() As AddressBookGroup
Dim contacts() As AddressBookContact
Dim i As Integer

book = System.AddressBook
groups = book.Groups // get the array of groups, assume at least one group

contacts = groups(0).Contacts // get array of contacts in first group
For i = 0 To Ubound(contacts)
  ListBox1.AddRow(contacts(i).CompanyName)
  ListBox1.Cell(i, 1) = contacts(i).LastName
Next
</rbcode>

==See Also==
[[AddressBook]], [[AddressBookAddress]], [[AddressBookContact]], [[AddressBookData]], [[AddressBookRecord]] classes.

[[Category:Macintosh_Address_Books]]
[[Category:Language_Classes]]
[[Category:Macintosh_Address_Books]]