ClientPeoplePicker members

SharePoint Online

The ClientPeoplePicker type exposes the following members.

  Name Description
Public property AccessKey (Inherited from WebControl.)
Protected property Adapter (Inherited from Control.)
Public property AllEntities List of all current picker entities, which should always be in a validated state
Public property AllowEmailAddresses Boolean whether to allow picker to resolve arbitrary email addresses as valid entities
Public property AllowMultipleEntities Boolean whether the control can allow multiple valid entities
Public property AllUrlZones Boolean to allow query of all url zones when resolving against claim providers
Public property AppRelativeTemplateSourceDirectory (Inherited from Control.)
Public property Attributes (Inherited from WebControl.)
Public property AutoFillEnabled Boolean specifying whether the client control should use the autofill client control
Public property BackColor (Inherited from WebControl.)
Public property BindingContainer (Inherited from Control.)
Public property BorderColor (Inherited from WebControl.)
Public property BorderStyle (Inherited from WebControl.)
Public property BorderWidth (Inherited from WebControl.)
Protected property ChildControlsCreated (Inherited from Control.)
Public property ClientID (Inherited from Control.)
Public property ClientIDMode (Inherited from Control.)
Protected property ClientIDSeparator (Inherited from Control.)
Protected property Context (Inherited from Control.)
Public property Controls (Inherited from Control.)
Public property ControlStyle (Inherited from WebControl.)
Public property ControlStyleCreated (Inherited from WebControl.)
Public property CssClass (Inherited from WebControl.)
Public property DataItemContainer (Inherited from Control.)
Public property DataKeysContainer (Inherited from Control.)
Public property Description String specifying the description text to appear below the client control
Protected property DesignMode (Inherited from Control.)
Public property Direction String used to specify direction of the client control for localization
Public property Enabled (Inherited from WebControl.)
Public property EnabledClaimProviders String specifying a specific set of claim providers to use when resolving entities
Public property EnableTheming (Inherited from WebControl.)
Public property EnableViewState (Inherited from Control.)
Public property ErrorMessage
Protected property Events (Inherited from Control.)
Public property Font (Inherited from WebControl.)
Public property ForceClaims Bool specifying whether we should always resolve against claims mode
Public property ForeColor (Inherited from WebControl.)
Public property HasAttributes (Inherited from WebControl.)
Protected property HasChildViewState (Inherited from Control.)
Public property Height (Inherited from WebControl.)
Public property ID (Inherited from Control.)
Protected property IdSeparator (Inherited from Control.)
Public property InitialHelpText String specifying the default help text to show in the picker
Public property InitialUserAccounts Specify an initial value of semi-colon delimited user account keys
Protected property IsChildControlStateCleared (Inherited from Control.)
Protected property IsEnabled (Inherited from WebControl.)
Protected property IsTrackingViewState (Inherited from Control.)
Public property IsValid
Protected property IsViewStateEnabled (Inherited from Control.)
Protected property LoadViewStateByID (Inherited from Control.)
Public property MaximumEntitySuggestions Boolean to configure maximum number of entity suggestions returned from search query
Public property NamingContainer (Inherited from Control.)
Public property OnControlValidateClientScript String specifying a JS script to run after a server error is set or cleared
Public property OnUserResolvedClientScript String specifying a JS script to run after resolved user is added or removed in client
Public property OnValueChangedClientScript String specifying a JS script to run after text input or users change in client
Public property Page (Inherited from Control.)
Public property Parent (Inherited from Control.)
Public property PrincipalAccountType String used to specify the type of principals to be resolved in a query Comma-separated : "User,DL,SecGroup,SPGroup"
Public property PrincipalSource SPPrincipalSource used to specify target sources used to resolve entities
Public property RenderingCompatibility (Inherited from Control.)
Public property Required Boolean whether the control must contain a valid entity
Public property ResolvedEntities List of all current picker entities that were successfully resolved
Public property Rows Int specifying the minimum number of rows for client input area
Public property SetFocus Boolean specifying whether the client control should receive focus on page load
Public property SharePointGroupID Integer used when resolution is limited to members of a SharePoint Group
Public property Site (Inherited from Control.)
Public property SkinID (Inherited from WebControl.)
Public property Style (Inherited from WebControl.)
Public property SupportsDisabledAttribute (Inherited from WebControl.)
Public property TabIndex (Inherited from WebControl.)
Protected property TagKey (Inherited from WebControl.)
Protected property TagName (Inherited from WebControl.)
Public property TemplateControl (Inherited from Control.)
Public property TemplateSourceDirectory (Inherited from Control.)
Public property Title String specifying the alternate text or tooltip for the client control
Public property ToolTip (Inherited from WebControl.)
Public property UniqueID (Inherited from Control.)
Public property UrlZone Optional SPUrlZone to allow querying a particular url zone when resolving against claim providers
Public property UseLocalSuggestionCache Boolean specifying if people picker should get/set selected items to local storage
Public property ValidationEnabled Boolean specifying whether this control should register and enforce page validation
Protected property ViewState (Inherited from Control.)
Protected property ViewStateIgnoresCase (Inherited from Control.)
Public property ViewStateMode (Inherited from Control.)
Public property Visible (Inherited from Control.)
Public property VisibleSuggestions
Public property WebApplicationID Guid specifying a WebApplication ID to use when resolving against claim providers
Public property Width (Inherited from WebControl.)

  Name Description
Protected method AddAttributesToRender (Inherited from WebControl.)
Protected method AddedControl (Inherited from Control.)
Public method AddEntities Public method to add a set of picker entities to the list of current entities in the control Adds entities, discarding duplicates of existing entities, and immediately attempts to resolve
Protected method AddParsedSubObject (Inherited from Control.)
Public method ApplyStyle (Inherited from WebControl.)
Public method ApplyStyleSheetSkin (Inherited from Control.)
Protected method BuildProfileTree (Inherited from Control.)
Protected method ClearCachedClientID (Inherited from Control.)
Protected method ClearChildControlState (Inherited from Control.)
Protected method ClearChildState (Inherited from Control.)
Protected method ClearChildViewState (Inherited from Control.)
Protected method ClearEffectiveClientIDMode (Inherited from Control.)
Public method CopyBaseAttributes (Inherited from WebControl.)
Protected method CreateChildControls (Inherited from Control.)
Protected method CreateControlCollection (Inherited from Control.)
Protected method CreateControlStyle (Inherited from WebControl.)
Public method DataBind() (Inherited from Control.)
Protected method DataBind(Boolean) (Inherited from Control.)
Protected method DataBindChildren (Inherited from Control.)
Public method Dispose (Inherited from Control.)
Public method Static member DoesUserHavePermissions Utility method that verifies whether the current user has permissions to perform query
Protected method EnsureChildControls (Inherited from Control.)
Protected method EnsureID (Inherited from Control.)
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Public method FindControl(String) (Inherited from Control.)
Protected method FindControl(String, Int32) (Inherited from Control.)
Public method Focus (Inherited from Control.)
Protected method GetDesignModeState (Inherited from Control.)
Public method GetHashCode (Inherited from Object.)
Public method GetRouteUrl(Object) (Inherited from Control.)
Public method GetRouteUrl(RouteValueDictionary) (Inherited from Control.)
Public method GetRouteUrl(String, Object) (Inherited from Control.)
Public method GetRouteUrl(String, RouteValueDictionary) (Inherited from Control.)
Public method GetType (Inherited from Object.)
Public method GetUniqueIDRelativeTo (Inherited from Control.)
Public method HasControls (Inherited from Control.)
Protected method HasEvents (Inherited from Control.)
Protected method IsLiteralContent (Inherited from Control.)
Protected method LoadControlState (Inherited from Control.)
Public method LoadPostData
Protected method LoadViewState (Inherited from WebControl.)
Protected method MapPathSecure (Inherited from Control.)
Protected method MemberwiseClone (Inherited from Object.)
Public method MergeStyle (Inherited from WebControl.)
Protected method OnBubbleEvent (Inherited from Control.)
Protected method OnDataBinding (Inherited from Control.)
Protected method OnInit (Overrides Control.OnInit(EventArgs).)
Protected method OnLoad (Inherited from Control.)
Protected method OnPreRender (Overrides Control.OnPreRender(EventArgs).)
Protected method OnUnload (Inherited from Control.)
Protected method OpenFile (Inherited from Control.)
Protected method RaiseBubbleEvent (Inherited from Control.)
Public method RaisePostDataChangedEvent
Protected method RemovedControl (Inherited from Control.)
Protected method Render (Overrides WebControl.Render(HtmlTextWriter).)
Public method RenderBeginTag (Inherited from WebControl.)
Protected method RenderChildren (Inherited from Control.)
Protected method RenderContents (Inherited from WebControl.)
Public method RenderControl(HtmlTextWriter) (Inherited from Control.)
Protected method RenderControl(HtmlTextWriter, ControlAdapter) (Inherited from Control.)
Public method RenderEndTag (Inherited from WebControl.)
Protected method ResolveAdapter (Inherited from Control.)
Public method ResolveClientUrl (Inherited from Control.)
Public method ResolveUrl (Inherited from Control.)
Protected method SaveControlState (Inherited from Control.)
Protected method SaveViewState (Inherited from WebControl.)
Protected method SetDesignModeState (Inherited from Control.)
Public method SetInitialSuggestions
Public method SetPrincipalSource Specify the SPPrincipalSource used to resolve entities
Public method SetRenderMethodDelegate (Inherited from Control.)
Public method ToString (Inherited from Object.)
Protected method TrackViewState (Inherited from WebControl.)
Public method Validate
Public method Static member ValidateEntities Top-level public method used to validate a set of entities on the server

  Name Description
Public event DataBinding (Inherited from Control.)
Public event Disposed (Inherited from Control.)
Public event Init (Inherited from Control.)
Public event Load (Inherited from Control.)
Public event PreRender (Inherited from Control.)
Public event Unload (Inherited from Control.)