BaseFieldControl members

Renders a field on a form page (not a list view page) by using one or more child controls such as a label, link, or text box control.

The BaseFieldControl type exposes the following members.

Constructors

  Name Description
Protected method BaseFieldControl Initializes a new instance of the BaseFieldControl class.

Top

Properties

  Name Description
Protected property Adapter (Inherited from Control.)
Protected property AllowFirstFocus Gets a value indicating whether the page, on loading, can set the initial focus to the BaseFieldControl.
Public property AlternateTemplate Gets or sets the template that renders the control in contexts, such as a particular form, in which rendering the control with the Template property would be inappropriate. (Inherited from TemplateBasedControl.)
Public property AlternateTemplateName Gets or sets the name of a rendering template that can be used in contexts in which the template named by the TemplateName property would be inappropriate. (Inherited from TemplateBasedControl.)
Public property AppRelativeTemplateSourceDirectory (Inherited from Control.)
Public property BindingContainer (Inherited from Control.)
Protected property CanCacheRenderedFieldValue Gets or sets a value indicating whether the value of BaseFieldControl may be locally cached.
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 ComponentRequiresPostback BaseFieldControl is base class of server form controls for various SPFields These controls render editing cotrols and require postback if no client template exists (Overrides FieldMetadata.ComponentRequiresPostback.)
Protected property Context (Inherited from Control.)
Public property ControlMode Gets or sets the rendering mode for the form (display, edit, or new). (Inherited from FormComponent.)
Public property Controls Gets an object that contains the child controls of the TemplateBasedControl object. (Inherited from TemplateBasedControl.)
Protected property ControlTemplate Gets the template that renders the control in the current context. (Inherited from TemplateBasedControl.)
Public property CssClass Gets or sets the styling class in a cascading style sheet (CSS) file that controls the font family, font size, and possibly other aspects of how the text of the field is rendered.
Public property CustomAlternateTemplate Gets or sets a custom alternate template. (Inherited from TemplateBasedControl.)
Public property CustomTemplate Gets or sets a custom template. (Inherited from TemplateBasedControl.)
Public property DataItemContainer (Inherited from Control.)
Public property DataKeysContainer (Inherited from Control.)
Protected property DefaultAlternateTemplateName Gets the name of the default alternate rendering template. (Inherited from TemplateBasedControl.)
Protected property DefaultTemplateName Gets the name of the default rendering template. (Inherited from TemplateBasedControl.)
Protected property DesignMode (Inherited from Control.)
Public property DisableInputFieldLabel Gets a value indicating whether the default input field label should be used on the New or Edit forms.
Public property DisplaySize Gets or sets the maximum number of characters to display when rendering the field. (Inherited from FieldMetadata.)
Public property DisplayTemplate Gets or sets an object that can be used to control the rendering of the BaseFieldControl object in display mode; that is, when it is not on a New or Edit form.
Public property DisplayTemplateName Gets or sets the name of the template that can be used to control the rendering of the BaseFieldControl object in display mode; that is, when it is not on a New or Edit form.
Protected property EnableInputFieldLabels (Inherited from FormComponent.)
Public property EnableTheming (Inherited from Control.)
Public property EnableViewState (Inherited from Control.)
Public property ErrorMessage Gets or sets a message indicating that, and possibly why, the current value of Value is invalid.
Protected property Events (Inherited from Control.)
Public property Field Gets the underlying SPField object that is rendered by the FieldMetadata object. (Inherited from FieldMetadata.)
Public property FieldName Gets or sets a name for the field. (Inherited from FieldMetadata.)
Public property Fields Gets the collection of fields. (Inherited from FormComponent.)
Protected property HasChildViewState (Inherited from Control.)
Protected property HasPostBackEditData Gets a value that indicates whether the data of BaseFieldControl might have changed as a result of the last postback.
Public property ID (Inherited from Control.)
Protected property IdSeparator (Inherited from Control.)
Public property InDesign (Inherited from SPControl.)
Public property InputFieldLabel Gets or sets the label of BaseFieldControl in design mode.
Protected property IsChildControlStateCleared (Inherited from Control.)
Protected property IsClientRenderedForm Determines whether this FormField control is being added to a CSR (Hybrid) Form (Inherited from FormComponent.)
Protected property IsEditMode (Inherited from FormComponent.)
Protected property IsFieldValueCached Gets a value indicating whether the value of the field is cached.
Public property IsInDesignTimeMode Returns true if the control's current context is in design time mode.
Protected property IsInInlineEditMode returns true if the control is hosted by webparts (like xsltlistwebpart) in inline edit mode.
Protected property IsTrackingViewState (Inherited from Control.)
Public property IsValid Gets or sets a value that indicates whether the current value of the Value property is valid.
Protected property IsViewStateEnabled (Inherited from Control.)
Public property Item Gets the value that represents the item. (Inherited from FormComponent.)
Public property ItemContext Gets or sets the context of the item. (Inherited from FormComponent.)
Public property ItemFieldValue Gets or sets the value of the SPField that has this BaseFieldControl as its FieldRenderingControl property.
Public property ItemId Gets or sets the ID for the list item. (Inherited from FormComponent.)
Public property ItemIdAsString Gets or sets the ID, as a string, for the list item. (Inherited from FormComponent.)
Public property List Gets the value that represents the list of form components. (Inherited from FormComponent.)
Protected property ListFormWP (Inherited from FormComponent.)
Public property ListId Gets or sets the ID of the list. (Inherited from FormComponent.)
Public property ListItem Gets the value that represents the list item, based on the ListItemID property. (Inherited from FormComponent.)
Public property ListItemFieldValue Reserved for internal use.
Protected property LoadViewStateByID (Inherited from Control.)
Public property NamingContainer (Inherited from Control.)
Public property Page (Inherited from Control.)
Public property PageUri Gets or sets the Uniform Resource Identifier (URI) of the page that contains the control. (Inherited from SPControl.)
Public property Parent (Inherited from Control.)
Protected property PreviousControlMode Gets a value that identifies the control mode of the BaseFieldControl object before the last postback.
Public property RecurrenceID Gets or sets the string value that represents the recurrence ID. (Inherited from FormComponent.)
Public property RedirectUrl Gets or sets the string value that represents the redirect URL. (Inherited from FormComponent.)
Protected property RegisterAs (Inherited from SPControl.)
Public property RenderContext Gets or sets the Microsoft SharePoint Foundation context in which the control is rendered. (Inherited from TemplateBasedControl.)
Public property RenderingCompatibility (Inherited from Control.)
Public property RibbonCommand (Inherited from FormComponent.)
Public property RibbonContextualGroupCommand (Inherited from FormComponent.)
Public property RibbonGroupCommand (Inherited from FormComponent.)
Public property RibbonTabCommand (Inherited from FormComponent.)
Public property Site (Inherited from Control.)
Public property SkinID (Inherited from Control.)
Public property TabIndex Gets or sets the position of the BaseFieldControl in the tab order of controls on the page.
Public property Template Gets or sets the template that renders the control. (Inherited from TemplateBasedControl.)
Public property TemplateContainer Gets the container control that instantiates the content template. (Inherited from TemplateBasedControl.)
Public property TemplateControl (Inherited from Control.)
Public property TemplateName Gets or sets the name of the control's rendering template. (Inherited from TemplateBasedControl.)
Protected property TemplateOverride Gets or sets a value indicating whether the template referred to by the Template property or the one referred to by the AlternateTemplate property should be instantiated by the CreateChildControls method. (Inherited from TemplateBasedControl.)
Public property TemplateSourceDirectory (Inherited from Control.)
Public property UniqueID (Inherited from Control.)
Public property Value When overridden in a derived class, gets or sets the value of the field in the UI.
Public property Version Gets or sets the a value that indicates whether the UI of the parent Web site is using the UI of the current version of the SharePoint Foundation or the previous version. (Inherited from TemplateBasedControl.)
Protected property ViewState (Inherited from Control.)
Protected property ViewStateIgnoresCase (Inherited from Control.)
Public property ViewStateMode (Inherited from Control.)
Public property Visible Gets or sets a value indicating whether the field is visible or hidden. (Overrides FieldMetadata.Visible.)
Public property Web Gets the site of the control's rendering context; which is the value of the SPContext.Web property of the object held by the TemplateBasedControlRenderContext() property. (Inherited from TemplateBasedControl.)

Top

Methods

  Name Description
Protected method AddedControl (Inherited from Control.)
Protected method AddParsedSubObject (Inherited from Control.)
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.)
Protected method CreateChildControls Creates any child controls necessary to render the field, such as a label control, link control, or text box control. (Overrides TemplateBasedControl.CreateChildControls().)
Protected method CreateControlCollection (Inherited from Control.)
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 When overridden in a derived class, sets focus to the rendered field. (Overrides Control.Focus().)
Protected method GetDesignModeState (Inherited from Control.)
Public method GetDesignTimeHtml Returns the control as design-time HTML for editing in Web site development tools such as Microsoft Office FrontPage 2003. (Inherited from SPControl.)
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.)
Protected method LoadViewState (Inherited from Control.)
Protected method MapPathSecure (Inherited from Control.)
Protected method MemberwiseClone (Inherited from Object.)
Protected method OnBubbleEvent (Inherited from Control.)
Protected method OnDataBinding (Inherited from Control.)
Protected method OnInit Represents the method that handles the Init event of a FieldMetadata object. (Overrides Control.OnInit(EventArgs).)
Protected method OnLoad Represents the method that handles the Load event of a FieldMetadata object. (Overrides TemplateBasedControl.OnLoad(EventArgs).)
Protected method OnPreRender Represents the method that handles the PreRender event of a FieldMetadata object. (Overrides FormComponent.OnPreRender(EventArgs).)
Protected method OnUnload (Inherited from Control.)
Protected method OpenFile (Inherited from Control.)
Protected method RaiseBubbleEvent (Inherited from Control.)
Protected method RegisterFieldControl Registers the BaseFieldControl by adding it to the collections of validators and field controls.
Protected method RemovedControl (Inherited from Control.)
Protected method Render Renders the field on the page. (Overrides TemplateBasedControl.Render(HtmlTextWriter).)
Protected method RenderChildren (Inherited from Control.)
Public method RenderControl(HtmlTextWriter) (Inherited from Control.)
Protected method RenderControl(HtmlTextWriter, ControlAdapter) (Inherited from Control.)
Protected method RenderFieldForDisplay Renders the field for noneditable display.
Protected method RenderFieldForInput When overridden in derived class, renders the field in a child control that lets its value be changed.
Protected method RenderValidationMessage Renders an error message about the invalidity of the value in the Value property.
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 Control.)
Protected method SetDesignModeState (Inherited from Control.)
Public method SetRenderMethodDelegate (Inherited from Control.)
Public method ToString (Inherited from Object.)
Protected method TrackViewState (Inherited from Control.)
Public method UpdateFieldValueInItem Updates the underlying value of the field to the latest user-set value.
Public method Validate When overridden in a derived class, verifies that the value of Value meets all restrictions on field content such as length, format, and data type.

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

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 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 IDesignerEventAccessor.OnDesignerLoad (Inherited from SPControl.)
Explicit interface implemetationPrivate method IDesignerEventAccessor.OnDesignerPreRender (Inherited from SPControl.)
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

BaseFieldControl class

Microsoft.SharePoint.WebControls namespace