PeopleEditor members

Represents a PeopleEditor object in a PeoplePicker control.

The PeopleEditor type exposes the following members.

Constructors

	Name	Description
	PeopleEditor	Initializes a new instance of the PeopleEditor class.

Top

Properties

	Name	Description
	AcceptAnyEmailAddresses
	AccessKey	(Inherited from WebControl.)
	Accounts	Retrieves the accounts associated with the PeopleEditor object as an ArrayList collection object.
	Adapter	(Inherited from Control.)
	AfterCallbackClientScript	(Inherited from EntityEditor.)
	AllowEmpty	Gets or sets a value that represents whether an empty entity is allowed. (Inherited from EntityEditor.)
	AllowTypeIn	Represents the property that enables the user to enter text into the TextBox. (Inherited from EntityEditor.)
	AllUrlZones	Sets or retrieves a value that indicates whether or not all URL zones are used for the control.
	AppRelativeTemplateSourceDirectory	(Inherited from Control.)
	Attributes	(Inherited from WebControl.)
	AugmentEntitiesFromUserInfo	Gets or sets a value that indicates whether PickerEntity objects, which will be resolved by the PeopleEditor instance, should be supplemented with user information data.
	AutoPostBack	Gets or sets the value that represents whether the EntityEditor control is set to automatically post-back on focus change. (Inherited from EntityEditor.)
	BackColor	(Inherited from WebControl.)
	BindingContainer	(Inherited from Control.)
	BorderColor	(Inherited from WebControl.)
	BorderStyle	(Inherited from WebControl.)
	BorderWidth	(Inherited from WebControl.)
	BrowseButtonImageName	Gets or sets a string that represents the path of the image to be shown for the Browse button next to the people picker control. (Inherited from EntityEditorWithPicker.)
	BrowseButtonToolTip	(Inherited from EntityEditorWithPicker.)
	CannotBeBlankErrorMessage	(Inherited from EntityEditor.)
	CheckButtonImageName	Gets or sets a value that represents the path of the image to be shown for the Check button next to the people picker control. (Inherited from EntityEditorWithPicker.)
	CheckItemToolTip	(Inherited from EntityEditorWithPicker.)
	ChEntitySeparatorComma
	ChildControlsCreated	(Inherited from Control.)
	ClientID	(Inherited from Control.)
	ClientIDMode	(Inherited from Control.)
	ClientIDSeparator	(Inherited from Control.)
	CommaSeparatedAccounts	Sets or retrieves the accounts associated with the PeopleEditor object as a comma-delimited String object.
	Context	(Inherited from Control.)
	Controls	(Inherited from Control.)
	ControlStyle	(Inherited from WebControl.)
	ControlStyleCreated	(Inherited from WebControl.)
	CreateButtonOnClientClick	Sets or retrieves the identifier for a button that is created when the control is clicked. (Overrides EntityEditorWithPicker.CreateButtonOnClientClick.)
	CreateButtonText	(Inherited from EntityEditorWithPicker.)
	CssClass	Sets or retrieves the Cascading Style Sheet (CSS) class that is rendered by the Web server control on the client. (Overrides WebControl.CssClass.)
	CustomProperty	Gets or sets a value that represents an arbitrary string that can be stored by the consumer. (Inherited from EntityEditor.)
	DataItemContainer	(Inherited from Control.)
	DataKeysContainer	(Inherited from Control.)
	DefaultCheckButtonImageName	Retrieves the name of the default image used by the control's Check Names button. (Overrides EntityEditorWithPicker.DefaultCheckButtonImageName.)
	DefaultMaximumEntities	Retrieves the default maximum number of entities that can be included in the PeopleEditor object control. (Overrides EntityEditor.DefaultMaximumEntities.)
	DefaultPlaceButtonsUnderEntityEditor	Retrieves a value that indicates whether or not to place buttons under the control by default. (Overrides EntityEditorWithPicker.DefaultPlaceButtonsUnderEntityEditor.)
	DefaultRows	Retrieves the default number of rows in the control. (Overrides EntityEditor.DefaultRows.)
	DesignMode	(Inherited from Control.)
	DialogHeight	(Inherited from EntityEditorWithPicker.)
	DialogImage	Sets or retrieves the name of the dialog box image used by the control. (Overrides EntityEditorWithPicker.DialogImage.)
	DialogTitle	Gets or sets a string value that represents the title of the picker dialog box. (Inherited from EntityEditorWithPicker.)
	DialogWidth	(Inherited from EntityEditorWithPicker.)
	DisabledBrowseButtonImageName	(Inherited from EntityEditorWithPicker.)
	DisabledCheckNamesButtonImageName	(Inherited from EntityEditorWithPicker.)
	DoEncodeErrorMessage	(Inherited from EntityEditor.)
	DoPostBackOnResolve	(Inherited from EntityEditorWithPicker.)
	DownLevelTextBox	(Inherited from EntityEditor.)
	EnableBrowse	Gets or sets a value that represents the flag to enable or disable the Browse button shown next to the picker control. (Inherited from EntityEditorWithPicker.)
	Enabled	(Inherited from WebControl.)
	EnabledClaimProviders
	EnableTheming	(Inherited from WebControl.)
	EnableViewState	(Inherited from Control.)
	Entities	Gets an ordered array of all the entities in the display. (Inherited from EntityEditor.)
	EntitySeparator	Obsolete. Use the EntitySeparators property instead of this property. (Inherited from EntityEditor.)
	EntitySeparators	Gets or sets the array of Unicode characters that is to be used to separate multiple entities in the input text. (Inherited from EntityEditor.)
	ErrorMessage	Gets or sets a value that represents the error message string for the EntityEditor control. (Inherited from EntityEditor.)
	Events	(Inherited from Control.)
	Font	(Inherited from WebControl.)
	ForceClaims	Gets or sets the Boolean value to allow the page to bypass the UseClaimsAuthentication property of the Web application and ensure that all PeoplePicker Search and Resolve queries are executed against the Claims API.
	ForeColor	(Inherited from WebControl.)
	HasAttributes	(Inherited from WebControl.)
	HasChildViewState	(Inherited from Control.)
	Height	(Inherited from WebControl.)
	HideInactiveProfiles
	ID	(Inherited from Control.)
	IdSeparator	(Inherited from Control.)
	InputDescription	(Inherited from EntityEditorWithPicker.)
	IsChanged	(Inherited from EntityEditor.)
	IsChildControlStateCleared	(Inherited from Control.)
	IsClaimsDisabled
	IsEnabled	(Inherited from WebControl.)
	IsTrackingViewState	(Inherited from Control.)
	IsValid	Gets or sets the value that represents whether all of the entities entered in the EntityEditor are valid and conform to the settings of the EntityEditor. (Inherited from EntityEditor.)
	IsViewStateEnabled	(Inherited from Control.)
	LoadViewStateByID	(Inherited from Control.)
	MaximumEntities	(Inherited from EntityEditor.)
	MaximumHeight	Gets or sets the value that represents the maximum height. (Inherited from EntityEditor.)
	MoreItemsText	(Inherited from EntityEditorWithPicker.)
	MultiSelect	Gets or sets the value that allows for multiple entities to be selected. (Inherited from EntityEditor.)
	NamingContainer	(Inherited from Control.)
	NoMatchesText	(Inherited from EntityEditorWithPicker.)
	OnValueChangedClientScript	Gets or sets a value that represents the client-side script, which is intended to be executed whenever the control value changes. (Inherited from EntityEditor.)
	Page	(Inherited from Control.)
	Parent	(Inherited from Control.)
	PickerDialog	(Inherited from EntityEditor.)
	PickerDialogToolTip	(Inherited from EntityEditorWithPicker.)
	PickerDialogType	Gets or sets an object that represents the type of the picker dialog box. (Inherited from EntityEditorWithPicker.)
	PlaceButtonsUnderEntityEditor	Gets or sets a value that represents the flag to show the Browse and Check Names buttons under the picker control instead of next to the picker control. (Inherited from EntityEditorWithPicker.)
	PreferContentEditableDiv	Gets or sets the value that represents the property that forces the people picker control to render in a content editable generic block-level container (div). (Inherited from EntityEditor.)
	PrincipalSource	Sets or retrieves an SPPrincipalSource value that indicates the principal source of the control.
	RenderingCompatibility	(Inherited from Control.)
	ResolvedEntities	Gets an object that represents an array list of PickerEntity objects that are resolved by the EntityEditor control. (Inherited from EntityEditor.)
	Rows	Gets or sets a value that represents the number of rows visible without scrolling in the edit pane of the EntityEditor control. (Inherited from EntityEditor.)
	SelectionSet	Sets or retrieves the account types that are associated with the control.
	SharePointGroup	Sets or retrieves name of the SharePoint group that the user is included in.
	SharePointGroupID	Sets SharePoint Group ID and name for the SharePoint group that the user is scoped in
	ShowButtons	Gets or sets a value that represents the flag to show or hide the Browse and Check Names buttons. (Inherited from EntityEditorWithPicker.)
	ShowCreateButtonInActiveDirectoryAccountCreationMode	Sets or retrieves a value that indicates whether or not to display a Create button when creating an Active Directory directory service account.
	ShowDataValidationErrorBorder	(Inherited from EntityEditor.)
	ShowEntityDisplayTextInTextBox	Gets or sets a value that represents whether the display text for the current entity should be shown in a TextBox. (Inherited from EntityEditor.)
	ShowErrorPlaceHolder	(Inherited from EntityEditorWithPicker.)
	Site	(Inherited from Control.)
	SkinID	(Inherited from WebControl.)
	StrAcceptAnyEmailAddressObjTag
	StrPrincipalTypeUnvalidatedEmailAddress
	Style	(Inherited from WebControl.)
	SupportsDisabledAttribute	(Inherited from WebControl.)
	TabIndex	(Inherited from EntityEditor.)
	TagKey	(Inherited from WebControl.)
	TagName	(Inherited from WebControl.)
	TemplateControl	(Inherited from Control.)
	TemplateSourceDirectory	(Inherited from Control.)
	Title	Gets or sets the value that represents the title string to be displayed on the EntityEditor control. (Inherited from EntityEditor.)
	ToolTip	(Inherited from WebControl.)
	UniqueID	(Inherited from Control.)
	UpLevelDiv	(Inherited from EntityEditor.)
	UrlZone	Sets or retrieves a value that indicates the URL zone of the control.
	UseContentEditableControl	(Inherited from EntityEditor.)
	Validated	Gets a value that represents whether the Validate() method was previously called successfully. (Inherited from EntityEditor.)
	ValidateResolvedEntity	Sets or retrieves a value that indicates whether or not to validate a resolved entity.
	ValidatorEnabled	Gets or sets a value that represents whether a Validator is enabled. (Inherited from EntityEditor.)
	ViewState	(Inherited from Control.)
	ViewStateIgnoresCase	(Inherited from Control.)
	ViewStateMode	(Inherited from Control.)
	Visible	(Inherited from Control.)
	WebApplicationId	Sets or retrieves a unique identifier (GUID) that identifies the Web application that is associated with the control.
	Width	(Inherited from WebControl.)

Top

Methods

	Name	Description
	AddAttributesToRender	(Inherited from WebControl.)
	AddedControl	(Inherited from Control.)
	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	This is where we have to create instances of all needed controls and add them to the page. (Inherited from EntityEditorWithPicker.)
	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.)
	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.)
	GenerateErrorScript	This should be overridden so that the inherited control can perform the desired action when the user clicks on an entity that failed to resolve. (Inherited from EntityEditor.)
	GetAccountFromSid	Retrieves the name of the account associated with a specified security identifier (SID).
	GetCallbackResult	(Inherited from EntityEditor.)
	GetCommaSeparatorCharArray
	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.)
	GetSidHexRepresentation	Retrieves a hexadecimal representation of the control's security identifier (SID) binary array.
	GetType	(Inherited from Object.)
	GetUniqueIDRelativeTo	(Inherited from Control.)
	HandleObjectTags	Accepts a Dictionary object as a collection of key-value pairs and sets properties on the instance of the PeopleEditor object.
	HasControls	(Inherited from Control.)
	HasEvents	(Inherited from Control.)
	IsIE55Plus	Indicates whether the EntityEditor control is currently rendering under Internet Explorer 5, Internet Explorer 6, Internet Explorer 7, or Internet Explorer 8. (Inherited from EntityEditor.)
	IsLiteralContent	(Inherited from Control.)
	LoadControlState	(Inherited from Control.)
	LoadPostData	This method is called on postback to load the entity data from the desired storage location (Inherited from EntityEditor.)
	LoadViewState	(Inherited from WebControl.)
	MapPathSecure	(Inherited from Control.)
	MemberwiseClone	(Inherited from Object.)
	MergeStyle	(Inherited from WebControl.)
	OnBubbleEvent	(Inherited from Control.)
	OnDataBinding	(Inherited from Control.)
	OnEntityDeserialized	Accepts a deserialized PickerEntity object. (Inherited from EntityEditor.)
	OnInit	Raises an event when the server control is initialized. (Overrides EntityEditor.OnInit(EventArgs).)
	OnLoad	(Inherited from Control.)
	OnPreRender	Raises an event after the control is loaded but before it renders. (Overrides EntityEditorWithPicker.OnPreRender(EventArgs).)
	OnUnload	(Inherited from Control.)
	OpenFile	(Inherited from Control.)
	RaiseBubbleEvent	(Inherited from Control.)
	RaiseCallbackEvent	(Inherited from EntityEditor.)
	RaisePostDataChangedEvent	This is a required method of the IPostBackDataHandler (Inherited from EntityEditor.)
	RemovedControl	(Inherited from Control.)
	Render	Sends the content of the control to the specified HtmlTextWriter object, which writes the content that is rendered on the client. (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.)
	ResolveAccountsByArrKeys	Accepts an array of String objects and attempts to resolve the strings as entities.
	ResolveAdapter	(Inherited from Control.)
	ResolveClientUrl	(Inherited from Control.)
	ResolveErrorBySearch	Searches for matching picker entities by using the specified unresolved text. (Overrides EntityEditor.ResolveErrorBySearch(String).)
	ResolveUrl	(Inherited from Control.)
	SaveControlState	(Inherited from Control.)
	SaveViewState	(Inherited from WebControl.)
	SetCannotBeBlankErrorMessage	Accepts a string and sets the CannotBeBlankErrorMessage property of the instances to the provided string.
	SetDesignModeState	(Inherited from Control.)
	SetFocus	(Inherited from EntityEditor.)
	SetRenderMethodDelegate	(Inherited from Control.)
	ToString	(Inherited from Object.)
	TrackViewState	(Inherited from WebControl.)
	UpdateEntities	Accepts an ArrayList of PickerEntity objects and validates them. (Inherited from EntityEditor.)
	Validate	(Inherited from EntityEditorWithPicker.)
	ValidateEntity	Validates the specified entity. (Overrides EntityEditor.ValidateEntity(PickerEntity).)

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

Fields

	Name	Description
	ErrorLabel	(Inherited from EntityEditor.)
	ErrorPlaceHolder	(Inherited from EntityEditor.)
	HiddenSpanData	(Inherited from EntityEditor.)
	InternalTabIndex	(Inherited from EntityEditor.)
	TableLayout	(Inherited from EntityEditor.)

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

PeopleEditor class

Microsoft.SharePoint.WebControls namespace