Click or drag to resize
AbstractBasicForm Class
Abstract class for BasicForm.
Inheritance Hierarchy

Namespace: CMS.FormEngine.Web.UI
Assembly: CMS.FormEngine.Web.UI (in CMS.FormEngine.Web.UI.dll) Version: 10.0.0
Syntax
C#
public abstract class AbstractBasicForm : CMSDynamicWebControl, 
	INamingContainer, ITimeZoneManager, IControlContextManager

The AbstractBasicForm type exposes the following members.

Constructors
  NameDescription
Protected methodAbstractBasicForm
Constructor.
Top
Properties
  NameDescription
Public propertyAllowSpellCheck
Indicates if spell check is allowed. Not allowed by default.
Public propertyControlContext
Gets the current control context.
Public propertyCustomTimeZone
Gets or sets custom time zone info. This time zone is used when TimeZoneType is 'custom'.
Public propertyData
Data to be edited.
Public propertyDataRow
Data to be edited.
Public propertyFieldActionsControls
Contains FieldActions controls if the form is in design mode (BasicForm.IsDesignMode property).
Public propertyFieldControls
Dictionary with FormEngineUserControl objects.
Public propertyFieldEditingControls
Dictionary with EditingFormControl objects.
Public propertyFieldErrorLabels
FieldErrorLabels.
Public propertyFieldLabels
FieldLabels.
Public propertyFields
List of field names in order they appear in the form.
Public propertyFieldUpdatePanels
Contains update panels which surround the fields (whole rows including labels) if the form is in design mode (BasicForm.IsDesignMode property).
Public propertyFieldVisibilityControls
Visibility controls hashtable.
Public propertyFormInformation
Form information.
Public propertyInitCompleted
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 propertyInitEarly
If true, the control initializes on BeforeInitComplete, otherwise on InitComplete event.
(Inherited from CMSDynamicWebControl.)
Public propertyIsInsertMode
Indicates if the control is used for inserting a new object.
Public propertyIsLiveSite
Indicates if control is used on live site.
(Inherited from CMSWebControl.)
Public propertyMode
Gets or sets the mode of the form.
Public propertyProcessDisabledFields
Indicates if disabled fields should be processed (validated and saved). Default value is true in insert mode and false in edit mode.
Public propertyShortID
Short ID of the control.
(Inherited from CMSWebControl.)
Public propertySpellCheckFields
List with client Ids of fields that should be spell checked.
Public propertyStopProcessing
Indicates if processing of the code of this control should continue. It can be used after raising an event.
(Inherited from CMSDynamicWebControl.)
Public propertyTimeZoneType
Gets or sets time zone type for child controls. Default value is TimeZoneTypeEnum.Inherit.
Top
Methods
  NameDescription
Protected methodCreateChildControls
Renders the control at run-time.
(Inherited from CMSDynamicWebControl.)
Protected methodEnsureInitialization
Initializes the control. Is called within InitComplete or
(Inherited from CMSDynamicWebControl.)
Public methodStatic memberGetControlValue
Gets the value of specified field.
Public methodGetDataValue
Returns DataRow value for the specified column.
Protected methodInitializeControl
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 methodInitSpellCheck
Initializes the spell checker.
Public methodItemChanged
Checks if item has changed.
Public methodLoadControlValues
Loads the values from the data container to the form controls.
Protected methodLoadViewState
Customized LoadViewState.
(Inherited from CMSDynamicWebControl.)
Protected methodOnInit
Init event handler.
(Inherited from CMSDynamicWebControl.)
Protected methodOnLoad
Load event handler.
(Inherited from CMSDynamicWebControl.)
Protected methodPage_InitComplete
Event handler of page's init complete.
(Inherited from CMSDynamicWebControl.)
Protected methodRender
Renders the control at design-time.
(Overrides WebControlRender(HtmlTextWriter).)
Protected methodSaveControlValue
Saves the control value to the data.
Protected methodSaveViewState
Customized SaveViewState.
(Inherited from CMSDynamicWebControl.)
Protected methodSetDataValue
Sets value of the given column in the data.
Top
Extension Methods
  NameDescription
Public Extension MethodAddCssClass
Adds CSS class to control. If class is already present, than adding is skipped. Class names are case sensitive.
(Defined by ControlsExtensions.)
Public Extension MethodCallHandled
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 MethodGetCssClasses
Returns all CSS classes of control.
(Defined by ControlsExtensions.)
Public Extension MethodGetRenderedHTML
Returns HTML which would be rendered by control to page.
(Defined by ControlsExtensions.)
Public Extension MethodGetString
Gets the string by the specified resource key
(Defined by ControlsExtensions.)
Public Extension MethodHasCssClass
Checks whether the control has given CSS class. Class names are case sensitive.
(Defined by ControlsExtensions.)
Public Extension MethodRemoveCssClass
Removes all occurrences. Class names are case sensitive.
(Defined by ControlsExtensions.)
Public Extension MethodSetCssClasses
Sets CSS classes to the control. Current classes will be overridden.
(Defined by ControlsExtensions.)
Top
Events
  NameDescription
Public eventOnGetControlValue
Occurs when a value is being extracted from a form control.
Top
See Also