AbstractBasicForm Class

Abstract class for BasicForm.

Inheritance Hierarchy

System.Object
  System.Web.UI.Control
    System.Web.UI.WebControls.WebControl
      CMS.Base.Web.UI.CMSWebControl
        CMS.Base.Web.UI.CMSDynamicWebControl
          CMS.FormEngine.Web.UI.AbstractBasicForm
            CMS.FormEngine.Web.UI.BasicForm

Namespace: CMS.FormEngine.Web.UI
Assembly: CMS.FormEngine.Web.UI (in CMS.FormEngine.Web.UI.dll) Version: 10.0.0

Syntax

public abstract class AbstractBasicForm : CMSDynamicWebControl, 
	INamingContainer, ITimeZoneManager, IControlContextManager

The AbstractBasicForm type exposes the following members.

Constructors

	Name	Description
Protected method	AbstractBasicForm	Constructor.

Properties

	Name	Description
Public property	AllowSpellCheck	Indicates if spell check is allowed. Not allowed by default.
Public property	ControlContext	Gets the current control context.
Public property	CustomTimeZone	Gets or sets custom time zone info. This time zone is used when TimeZoneType is 'custom'.
Public property	Data	Data to be edited.
Public property	DataRow	Data to be edited.
Public property	FieldActionsControls	Contains FieldActions controls if the form is in design mode (BasicForm.IsDesignMode property).
Public property	FieldControls	Dictionary with FormEngineUserControl objects.
Public property	FieldEditingControls	Dictionary with EditingFormControl objects.
Public property	FieldErrorLabels	FieldErrorLabels.
Public property	FieldLabels	FieldLabels.
Public property	Fields	List of field names in order they appear in the form.
Public property	FieldUpdatePanels	Contains update panels which surround the fields (whole rows including labels) if the form is in design mode (BasicForm.IsDesignMode property).
Public property	FieldVisibilityControls	Visibility controls hashtable.
Public property	FormInformation	Form information.
Public property	InitCompleted	If true, the initialization of the control has already completed and won't repeat. Set to true in your initialization code. (Inherited from CMSDynamicWebControl.)
Protected property	InitEarly	If true, the control initializes on BeforeInitComplete, otherwise on InitComplete event. (Inherited from CMSDynamicWebControl.)
Public property	IsInsertMode	Indicates if the control is used for inserting a new object.
Public property	IsLiveSite	Indicates if control is used on live site. (Inherited from CMSWebControl.)
Public property	Mode	Gets or sets the mode of the form.
Public property	ProcessDisabledFields	Indicates if disabled fields should be processed (validated and saved). Default value is true in insert mode and false in edit mode.
Public property	ShortID	Short ID of the control. (Inherited from CMSWebControl.)
Public property	SpellCheckFields	List with client Ids of fields that should be spell checked.
Public property	StopProcessing	Indicates if processing of the code of this control should continue. It can be used after raising an event. (Inherited from CMSDynamicWebControl.)
Public property	TimeZoneType	Gets or sets time zone type for child controls. Default value is TimeZoneTypeEnum.Inherit.

Methods

	Name	Description
Protected method	CreateChildControls	Renders the control at run-time. (Inherited from CMSDynamicWebControl.)
Protected method	EnsureInitialization	Initializes the control. Is called within InitComplete or (Inherited from CMSDynamicWebControl.)
Public method Static member	GetControlValue	Gets the value of specified field.
Public method	GetDataValue	Returns DataRow value for the specified column.
Protected method	InitializeControl	Initializes the control. Is called within InitComplete or BeforeInitComplete (based on property InitEarly), or LoadViewState. You need to make sure to set the InitCompleted property once your control is properly initialized to avoid multiple initializations. (Inherited from CMSDynamicWebControl.)
Protected method	InitSpellCheck	Initializes the spell checker.
Public method	ItemChanged	Checks if item has changed.
Public method	LoadControlValues	Loads the values from the data container to the form controls.
Protected method	LoadViewState	Customized LoadViewState. (Inherited from CMSDynamicWebControl.)
Protected method	OnInit	Init event handler. (Inherited from CMSDynamicWebControl.)
Protected method	OnLoad	Load event handler. (Inherited from CMSDynamicWebControl.)
Protected method	Page_InitComplete	Event handler of page's init complete. (Inherited from CMSDynamicWebControl.)
Protected method	Render	Renders the control at design-time. (Overrides WebControl.Render(HtmlTextWriter).)
Protected method	SaveControlValue	Saves the control value to the data.
Protected method	SaveViewState	Customized SaveViewState. (Inherited from CMSDynamicWebControl.)
Protected method	SetDataValue	Sets value of the given column in the data.

Extension Methods

	Name	Description
Public Extension Method	AddCssClass	Adds CSS class to control. If class is already present, than adding is skipped. Class names are case sensitive. (Defined by ControlsExtensions.)
Public Extension Method	CallHandled	Calls the method handled by the exception handler. If the call doesn't succeed, the problem is reported through parent IExceptionHandler control instead of throwing unhandled exception for the entire page. Returns true, if the call succeeded, otherwise returns false. (Defined by ControlsExtensions.)
Public Extension Method	GetCssClasses	Returns all CSS classes of control. (Defined by ControlsExtensions.)
Public Extension Method	GetRenderedHTML	Returns HTML which would be rendered by control to page. (Defined by ControlsExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by ControlsExtensions.)
Public Extension Method	HasCssClass	Checks whether the control has given CSS class. Class names are case sensitive. (Defined by ControlsExtensions.)
Public Extension Method	RemoveCssClass	Removes all occurrences. Class names are case sensitive. (Defined by ControlsExtensions.)
Public Extension Method	SetCssClasses	Sets CSS classes to the control. Current classes will be overridden. (Defined by ControlsExtensions.)

Events

	Name	Description
Public event	OnGetControlValue	Occurs when a value is being extracted from a form control.