ContactPickerUI Класс

Определение

Пространство имен:

Windows.ApplicationModel.Contacts.Provider

Позволяет вызывать пользовательский интерфейс средства выбора контактов, чтобы можно было выбрать один или несколько контактов.

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	Указывает поля, возвращаемые после выбора пользователем одного или нескольких контактов. Примечание DesiredFields могут быть изменены или недоступны для выпусков после Windows 8.1. Вместо этого используйте DesiredFieldsWithContactFieldType.
DesiredFieldsWithContactFieldType	Возвращает поля с типом поля контакта, которые необходимо вернуть после выбора пользователем одного или нескольких контактов.
SelectionMode	Определяет режим выбора для средства выбора контактов. Наиболее распространенными вариантами являются PickSingleContactAsync или PickMultipleContactsAsync.

Методы

AddContact(Contact)	Добавляет контакт.
AddContact(String, Contact)	Добавляет контакт. Примечание AddContact может быть изменен или недоступен для выпусков после Windows 8.1. Вместо этого используйте AddContact без идентификатора.
ContainsContact(String)	Проверяет, был ли контакт уже выбран пользователем.
RemoveContact(String)	Удаляет контакт.

События

ContactRemoved

Происходит, когда пользователь отменяет выбор или удаляет контакт.