ContactPickerUI Klasse

Referenz

Definition

Namespace:: Windows.ApplicationModel.Contacts.Provider

Wichtig

Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.

Bearbeiten

Ermöglicht das Aufrufen der Kontaktauswahl-Benutzeroberfläche, sodass Sie einen oder mehrere Kontakte auswählen können.

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

Vererbung: Object Platform::Object IInspectable ContactPickerUI

Attribute: ContractVersionAttribute

Windows-Anforderungen

Gerätefamilie	Windows 10 (eingeführt in 10.0.10240.0)
API contract	Windows.Foundation.UniversalApiContract (eingeführt in v1.0)
App-Funktionen	contactsSystem

Beispiele

Dieser Beispielcode bereitet die Seite für die Verwendung von ContactPickerUI vor:

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;
            }
        }
    });
}

Dieser Beispielcode zeigt, wie Sie dem Warenkorb mit der AddContact(Contact)- Methode einen Kontakt hinzufügen.

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;
}

Dieser Beispielcode zeigt, wie Sie einen Kontakt aus dem Warenkorb entfernen und auf seine Entfernung reagieren.

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

Hinweise

Ein Beispiel für die Verwendung dieser Klasse finden Sie in unserem Codebeispiel.

Eigenschaften

DesiredFields	Gibt die Felder an, die zurückgegeben werden sollen, nachdem der Benutzer einen oder mehrere Kontakte ausgewählt hat. Hinweis DesiredFields kann für Releases nach Windows 8.1 geändert oder nicht mehr verfügbar sein. Verwenden Sie stattdessen DesiredFieldsWithContactFieldType.
DesiredFieldsWithContactFieldType	Ruft die Felder mit dem Kontaktfeldtyp ab, die zurückgegeben werden sollen, nachdem der Benutzer einen oder mehrere Kontakte ausgewählt hat.
SelectionMode	Bestimmt den Auswahlmodus für die Kontaktauswahl. Die gängigsten Optionen sind PickSingleContactAsync oder PickMultipleContactsAsync.

Methoden

AddContact(Contact)	Fügt einen Kontakt hinzu.
AddContact(String, Contact)	Fügt einen Kontakt hinzu. Hinweis AddContact kann für Releases nach Windows 8.1 geändert oder nicht mehr verfügbar sein. Verwenden Sie stattdessen AddContact ohne die ID.
ContainsContact(String)	Überprüft, ob der Kontakt bereits vom Benutzer ausgewählt wurde.
RemoveContact(String)	Entfernt einen Kontakt.

Ereignisse

ContactRemoved

Tritt auf, wenn der Benutzer die Auswahl des Kontakts auf hebt oder entfernt.

Gilt für:

Freigeben über