PeoplePicker Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Control which allows user to search for a person or contact within Microsoft Graph. Built on top of TokenizingTextBox.
public class PeoplePicker : Microsoft.Toolkit.Uwp.UI.Controls.TokenizingTextBoxtype PeoplePicker = class
inherit TokenizingTextBoxPublic Class PeoplePicker
Inherits TokenizingTextBox- Inheritance
Constructors
| PeoplePicker() |
Initializes a new instance of the PeoplePicker class. |
Properties
| AutoSuggestBoxStyle |
Gets or sets the Style for the contained AutoSuggestBox template part. (Inherited from TokenizingTextBox) |
| AutoSuggestBoxTextBoxStyle |
Gets or sets the Style for the TextBox part of the AutoSuggestBox template part. (Inherited from TokenizingTextBox) |
| MaximumTokens |
Gets or sets the maximum number of token results allowed at a time. (Inherited from TokenizingTextBox) |
| PlaceholderText |
Gets or sets the PlaceholderText for the AutoSuggestBox template part. (Inherited from TokenizingTextBox) |
| QueryIcon |
Gets or sets the icon to display in the AutoSuggestBox template part. (Inherited from TokenizingTextBox) |
| SelectedTokenText |
Gets the complete text value of any selection in the control. The result is the same text as would be copied to the clipboard. (Inherited from TokenizingTextBox) |
| SuggestedItemContainerStyle |
Gets or sets the item container style for displaying suggested tokens. (Inherited from TokenizingTextBox) |
| SuggestedItemsSource |
Gets or sets the items source for token suggestions. (Inherited from TokenizingTextBox) |
| SuggestedItemTemplate |
Gets or sets the template for displaying suggested tokens. (Inherited from TokenizingTextBox) |
| SuggestedItemTemplateSelector |
Gets or sets the template selector for displaying suggested tokens. (Inherited from TokenizingTextBox) |
| TabNavigateBackOnArrow |
Gets or sets a value indicating whether the control will move focus to the previous control when an arrow key is pressed and selection is at one of the limits in the control. (Inherited from TokenizingTextBox) |
| Text |
Gets or sets the input text of the currently active text edit. (Inherited from TokenizingTextBox) |
| TextMemberPath |
Gets or sets the TextMemberPath of the AutoSuggestBox template part. (Inherited from TokenizingTextBox) |
| TokenDelimiter |
Gets or sets delimiter used to determine when to process text input as a new token item. (Inherited from TokenizingTextBox) |
| TokenItemTemplate |
Gets or sets the template for token items. (Inherited from TokenizingTextBox) |
| TokenItemTemplateSelector |
Gets or sets the template selector for token items. (Inherited from TokenizingTextBox) |
| TokenSpacing |
Gets or sets the spacing value used to separate token items. (Inherited from TokenizingTextBox) |
Methods
| AddTokenItem(Object, Boolean) |
Adds the specified data item as a new token to the collection, will raise the TokenItemAdding event asynchronously still for confirmation. (Inherited from TokenizingTextBox) |
| ClearAsync() |
Clears the whole collection, will raise the TokenItemRemoving event asynchronously for each item. (Inherited from TokenizingTextBox) |
| GetContainerForItemOverride() | (Inherited from TokenizingTextBox) |
| IsItemItsOwnContainerOverride(Object) | (Inherited from TokenizingTextBox) |
| OnApplyTemplate() | (Inherited from TokenizingTextBox) |
| OnCreateAutomationPeer() |
Creates AutomationPeer (Windows.UI.Xaml.UIElement.OnCreateAutomationPeer) (Inherited from TokenizingTextBox) |
| PrepareContainerForItemOverride(DependencyObject, Object) | (Inherited from TokenizingTextBox) |
| UpdateCurrentTextEdit(ITokenStringContainer) |
Helper to change out the currently focused text element in the control. (Inherited from TokenizingTextBox) |
Events
| QuerySubmitted |
Event raised when the user submits the text query. (Inherited from TokenizingTextBox) |
| SuggestionChosen |
Event raised when a suggested item is chosen by the user. (Inherited from TokenizingTextBox) |
| TextChanged |
Event raised when the text input value has changed. (Inherited from TokenizingTextBox) |
| TokenItemAdded |
Event raised when a new token item has been added. (Inherited from TokenizingTextBox) |
| TokenItemAdding |
Event raised before a new token item is created from a string, can be used to transform data type from text user entered. (Inherited from TokenizingTextBox) |
| TokenItemRemoved |
Event raised after a token has been removed. (Inherited from TokenizingTextBox) |
| TokenItemRemoving |
Event raised when a token item is about to be removed. Can be canceled to prevent removal of a token. (Inherited from TokenizingTextBox) |