ContactPickerUI Clase

Definición

Espacio de nombres:

Windows.ApplicationModel.Contacts.Provider

Permite llamar a la interfaz de usuario del selector de contactos para que pueda seleccionar uno o varios contactos.

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

Herencia

Object Platform::Object IInspectable ContactPickerUI

Atributos

ContractVersionAttribute

Requisitos de Windows

Familia de dispositivos	Windows 10 (se introdujo en la versión 10.0.10240.0)
API contract	Windows.Foundation.UniversalApiContract (se introdujo en la versión v1.0)
Características de aplicaciones	contactsSystem

Ejemplos

Este código de ejemplo prepara la página para usar 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;
            }
        }
    });
}

En este código de ejemplo se muestra cómo agregar un contacto a la cesta con el método 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;
}

Este código de ejemplo muestra cómo quitar un contacto de la cesta y responder a su eliminación.

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

Comentarios

Para ver un ejemplo de cómo usar esta clase, consulte nuestro ejemplo de código.

Propiedades

DesiredFields	Especifica los campos que desea que se devuelvan después de que el usuario seleccione uno o varios contactos. Nota DesiredFields puede modificarse o no estar disponible para las versiones después de Windows 8.1. En su lugar, use DesiredFieldsWithContactFieldType.
DesiredFieldsWithContactFieldType	Obtiene los campos con el tipo de campo de contacto que desea devolver después de que el usuario seleccione uno o varios contactos.
SelectionMode	Determina el modo de selección del selector de contactos. Las opciones más comunes son PickSingleContactAsync o PickMultipleContactsAsync.

Métodos

AddContact(Contact)	Agrega un contacto.
AddContact(String, Contact)	Agrega un contacto. Nota AddContact puede modificarse o no estar disponible para las versiones después de Windows 8.1. En su lugar, use AddContact sin el identificador.
ContainsContact(String)	Comprueba si el usuario ya seleccionó el contacto.
RemoveContact(String)	Quita un contacto.

Eventos

ContactRemoved

Se produce cuando el usuario anula la selección o quita el contacto.