FMX.AddressBook.TCustomAddressBook.AllContactsInGroups
Delphi
procedure AllContactsInGroups(const AGroups: TAddressBookGroups; var AContacts: TAddressBookContacts);
C++
void __fastcall AllContactsInGroups(TAddressBookGroups* const AGroups, TAddressBookContacts* &AContacts);
Properties
| Type | Visibility | Source | Unit | Parent |
|---|---|---|---|---|
procedure function |
public | FMX.AddressBook.pas FMX.AddressBook.hpp |
FMX.AddressBook | TCustomAddressBook |
Description
Gets a list of all contacts that belong to the specified groups.
Use this method to get a list of all contacts from the specified groups AGroups. The input parameter AGroups refers to a list of groups.
Examples
To clarify, consider the following examples. These code snippets illustrate how to list all contacts from the specified groups Group1 and Group2.
Delphi:
var
MyGroups: TAddressBookGroups;
Group1, Group2: TAddressBookGroup;
MyContacts: TAddressBookContacts;
s: string;
i: Integer;
begin
// Create a list of groups (Group1 and Group2)
MyGroups := TAddressBookGroups.Create;
try
// Group1 and Group2 should be defined earlier
MyGroups.Add(Group1);
MyGroups.Add(Group2);
MyContacts := TAddressBookContacts.Create;
try
// Get all contacts from the Group1 and Group2 groups.
AddressBook1.AllContactsInGroups(MyGroups, MyContacts);
s := Format('Contacts from the %s and %s groups' + sLineBreak,
[Group1.Name, Group2.Name]);
// Output the list of contacts
for i := 0 to MyContacts.Count - 1 do
s := s + MyContacts.Items[i].DisplayName + sLineBreak;
ShowMessage(s);
finally
MyContacts.Free;
end;
finally
MyGroups.Free;
end;
end;
C++Builder:
TAddressBookGroups *myGroups;
TAddressBookContacts *myContacts;
TAddressBookGroup * group1, *group2;
int i;
// Create a list of groups (Group1 and Group2)
myGroups = new TAddressBookGroups();
__try {
group1 = groups->Items[0];
group2 = groups->Items[1];
myGroups->Add(group1);
myGroups->Add(group2);
myContacts = new TAddressBookContacts();
__try {
// Get all contacts from the group1 and group2 groups.
AddressBook1->AllContactsInGroups(myGroups, myContacts);
UnicodeString s = "Contacts from the " + group1->Name + " and " +
group2->Name + " groups:" + sLineBreak;
for (i = 0; i < myContacts->Count; i++) {
s = s + myContacts->Items[i]->DisplayName + sLineBreak;
}
ShowMessage(s);
}
__finally {
myContacts->Free();
}
}
__finally {
myGroups->Free();
}
For more information and samples, see Mobile Tutorial: Using an Address Book Component (iOS and Android).