ClientPeoplePicker members

The ClientPeoplePicker type exposes the following members.

Constructors

	Name	Description
	ClientPeoplePicker

Top

Properties

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

Top

Methods

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

Top

Events

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

Top

Explicit interface implementations

	Name	Description
	IParserAccessor.AddParsedSubObject	(Inherited from Control.)
	IControlBuilderAccessor.ControlBuilder	(Inherited from Control.)
	IDataBindingsAccessor.DataBindings	(Inherited from Control.)
	IExpressionsAccessor.Expressions	(Inherited from Control.)
	IAttributeAccessor.GetAttribute	(Inherited from WebControl.)
	IControlDesignerAccessor.GetDesignModeState	(Inherited from Control.)
	IDataBindingsAccessor.HasDataBindings	(Inherited from Control.)
	IExpressionsAccessor.HasExpressions	(Inherited from Control.)
	IAttributeAccessor.SetAttribute	(Inherited from WebControl.)
	IControlDesignerAccessor.SetDesignModeState	(Inherited from Control.)
	IControlDesignerAccessor.SetOwnerControl	(Inherited from Control.)
	IControlDesignerAccessor.UserData	(Inherited from Control.)

Top

See also

Reference

ClientPeoplePicker class

Microsoft.SharePoint.WebControls namespace