Monkeybread Software - MBS FileMaker Plugin: CNContactPicker.SetDisplayedKeys

Components	All	New	MacOS		Windows		Linux		iOS
Examples	Mac & Win		Server	Client	Guides	Statistic	FMM	Blog	Deprecated	Old

CNContactPicker.SetDisplayedKeys

Sets what keys to display in the picker.

Component	Version	macOS	Windows	Linux	Server	iOS SDK
Contacts	16.3	✅ Yes	❌ No	❌ No	❌ No	✅ Yes

MBS( "CNContactPicker.SetDisplayedKeys"; Keys ) More

Parameters

Parameter Description Example

Keys The list of keys to show.
Default is an empty list to show the default key list.

Parameter	Description	Example
Keys	The list of keys to show. Default is an empty list to show the default key list.

Result

Returns OK or error.

Description

Sets what keys to display in the picker.
The key list may include the following names: type, namePrefix, givenName, middleName, familyName, previousFamilyName, nameSuffix, nickname, organizationName, departmentName, jobTitle, phoneticGivenName, phoneticMiddleName, phoneticFamilyName, phoneticOrganizationName, note, imageData, thumbnailImageData, imageDataAvailable, phoneNumbers, emailAddresses, postalAddresses, urlAddresses, contactRelations, socialProfiles, instantMessageAddresses, dates, birthday, nonGregorianBirthday.

Examples

Set default selection:

Set Variable [ $r ; Value: MBS( "CNContactPicker.SetDisplayedKeys"; "") ]
Set default selection:

Set to show phone numbers:

Set Variable [ $r ; Value: MBS( "CNContactPicker.SetDisplayedKeys"; "phoneNumbers") ]
Set to show phone numbers:

Show picker to pick an address:

Set Variable [ $r ; Value: MBS( "CNContactPicker.SetDisplayedKeys"; "postalAddresses") ]
Set Variable [ $r ; Value: MBS( "CNContactPicker.SetTrigger"; Get(FileName); "PickedProperty") ]
Set Variable [ $r ; Value: MBS( "CNContactPicker.Show") ]
If [ MBS("IsError") ]
Show Custom Dialog [ "Failed to show picker" ; $r ]
End If
Show picker to pick an address:

<?xml version="1.0" encoding="UTF-8"?>
<fmxmlsnippet type="FMObjectList">
  <Step enable="True" id="141" name="Set Variable">
    <Value>
      <Calculation>MBS( "CNContactPicker.SetDisplayedKeys"; "postalAddresses") </Calculation>
    </Value>
    <Repetition>
      <Calculation>1</Calculation>
    </Repetition>
    <Name>$r</Name>
  </Step>
  <Step enable="True" id="141" name="Set Variable">
    <Value>
      <Calculation>MBS( "CNContactPicker.SetTrigger"; Get(FileName); "PickedProperty") </Calculation>
    </Value>
    <Repetition>
      <Calculation>1</Calculation>
    </Repetition>
    <Name>$r</Name>
  </Step>
  <Step enable="True" id="141" name="Set Variable">
    <Value>
      <Calculation>MBS( "CNContactPicker.Show") </Calculation>
    </Value>
    <Repetition>
      <Calculation>1</Calculation>
    </Repetition>
    <Name>$r</Name>
  </Step>
  <Step enable="True" id="68" name="If">
    <Restore state="False"/>
    <Calculation> MBS("IsError") </Calculation>
  </Step>
  <Step enable="True" id="87" name="Show Custom Dialog">
    <Title>
      <Calculation> "Failed to show picker" </Calculation>
    </Title>
    <Message>
      <Calculation>$r </Calculation>
    </Message>
    <Buttons>
      <Button CommitState="True">
        <Calculation>"OK"</Calculation>
      </Button>
      <Button CommitState="False">
        <Calculation>"Cancel"</Calculation>
      </Button>
      <Button CommitState="False"/>
    </Buttons>
  </Step>
  <Step enable="True" id="70" name="End If"/>
</fmxmlsnippet>

Release notes

Version 16.3
- Added CNContactPicker.GetDisplayedKeys and CNContactPicker.SetDisplayedKeys functions.

This function is free to use.

Created 14th May 2026, last changed 18th May 2026

CNContactPicker.GetDisplayedKeys - CNContactPicker.SetTrigger