Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All

ItemPicker members

Represents a control that renders the External Data Picker control on the server. This control is used in the new, edit, and view list item forms when the fields in the SharePoint list are of type External Data.

The ItemPicker type exposes the following members.

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

  Name Description
Public property AccessKey (Inherited from WebControl.)
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 AppRelativeTemplateSourceDirectory (Inherited from Control.)
Public property Attributes (Inherited from WebControl.)
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 Gets the string tooltip of the Pick button. (Overrides EntityEditorWithPicker.BrowseButtonToolTip.)
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 Gets the string tooltip of the Resolve button. (Overrides EntityEditorWithPicker.CheckItemToolTip.)
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 CreateButtonOnClientClick (Inherited from EntityEditorWithPicker.)
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 (Inherited from EntityEditorWithPicker.)
Protected property DefaultMaximumEntities (Inherited from EntityEditor.)
Protected property DefaultPlaceButtonsUnderEntityEditor (Inherited from EntityEditorWithPicker.)
Protected property DefaultRows (Inherited from EntityEditor.)
Protected property DesignMode (Inherited from Control.)
Public property DialogHeight (Inherited from EntityEditorWithPicker.)
Public property DialogImage Gets or sets a string value that represents the path of the dialog box image. (Inherited from EntityEditorWithPicker.)
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 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 EntityName Gets the Name of the External Content Type this control is going to interact with.
Public property EntityNamespace Gets the Namespace of the External Content Type this control is going to interact with.
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 ExtendedData Gets or sets the extended data that is associated with a specific ItemPicker user control.
Public property Font (Inherited from WebControl.)
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 InputDescription (Inherited from EntityEditorWithPicker.)
Public property IsChanged (Inherited from EntityEditor.)
Protected property IsChildControlStateCleared (Inherited from Control.)
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 Gets the text of the More items... button. (Overrides EntityEditorWithPicker.MoreItemsText.)
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 Gets the text message to be displayed in case the search returns no matches. (Overrides EntityEditorWithPicker.NoMatchesText.)
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 PreserveComplexTypes Determines whether complex BDC types will preserved in their original form.
Public property PrimaryColumnName Gets the name of the column which will be rendered as first colum in the Entity Content Type picker 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 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 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 property Style (Inherited from WebControl.)
Public property SupportsDisabledAttribute (Inherited from WebControl.)
Public property SystemInstanceName Gets the Name of the LOBSystem used by the External Content Type this control is going to interact with.
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.)
Protected property UseContentEditableControl (Inherited from EntityEditor.)
Public property UsesFileBackedMetadataCatalog Indicates if the parent field is on a list which uses a FileBackedMetadataCatalog to retrieve Entity information.
Protected property Validated Gets a value that represents whether the Validate() method was previously called successfully. (Inherited from EntityEditor.)
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 Width (Inherited from WebControl.)
Top

  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 method GetCallbackResult (Inherited from EntityEditor.)
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 GetSecondaryColumnNames Gets the names of the additional columns will be rendered in the Entity Content Type picker 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.)
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 LoadExternalSpanData Manually provides data to a control that the server normally provides during a postback process.
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 (Overrides EntityEditor.OnEntityDeserialized(PickerEntity).)
Protected method OnInit Overrides implementation of OnInit. Calls the base class implementation of OnInit in Webcontrol. (Inherited from EntityEditor.)
Protected method OnLoad Sets the initial state of the control and raises the Load event. (Overrides Control.OnLoad(EventArgs).)
Protected method OnPreRender Sets the visuals for the control. Raises the PreRender event. (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 (Inherited from WebControl.)
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.)
Protected method ResolveErrorBySearch This is called to resolve an ambiguity. If we found multiple matches then return them. (Overrides EntityEditor.ResolveErrorBySearch(String).)
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 SetFocus (Inherited from EntityEditor.)
Public method SetRenderMethodDelegate (Inherited from Control.)
Public method ShowCannotBeBlankError Sets the proper error message when the item picker control is required on an InfoPath form rendered on the server and the form is submitted without filling in a value for the 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 Validates the state of the control and shows an user error in case it is found invalid. (Overrides EntityEditorWithPicker.Validate().)
Public method ValidateEntity Validates the selected PickerEntity. Tries to use the BDC finders to see if any of them matches the user input. Depending on the ourcome, sets the IsResolved property to either true or false. The algorithm is to try FindSpecific first, then try all exact match filters, and then all wildcard filters. (Overrides EntityEditor.ValidateEntity(PickerEntity).)
Top

  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

  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

Show:
© 2015 Microsoft