<div class="meta" robots="noindex">

</div>

Class

# AddressBookGroup

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

<div class="warning">

<div class="title">

Warning

</div>

This item was deprecated in version 2019r2. There is no replacement.

</div>

## Description

Manages an Address Book group.

## Properties

<div class="rst-class">

table-centered_columns_3_and_4

</div>

| Name                                                  | Type                             | Read-Only | Shared |
|-------------------------------------------------------|----------------------------------|-----------|--------|
| `CreationDate<addressbookgroup.creationdate>`         | `Date</api/deprecated/date>`     |           |        |
| `ModificationDate<addressbookgroup.modificationdate>` | `Date</api/deprecated/date>`     |           |        |
| `Name<addressbookgroup.name>`                         | `String</api/data_types/string>` |           |        |
| `UniqueID<addressbookgroup.uniqueid>`                 | `String</api/data_types/string>` |           |        |

## Methods

<div class="rst-class">

table-centered_column_4

</div>

| Name                                        | Parameters                                                       | Returns                                                  | Shared |
|---------------------------------------------|------------------------------------------------------------------|----------------------------------------------------------|--------|
| `Add<addressbookgroup.add>`                 | Record As `AddressBookRecord</api/deprecated/addressbookrecord>` |                                                          |        |
| `Contacts<addressbookgroup.contacts>`       |                                                                  | `AddressBookContact</api/deprecated/addressbookcontact>` |        |
| `Groups<addressbookgroup.groups>`           |                                                                  | AddressBookGroup                                         |        |
| `Remove<addressbookgroup.remove>`           | Record As `AddressBookRecord</api/deprecated/addressbookrecord>` |                                                          |        |
| `RemoveValue<addressbookgroup.removevalue>` | PropertyName As `String</api/data_types/string>`                 |                                                          |        |
| `Value<addressbookgroup.value>`             | PropertyName As `String</api/data_types/string>`                 | `Variant</api/data_types/variant>`                       |        |

## Property descriptions

<div id="addressbookgroup.creationdate">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

AddressBookGroup.CreationDate

**CreationDate** As `Date</api/deprecated/date>`

Returns the creation date of the record.

<div id="addressbookgroup.modificationdate">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

AddressBookGroup.ModificationDate

**ModificationDate** As `Date</api/deprecated/date>`

Returns the last modification date of the record.

<div id="addressbookgroup.name">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

AddressBookGroup.Name

**Name** As `String</api/data_types/string>`

<div id="addressbookgroup.uniqueid">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

AddressBookGroup.UniqueID

**UniqueID** As `String</api/data_types/string>`

Returns the unique ID corresponding to the record.

## Method descriptions

<div id="addressbookgroup.add">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

AddressBookGroup.Add

**Add**(Record As `AddressBookRecord</api/deprecated/addressbookrecord>`)

Adds the record or group to the Address Book.

If *Record* is a group, it adds it as a subgroup. If it is a contact, it adds it as a member of the group.

<div id="addressbookgroup.contacts">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

AddressBookGroup.Contacts

**Contacts** As `AddressBookContact</api/deprecated/addressbookcontact>`

Returns an `AddressBookContact</api/deprecated/addressbookcontact>` array of people in the group.

<div id="addressbookgroup.groups">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

AddressBookGroup.Groups

**Groups** As AddressBookGroup

Returns an <span class="title-ref">AddressBookGroup</span> array of subgroups in the group.

<div id="addressbookgroup.remove">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

AddressBookGroup.Remove

**Remove**(Record As `AddressBookRecord</api/deprecated/addressbookrecord>`)

Removes the passed record, whether it is a contact or a subgroup.

<div id="addressbookgroup.removevalue">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

AddressBookGroup.RemoveValue

**RemoveValue**(PropertyName As `String</api/data_types/string>`)

Removes the value for the specified property.

<div id="addressbookgroup.value">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

AddressBookGroup.Value

**Value**(PropertyName As `String</api/data_types/string>`) As `Variant</api/data_types/variant>`

Sets the value for the specified property as a `Variant</api/data_types/variant>`.

## Sample code

This example gets the names of the groups in the current user's Address Book and displays them in a `ListBox</api/deprecated/listbox>`.

``` xojo
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
```

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

This code gets two Contact fields from the first group and displays them in a `ListBox</api/deprecated/listbox>`.

``` xojo
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
```

## Compatibility

All project types on all supported operating systems.

## See also

`AddressBookRecord</api/deprecated/addressbookrecord>` parent class; `AddressBook</api/deprecated/addressbook>`, `AddressBookAddress</api/deprecated/addressbookaddress>`, `AddressBookContact</api/deprecated/addressbookcontact>`, `AddressBookData</api/deprecated/addressbookdata>`, `AddressBookRecord</api/deprecated/addressbookrecord>` classes.
