Working with vCard metadata Leave feedback
vCard, also known as VCF (Virtual Contact File), is a file format standard for electronic business cards. vCards are often attached to e-mail messages, but can be exchanged in other ways. They can contain name and address information, telephone numbers, e-mail addresses, URLs, logos, photographs, and even audio clips.
NoteFor more information on the format please see https://en.wikipedia.org/wiki/VCard
To access Metadata in a vCard, GroupDocs.Metadata API provides the VCardRootPackage.VCardPackageproperty which contains the information extracted from a file. The following are the steps to access metadata in a vCard:
- Load a vCard file
- Get the root metadata package
- Extract the native metadata package using VCardRootPackage.VCardPackage
- Read the extracted vCard properties
The following code snippet gets metadata of a vCard file.
AdvancedUsage.ManagingMetadataForSpecificFormats.
public static void Run()
{
using (Metadata metadata = new Metadata(Constants.InputVcf))
{
var root = metadata.GetRootPackage<VCardRootPackage>();
foreach (var vCard in root.VCardPackage.Cards)
{
Console.WriteLine(vCard.IdentificationRecordset.Name);
PrintArray(vCard.IdentificationRecordset.FormattedNames);
PrintArray(vCard.CommunicationRecordset.Emails);
PrintArray(vCard.CommunicationRecordset.Telephones);
PrintArray(vCard.DeliveryAddressingRecordset.Addresses);
// ...
}
}
}
private static void PrintArray(string[] values)
{
if (values != null)
{
foreach (string value in values)
{
Console.WriteLine(value);
}
}
}
The GroupDocs.Metadata API also provides a way to get Metadata from vCards with descriptive parameters.The steps are given below:
- Load a vCard file
- Get the root metadata package
- Extract the native metadata package using VCardRootPackage.VCardPackage
- Use properties with the Record(s) postfix to get vCard fields along with descriptive parameters
The following code snippet shows how to extract vCard fields along with descriptive parameters.
AdvancedUsage.ManagingMetadataForSpecificFormats.
using (Metadata metadata = new Metadata(Constants.InputVcf))
{
var root = metadata.GetRootPackage<VCardRootPackage>();
foreach (var vCard in root.VCardPackage.Cards)
{
if (vCard.IdentificationRecordset.PhotoUriRecords != null)
{
// Iterate all photos represented by URIs
foreach (var photoUriRecord in vCard.IdentificationRecordset.PhotoUriRecords)
{
// Print the property value
Console.WriteLine(photoUriRecord.Value);
// Print some additional parameters of the property
Console.WriteLine(photoUriRecord.ContentType);
Console.WriteLine(photoUriRecord.MediaTypeParameter);
if (photoUriRecord.TypeParameters != null)
{
foreach (string parameter in photoUriRecord.TypeParameters)
{
Console.WriteLine(parameter);
}
}
Console.WriteLine(photoUriRecord.PrefParameter);
}
}
}
}
The GroupDocs.Metadata API provides the ability to filter vCard properties in order to make finding desired information easier. The code sample below demonstrates hot to use the filtering feature.
AdvancedUsage.ManagingMetadataForSpecificFormats.
public static void Run()
{
using (Metadata metadata = new Metadata(Constants.InputVcf))
{
var root = metadata.GetRootPackage<VCardRootPackage>();
foreach (var vCard in root.VCardPackage.Cards)
{
// Print most preferred work phone numbers and work emails
var filtered = vCard.FilterWorkTags().FilterPreferred();
PrintArray(filtered.CommunicationRecordset.Telephones);
PrintArray(filtered.CommunicationRecordset.Emails);
}
}
}
private static void PrintArray(string[] values)
{
if (values != null)
{
foreach (string value in values)
{
Console.WriteLine(value);
}
}
}
You may easily run the code above and see the feature in action in our GitHub examples:
Along with full featured .NET library we provide simple, but powerful free Apps. You are welcome to view and edit metadata of PDF, DOC, DOCX, PPT, PPTX, XLS, XLSX, emails, images and more with our free online Free Online Document Metadata Viewing and Editing App.
Was this page helpful?
Any additional feedback you'd like to share with us?
Please tell us how we can improve this page.
Thank you for your feedback!
We value your opinion. Your feedback will help us improve our documentation.
