BaseFieldControl members
SharePoint 2013
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.
| Name | Description | |
|---|---|---|
|
Adapter | (Inherited from Control.) |
|
|
AllowFirstFocus | Gets a value indicating whether the page, on loading, can set the initial focus to the BaseFieldControl. |
|
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.) |
|
|
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.) |
|
|
AppRelativeTemplateSourceDirectory | (Inherited from Control.) |
|
|
BindingContainer | (Inherited from Control.) |
|
|
CanCacheRenderedFieldValue | Gets or sets a value indicating whether the value of BaseFieldControl may be locally cached. |
|
|
ChildControlsCreated | (Inherited from Control.) |
|
|
ClientID | (Inherited from Control.) |
|
|
ClientIDMode | (Inherited from Control.) |
|
|
ClientIDSeparator | (Inherited from Control.) |
|
|
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.) |
|
|
Context | (Inherited from Control.) |
|
|
ControlMode | Gets or sets the rendering mode for the form (display, edit, or new). (Inherited from FormComponent.) |
|
|
Controls | Gets an object that contains the child controls of the TemplateBasedControl object. (Inherited from TemplateBasedControl.) |
|
|
ControlTemplate | Gets the template that renders the control in the current context. (Inherited from TemplateBasedControl.) |
|
|
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. |
|
|
CustomAlternateTemplate | Gets or sets a custom alternate template. (Inherited from TemplateBasedControl.) |
|
|
CustomTemplate | Gets or sets a custom template. (Inherited from TemplateBasedControl.) |
|
|
DataItemContainer | (Inherited from Control.) |
|
|
DataKeysContainer | (Inherited from Control.) |
|
|
DefaultAlternateTemplateName | Gets the name of the default alternate rendering template. (Inherited from TemplateBasedControl.) |
|
|
DefaultTemplateName | Gets the name of the default rendering template. (Inherited from TemplateBasedControl.) |
|
|
DesignMode | (Inherited from Control.) |
|
|
DisableInputFieldLabel | Gets a value indicating whether the default input field label should be used on the New or Edit forms. |
|
|
DisplaySize | Gets or sets the maximum number of characters to display when rendering the field. (Inherited from FieldMetadata.) |
|
|
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. |
|
|
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. |
|
|
EnableInputFieldLabels | (Inherited from FormComponent.) |
|
|
EnableTheming | (Inherited from Control.) |
|
|
EnableViewState | (Inherited from Control.) |
|
|
ErrorMessage | Gets or sets a message indicating that, and possibly why, the current value of Value is invalid. |
|
|
Events | (Inherited from Control.) |
|
|
Field | Gets the underlying SPField object that is rendered by the FieldMetadata object. (Inherited from FieldMetadata.) |
|
|
FieldName | Gets or sets a name for the field. (Inherited from FieldMetadata.) |
|
|
Fields | Gets the collection of fields. (Inherited from FormComponent.) |
|
|
HasChildViewState | (Inherited from Control.) |
|
|
HasPostBackEditData | Gets a value that indicates whether the data of BaseFieldControl might have changed as a result of the last postback. |
|
|
ID | (Inherited from Control.) |
|
|
IdSeparator | (Inherited from Control.) |
|
|
InDesign | (Inherited from SPControl.) |
|
|
InputFieldLabel | Gets or sets the label of BaseFieldControl in design mode. |
|
|
IsChildControlStateCleared | (Inherited from Control.) |
|
|
IsClientRenderedForm | Determines whether this FormField control is being added to a CSR (Hybrid) Form (Inherited from FormComponent.) |
|
|
IsEditMode | (Inherited from FormComponent.) |
|
|
IsFieldValueCached | Gets a value indicating whether the value of the field is cached. |
|
|
IsInDesignTimeMode | Returns true if the control's current context is in design time mode. |
|
|
IsInInlineEditMode | returns true if the control is hosted by webparts (like xsltlistwebpart) in inline edit mode. |
|
|
IsTrackingViewState | (Inherited from Control.) |
|
|
IsValid | Gets or sets a value that indicates whether the current value of the Value property is valid. |
|
|
IsViewStateEnabled | (Inherited from Control.) |
|
|
Item | Gets the value that represents the item. (Inherited from FormComponent.) |
|
|
ItemContext | Gets or sets the context of the item. (Inherited from FormComponent.) |
|
|
ItemFieldValue | Gets or sets the value of the SPField that has this BaseFieldControl as its FieldRenderingControl property. |
|
|
ItemId | Gets or sets the ID for the list item. (Inherited from FormComponent.) |
|
|
ItemIdAsString | Gets or sets the ID, as a string, for the list item. (Inherited from FormComponent.) |
|
|
List | Gets the value that represents the list of form components. (Inherited from FormComponent.) |
|
|
ListFormWP | (Inherited from FormComponent.) |
|
|
ListId | Gets or sets the ID of the list. (Inherited from FormComponent.) |
|
|
ListItem | Gets the value that represents the list item, based on the ListItemID property. (Inherited from FormComponent.) |
|
|
ListItemFieldValue | Reserved for internal use. |
|
|
LoadViewStateByID | (Inherited from Control.) |
|
|
NamingContainer | (Inherited from Control.) |
|
|
Page | (Inherited from Control.) |
|
|
PageUri | Gets or sets the Uniform Resource Identifier (URI) of the page that contains the control. (Inherited from SPControl.) |
|
|
Parent | (Inherited from Control.) |
|
|
PreviousControlMode | Gets a value that identifies the control mode of the BaseFieldControl object before the last postback. |
|
|
RecurrenceID | Gets or sets the string value that represents the recurrence ID. (Inherited from FormComponent.) |
|
|
RedirectUrl | Gets or sets the string value that represents the redirect URL. (Inherited from FormComponent.) |
|
|
RegisterAs | (Inherited from SPControl.) |
|
|
RenderContext | Gets or sets the Microsoft SharePoint Foundation context in which the control is rendered. (Inherited from TemplateBasedControl.) |
|
|
RenderingCompatibility | (Inherited from Control.) |
|
|
RibbonCommand | (Inherited from FormComponent.) |
|
|
RibbonContextualGroupCommand | (Inherited from FormComponent.) |
|
|
RibbonGroupCommand | (Inherited from FormComponent.) |
|
|
RibbonTabCommand | (Inherited from FormComponent.) |
|
|
Site | (Inherited from Control.) |
|
|
SkinID | (Inherited from Control.) |
|
|
TabIndex | Gets or sets the position of the BaseFieldControl in the tab order of controls on the page. |
|
|
Template | Gets or sets the template that renders the control. (Inherited from TemplateBasedControl.) |
|
|
TemplateContainer | Gets the container control that instantiates the content template. (Inherited from TemplateBasedControl.) |
|
|
TemplateControl | (Inherited from Control.) |
|
|
TemplateName | Gets or sets the name of the control's rendering template. (Inherited from TemplateBasedControl.) |
|
|
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.) |
|
|
TemplateSourceDirectory | (Inherited from Control.) |
|
|
UniqueID | (Inherited from Control.) |
|
|
Value | When overridden in a derived class, gets or sets the value of the field in the UI. |
|
|
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.) |
|
|
ViewState | (Inherited from Control.) |
|
|
ViewStateIgnoresCase | (Inherited from Control.) |
|
|
ViewStateMode | (Inherited from Control.) |
|
|
Visible | Gets or sets a value indicating whether the field is visible or hidden. (Overrides FieldMetadata.Visible.) |
|
|
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.) |
| Name | Description | |
|---|---|---|
|
AddedControl | (Inherited from Control.) |
|
|
AddParsedSubObject | (Inherited from Control.) |
|
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.) |
|
|
CreateChildControls | Creates any child controls necessary to render the field, such as a label control, link control, or text box control. (Overrides TemplateBasedControl.CreateChildControls().) |
|
|
CreateControlCollection | (Inherited from Control.) |
|
|
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 | When overridden in a derived class, sets focus to the rendered field. (Overrides Control.Focus().) |
|
|
GetDesignModeState | (Inherited from Control.) |
|
|
GetDesignTimeHtml | Returns the control as design-time HTML for editing in Web site development tools such as Microsoft Office FrontPage 2003. (Inherited from SPControl.) |
|
|
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.) |
|
|
LoadViewState | (Inherited from Control.) |
|
|
MapPathSecure | (Inherited from Control.) |
|
|
MemberwiseClone | (Inherited from Object.) |
|
|
OnBubbleEvent | (Inherited from Control.) |
|
|
OnDataBinding | (Inherited from Control.) |
|
|
OnInit | Represents the method that handles the Init event of a FieldMetadata object. (Overrides Control.OnInit(EventArgs).) |
|
|
OnLoad | Represents the method that handles the Load event of a FieldMetadata object. (Overrides TemplateBasedControl.OnLoad(EventArgs).) |
|
|
OnPreRender | Represents the method that handles the PreRender event of a FieldMetadata object. (Overrides FormComponent.OnPreRender(EventArgs).) |
|
|
OnUnload | (Inherited from Control.) |
|
|
OpenFile | (Inherited from Control.) |
|
|
RaiseBubbleEvent | (Inherited from Control.) |
|
|
RegisterFieldControl | Registers the BaseFieldControl by adding it to the collections of validators and field controls. |
|
|
RemovedControl | (Inherited from Control.) |
|
|
Render | Renders the field on the page. (Overrides TemplateBasedControl.Render(HtmlTextWriter).) |
|
|
RenderChildren | (Inherited from Control.) |
|
|
RenderControl(HtmlTextWriter) | (Inherited from Control.) |
|
|
RenderControl(HtmlTextWriter, ControlAdapter) | (Inherited from Control.) |
|
|
RenderFieldForDisplay | Renders the field for noneditable display. |
|
|
RenderFieldForInput | When overridden in derived class, renders the field in a child control that lets its value be changed. |
|
|
RenderValidationMessage | Renders an error message about the invalidity of the value in the Value property. |
|
|
ResolveAdapter | (Inherited from Control.) |
|
|
ResolveClientUrl | (Inherited from Control.) |
|
|
ResolveUrl | (Inherited from Control.) |
|
|
SaveControlState | (Inherited from Control.) |
|
|
SaveViewState | (Inherited from Control.) |
|
|
SetDesignModeState | (Inherited from Control.) |
|
|
SetRenderMethodDelegate | (Inherited from Control.) |
|
|
ToString | (Inherited from Object.) |
|
|
TrackViewState | (Inherited from Control.) |
|
|
UpdateFieldValueInItem | Updates the underlying value of the field to the latest user-set value. |
|
|
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. |
| Name | Description | |
|---|---|---|
|
IParserAccessor.AddParsedSubObject | (Inherited from Control.) |
|
IControlBuilderAccessor.ControlBuilder | (Inherited from Control.) |
|
|
IDataBindingsAccessor.DataBindings | (Inherited from Control.) |
|
|
IExpressionsAccessor.Expressions | (Inherited from Control.) |
|
|
IControlDesignerAccessor.GetDesignModeState | (Inherited from Control.) |
|
|
IDataBindingsAccessor.HasDataBindings | (Inherited from Control.) |
|
|
IExpressionsAccessor.HasExpressions | (Inherited from Control.) |
|
|
IDesignerEventAccessor.OnDesignerLoad | (Inherited from SPControl.) |
|
|
IDesignerEventAccessor.OnDesignerPreRender | (Inherited from SPControl.) |
|
|
IControlDesignerAccessor.SetDesignModeState | (Inherited from Control.) |
|
|
IControlDesignerAccessor.SetOwnerControl | (Inherited from Control.) |
|
|
IControlDesignerAccessor.UserData | (Inherited from Control.) |
