ContactPickerUI クラス

定義

名前空間:

Windows.ApplicationModel.Contacts.Provider

1 つ以上の連絡先を選択できるように、連絡先ピッカー UI を呼び出すことができます。

public ref class ContactPickerUI sealed

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
class ContactPickerUI final

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
public sealed class ContactPickerUI

Public NotInheritable Class ContactPickerUI

継承

Object Platform::Object IInspectable ContactPickerUI

属性

ContractVersionAttribute

Windows の要件

デバイス ファミリ	Windows 10 (10.0.10240.0 で導入)
API contract	Windows.Foundation.UniversalApiContract (v1.0 で導入)
アプリの機能	contactsSystem

例

次のコード例では、ContactPickerUI を使用するようにページを準備します。

ContactPickerUI contactPickerUI = MainPagePicker.Current.contactPickerUI;
CoreDispatcher dispatcher = Window.Current.Dispatcher;

public ContactPickerPage()
{
    this.InitializeComponent();
    ContactList.ItemsSource = contactSet;
    ContactList.SelectionChanged += ContactList_SelectionChanged;
}

protected override void OnNavigatedTo(NavigationEventArgs e)
{
    contactPickerUI.ContactRemoved += contactPickerUI_ContactRemoved;
}

protected override void OnNavigatedFrom(NavigationEventArgs e)
{
    contactPickerUI.ContactRemoved -= contactPickerUI_ContactRemoved;
}

async void contactPickerUI_ContactRemoved(ContactPickerUI sender, ContactRemovedEventArgs args)
{
    // The event handler may be invoked on a background thread, so use the Dispatcher to run the UI-related code on the UI thread.
    string removedId = args.Id;
    await dispatcher.RunAsync(CoreDispatcherPriority.Normal, () =>
    {
        foreach (SampleContact contact in ContactList.SelectedItems)
        {
            if (contact.Id == removedId)
            {
                ContactList.SelectedItems.Remove(contact);
                OutputText.Text += "\n" + contact.DisplayName + " was removed from the basket";
                break;
            }
        }
    });
}

このコード例では、 AddContact(Contact) メソッドを使用してバスケットに連絡先を追加する方法を示します。

switch (contactPickerUI.AddContact(contact))
{
    case AddContactResult.Added:
        // Notify the user that the contact was added
        OutputText.Text = contact.DisplayName + " was added to the basket";
        break;
    case AddContactResult.AlreadyAdded:
        // Notify the user that the contact is already added
        OutputText.Text = contact.DisplayName + " is already in the basket";
        break;
    case AddContactResult.Unavailable:
    default:
        // Notify the user that the basket is unavailable
        OutputText.Text = contact.DisplayName + " could not be added to the basket";
        break;
}

このコード例は、バスケットから連絡先を削除し、その削除に応答する方法を示しています。

foreach (SampleContact removed in e.RemovedItems)
{
    if (contactPickerUI.ContainsContact(removed.Id))
    {
        contactPickerUI.RemoveContact(removed.Id);
        OutputText.Text = removed.DisplayName + " was removed from the basket";
    }
}

注釈

このクラスの使用方法の例を確認するには、コード サンプルをチェックします。

プロパティ

DesiredFields	ユーザーが 1 つ以上の連絡先を選択した後に返すフィールドを指定します。 注意 desiredFields は、Windows 8.1後にリリースで変更または使用できない場合があります。 代わりに、 DesiredFieldsWithContactFieldType を使用します。
DesiredFieldsWithContactFieldType	ユーザーが 1 つ以上の連絡先を選択した後に返される連絡先フィールドの種類を持つフィールドを取得します。
SelectionMode	連絡先ピッカーの選択モードを決定します。 最も一般的なオプションは 、PickSingleContactAsync または PickMultipleContactsAsync です。

メソッド

AddContact(Contact)	連絡先を追加 します。
AddContact(String, Contact)	連絡先を追加 します。 注意 addContact は、Windows 8.1後にリリースで変更または使用できない場合があります。 代わりに、ID なしで AddContact を使用します。
ContainsContact(String)	連絡先がユーザーによって既に選択されているかどうかを確認します。
RemoveContact(String)	連絡先を削除します。

イベント

ContactRemoved

ユーザーが連絡先の選択を解除または削除したときに発生します。