PeopleEditor members

Represents a PeopleEditor object in a PeoplePicker control.

The PeopleEditor type exposes the following members.

Constructors

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

Top

Properties

  Name Description
Public property AcceptAnyEmailAddresses
Public property AccessKey (Inherited from WebControl.)
Public property Accounts Retrieves the accounts associated with the PeopleEditor object as an ArrayList collection object.
Protected property Adapter (Inherited from Control.)
Public property AfterCallbackClientScript (Inherited from EntityEditor.)
Public property AllowEmpty Gets or sets a value that represents whether an empty entity is allowed. (Inherited from EntityEditor.)
Public property AllowTypeIn Represents the property that enables the user to enter text into the TextBox. (Inherited from EntityEditor.)
Public property AllUrlZones Sets or retrieves a value that indicates whether or not all URL zones are used for the control.
Public property AppRelativeTemplateSourceDirectory (Inherited from Control.)
Public property Attributes (Inherited from WebControl.)
Public property 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.
Public property AutoPostBack Gets or sets the value that represents whether the EntityEditor control is set to automatically post-back on focus change. (Inherited from EntityEditor.)
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.)
Public property 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.)
Public property BrowseButtonToolTip (Inherited from EntityEditorWithPicker.)
Public property CannotBeBlankErrorMessage (Inherited from EntityEditor.)
Public property 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.)
Public property CheckItemToolTip (Inherited from EntityEditorWithPicker.)
Public propertyStatic member ChEntitySeparatorComma
Protected property ChildControlsCreated (Inherited from Control.)
Public property ClientID (Inherited from Control.)
Public property ClientIDMode (Inherited from Control.)
Protected property ClientIDSeparator (Inherited from Control.)
Public property CommaSeparatedAccounts Sets or retrieves the accounts associated with the PeopleEditor object as a comma-delimited String object.
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 CreateButtonOnClientClick Sets or retrieves the identifier for a button that is created when the control is clicked. (Overrides EntityEditorWithPicker.CreateButtonOnClientClick.)
Public property CreateButtonText (Inherited from EntityEditorWithPicker.)
Public property CssClass Sets or retrieves the Cascading Style Sheet (CSS) class that is rendered by the Web server control on the client. (Overrides WebControl.CssClass.)
Public property CustomProperty Gets or sets a value that represents an arbitrary string that can be stored by the consumer. (Inherited from EntityEditor.)
Public property DataItemContainer (Inherited from Control.)
Public property DataKeysContainer (Inherited from Control.)
Protected property DefaultCheckButtonImageName Retrieves the name of the default image used by the control's Check Names button. (Overrides EntityEditorWithPicker.DefaultCheckButtonImageName.)
Protected property DefaultMaximumEntities Retrieves the default maximum number of entities that can be included in the PeopleEditor object control. (Overrides EntityEditor.DefaultMaximumEntities.)
Protected property DefaultPlaceButtonsUnderEntityEditor Retrieves a value that indicates whether or not to place buttons under the control by default. (Overrides EntityEditorWithPicker.DefaultPlaceButtonsUnderEntityEditor.)
Protected property DefaultRows Retrieves the default number of rows in the control. (Overrides EntityEditor.DefaultRows.)
Protected property DesignMode (Inherited from Control.)
Public property DialogHeight (Inherited from EntityEditorWithPicker.)
Public property DialogImage Sets or retrieves the name of the dialog box image used by the control. (Overrides EntityEditorWithPicker.DialogImage.)
Public property DialogTitle Gets or sets a string value that represents the title of the picker dialog box. (Inherited from EntityEditorWithPicker.)
Public property DialogWidth (Inherited from EntityEditorWithPicker.)
Public property DisabledBrowseButtonImageName (Inherited from EntityEditorWithPicker.)
Public property DisabledCheckNamesButtonImageName (Inherited from EntityEditorWithPicker.)
Public property DoEncodeErrorMessage (Inherited from EntityEditor.)
Public property DoPostBackOnResolve (Inherited from EntityEditorWithPicker.)
Protected property DownLevelTextBox (Inherited from EntityEditor.)
Public property 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.)
Public property Enabled (Inherited from WebControl.)
Public property EnabledClaimProviders
Public property EnableTheming (Inherited from WebControl.)
Public property EnableViewState (Inherited from Control.)
Public property Entities Gets an ordered array of all the entities in the display. (Inherited from EntityEditor.)
Public property EntitySeparator Obsolete. Use the EntitySeparators property instead of this property. (Inherited from EntityEditor.)
Public property 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.)
Public property ErrorMessage Gets or sets a value that represents the error message string for the EntityEditor control. (Inherited from EntityEditor.)
Protected property Events (Inherited from Control.)
Public property Font (Inherited from WebControl.)
Public property 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.
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 propertyStatic member HideInactiveProfiles
Public property ID (Inherited from Control.)
Protected property IdSeparator (Inherited from Control.)
Public property InputDescription (Inherited from EntityEditorWithPicker.)
Public property IsChanged (Inherited from EntityEditor.)
Protected property IsChildControlStateCleared (Inherited from Control.)
Public property IsClaimsDisabled
Protected property IsEnabled (Inherited from WebControl.)
Protected property IsTrackingViewState (Inherited from Control.)
Public property 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.)
Protected property IsViewStateEnabled (Inherited from Control.)
Protected property LoadViewStateByID (Inherited from Control.)
Public property MaximumEntities (Inherited from EntityEditor.)
Public property MaximumHeight Gets or sets the value that represents the maximum height. (Inherited from EntityEditor.)
Public property MoreItemsText (Inherited from EntityEditorWithPicker.)
Public property MultiSelect Gets or sets the value that allows for multiple entities to be selected. (Inherited from EntityEditor.)
Public property NamingContainer (Inherited from Control.)
Public property NoMatchesText (Inherited from EntityEditorWithPicker.)
Public property 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.)
Public property Page (Inherited from Control.)
Public property Parent (Inherited from Control.)
Public property PickerDialog (Inherited from EntityEditor.)
Public property PickerDialogToolTip (Inherited from EntityEditorWithPicker.)
Public property PickerDialogType Gets or sets an object that represents the type of the picker dialog box. (Inherited from EntityEditorWithPicker.)
Public property 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.)
Public property 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.)
Public property PrincipalSource Sets or retrieves an SPPrincipalSource value that indicates the principal source of the control.
Public property RenderingCompatibility (Inherited from Control.)
Public property ResolvedEntities Gets an object that represents an array list of PickerEntity objects that are resolved by the EntityEditor control. (Inherited from EntityEditor.)
Public property 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.)
Public property SelectionSet Sets or retrieves the account types that are associated with the control.
Public property SharePointGroup Sets or retrieves name of the SharePoint group that the user is included in.
Public property SharePointGroupID Sets SharePoint Group ID and name for the SharePoint group that the user is scoped in
Public property ShowButtons Gets or sets a value that represents the flag to show or hide the Browse and Check Names buttons. (Inherited from EntityEditorWithPicker.)
Public property ShowCreateButtonInActiveDirectoryAccountCreationMode Sets or retrieves a value that indicates whether or not to display a Create button when creating an Active Directory directory service account.
Public property ShowDataValidationErrorBorder (Inherited from EntityEditor.)
Public property 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.)
Public property ShowErrorPlaceHolder (Inherited from EntityEditorWithPicker.)
Public property Site (Inherited from Control.)
Public property SkinID (Inherited from WebControl.)
Public propertyStatic member StrAcceptAnyEmailAddressObjTag
Public propertyStatic member StrPrincipalTypeUnvalidatedEmailAddress
Public property Style (Inherited from WebControl.)
Public property SupportsDisabledAttribute (Inherited from WebControl.)
Public property TabIndex (Inherited from EntityEditor.)
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 Gets or sets the value that represents the title string to be displayed on the EntityEditor control. (Inherited from EntityEditor.)
Public property ToolTip (Inherited from WebControl.)
Public property UniqueID (Inherited from Control.)
Protected property UpLevelDiv (Inherited from EntityEditor.)
Public property UrlZone Sets or retrieves a value that indicates the URL zone of the control.
Protected property UseContentEditableControl (Inherited from EntityEditor.)
Protected property Validated Gets a value that represents whether the Validate() method was previously called successfully. (Inherited from EntityEditor.)
Public property ValidateResolvedEntity Sets or retrieves a value that indicates whether or not to validate a resolved entity.
Public property ValidatorEnabled Gets or sets a value that represents whether a Validator is enabled. (Inherited from EntityEditor.)
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 WebApplicationId Sets or retrieves a unique identifier (GUID) that identifies the Web application that is associated with the control.
Public property Width (Inherited from WebControl.)

Top

Methods

  Name Description
Protected method AddAttributesToRender (Inherited from WebControl.)
Protected method AddedControl (Inherited from Control.)
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 This is where we have to create instances of all needed controls and add them to the page. (Inherited from EntityEditorWithPicker.)
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.)
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 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.)
Public methodStatic member GetAccountFromSid Retrieves the name of the account associated with a specified security identifier (SID).
Public method GetCallbackResult (Inherited from EntityEditor.)
Public methodStatic member GetCommaSeparatorCharArray
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 methodStatic member GetSidHexRepresentation Retrieves a hexadecimal representation of the control's security identifier (SID) binary array.
Public method GetType (Inherited from Object.)
Public method GetUniqueIDRelativeTo (Inherited from Control.)
Public method HandleObjectTags Accepts a Dictionary object as a collection of key-value pairs and sets properties on the instance of the PeopleEditor object.
Public method HasControls (Inherited from Control.)
Protected method HasEvents (Inherited from Control.)
Public method 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.)
Protected method IsLiteralContent (Inherited from Control.)
Protected method LoadControlState (Inherited from Control.)
Public method LoadPostData This method is called on postback to load the entity data from the desired storage location (Inherited from EntityEditor.)
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 OnEntityDeserialized Accepts a deserialized PickerEntity object. (Inherited from EntityEditor.)
Protected method OnInit Raises an event when the server control is initialized. (Overrides EntityEditor.OnInit(EventArgs).)
Protected method OnLoad (Inherited from Control.)
Protected method OnPreRender Raises an event after the control is loaded but before it renders. (Overrides EntityEditorWithPicker.OnPreRender(EventArgs).)
Protected method OnUnload (Inherited from Control.)
Protected method OpenFile (Inherited from Control.)
Protected method RaiseBubbleEvent (Inherited from Control.)
Public method RaiseCallbackEvent (Inherited from EntityEditor.)
Public method RaisePostDataChangedEvent This is a required method of the IPostBackDataHandler (Inherited from EntityEditor.)
Protected method RemovedControl (Inherited from Control.)
Protected method 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).)
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.)
Public method ResolveAccountsByArrKeys Accepts an array of String objects and attempts to resolve the strings as entities.
Protected method ResolveAdapter (Inherited from Control.)
Public method ResolveClientUrl (Inherited from Control.)
Protected method ResolveErrorBySearch Searches for matching picker entities by using the specified unresolved text. (Overrides EntityEditor.ResolveErrorBySearch(String).)
Public method ResolveUrl (Inherited from Control.)
Protected method SaveControlState (Inherited from Control.)
Protected method SaveViewState (Inherited from WebControl.)
Public method SetCannotBeBlankErrorMessage Accepts a string and sets the CannotBeBlankErrorMessage property of the instances to the provided string.
Protected method SetDesignModeState (Inherited from Control.)
Public method SetFocus (Inherited from EntityEditor.)
Public method SetRenderMethodDelegate (Inherited from Control.)
Public method ToString (Inherited from Object.)
Protected method TrackViewState (Inherited from WebControl.)
Public method UpdateEntities Accepts an ArrayList of PickerEntity objects and validates them. (Inherited from EntityEditor.)
Public method Validate (Inherited from EntityEditorWithPicker.)
Public method ValidateEntity Validates the specified entity. (Overrides EntityEditor.ValidateEntity(PickerEntity).)

Top

Events

  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.)

Top

Fields

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

Top

Explicit interface implementations

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

Top

See also

Reference

PeopleEditor class

Microsoft.SharePoint.WebControls namespace