FMX.AddressBook.TCustomAddressBook.CreateGroup
Delphi
function CreateGroup(const ASource: TAddressBookSource = nil): TAddressBookGroup;
C++
TAddressBookGroup* __fastcall CreateGroup(TAddressBookSource* const ASource = (TAddressBookSource*)(0x0));
Properties
Type | Visibility | Source | Unit | Parent |
---|---|---|---|---|
function | public | FMX.AddressBook.pas FMX.AddressBook.hpp |
FMX.AddressBook | TCustomAddressBook |
Description
Creates a new group in the specified source in a device Address Book.
Use this method to create and add a new group to the specified source in a device Address Book (Android or iOS).
Note If you call this method without the input argument
ASource
, the source is considered to benil
. In this scenario, for some types of mobile devices, we cannot ensure that the newly created group is in sync with cloud-based storages.
Examples
To clarify, consider the following example. These code snippets illustrate how to create a new group in the specified source, and then set the group name.
Delphi:
var
Group: TAddressBookGroup;
Source: TAddressBookSource;
begin
// Create a new group in the specified source
// For example, you can set the Source variable to AddressBook1.DefaultSource to create a group in the default source
Source := AddressBook1.DefaultSource;
Group := AddressBook1.CreateGroup(Source);
if (Group <> nil) then
try
// Set the group name.
Group.Name := 'MyFirstGroup';
AddressBook1.SaveGroup(Group);
finally
Group.Free;
end
else
ShowMessage('Cannot create a group');
end.
C++Builder:
{
// Create new group in the specified source.
// For example, you can set the Source variable to AddressBook1->DefaultSource() to create a group in the default source
TAddressBookSource *Source = AddressBook1->DefaultSource();
TAddressBookGroup *Group = AddressBook1->CreateGroup(Source);
if (Group != NULL) {
__try {
Group->Name = "MyFirstGroup";
AddressBook1->SaveGroup(Group);
}
__finally {
Group->Free();
}
}
else {
ShowMessage("Cannot create a group");
}
}
For more information and samples, see Mobile Tutorial: Using an Address Book Component (iOS and Android).