BasicForm Class

Basic form engine independent on CMS. It displays the specified form.

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
              More...

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

Syntax

public class BasicForm : AbstractBasicForm, IFormStyleConfiguration

The BasicForm type exposes the following members.

Constructors

	Name	Description
Public method	BasicForm()	Constructor.
Public method	BasicForm(IDataContainer)	Constructor.

Fields

	Name	Description
Protected field	categoryListPanel	Category list panel, may be displayed above formPanel.
Protected field	categoryListPlaceholder	Placeholder for category list.
Protected field	mShowPrivateFields	Nonpublic fields are shown if true.
Protected field	mSubmitButton	Form submit button.
Protected field	mSubmitImageButton	Form submit image button.

Properties

	Name	Description
Public property	AdditionalData	Gets a dictionary that provides additional context data for form controls.
Public property	AllowEditVisibility	Indicates if field visibility could be edited.
Public property	AllowExternalEditing	Indicates if external editing should be allowed for the controls.
Public property	AllowMacroEditing	Determines whether to display the "Edit value" button in EditingFormControls.
Public property	AllowModeSwitch	Determines whether to allow mode switching (simple <-> advanced).
Public property	AllowSpellCheck	Indicates if spell check is allowed. Not allowed by default. (Inherited from AbstractBasicForm.)
Public property	AltFormInformation	Alternative form information.
Public property	ApplyVisibility	Indicates if field visibility should be applied.
Public property	AssociatedControls	Controls associated with FormItems.
Public property	AutomaticLabelWidth	Set width of all labels according to the widest label. This property is applied only if DefaultFormLayout is set to Divs.
Public property	CheckFieldEmptiness	Indicates that field should be checked on emptiness in validation step by BasicForm. Default TRUE. It is preferable to set to FALSE for controls with complex input such as filter form.
Protected property	ClassInfo	DataClassInfo of edited object.
Public property	CollapseCategoryImageUrl	Image URL for collapsing a category.
Public property	ContextResolver	Form context resolver.
Public property	ControlContext	Gets the current control context. (Inherited from AbstractBasicForm.)
Public property	CustomTimeZone	Gets or sets custom time zone info. This time zone is used when TimeZoneType is 'custom'. (Inherited from AbstractBasicForm.)
Public property	Data	Data to be edited. (Inherited from AbstractBasicForm.)
Public property	DataRow	Data to be edited. (Inherited from AbstractBasicForm.)
Public property	DefaultCategoryName	Default category name.
Public property	DefaultFieldLayout	Default field layout.
Public property	DefaultFormLayout	Form layout.
Protected property	DefaultValidationErrorMessage	Default validation error message. Shown when ValidationErrorMessage is not set manually.
Public property	DialogParameters	Additional parameters for the dialog windows.
Public property	DisplayContext	Gets or sets the current display context which is used if control contains DisplayIn value.
Public property	EditedObject	Edited object. TreeNode in CMSForm, IDataClass in BizForm and CustomTableForm, AbstractInfo or DataClassInfo in DataForm.
Public property	Enabled	Indicates if the form control is enabled. (Overrides WebControl.Enabled.)
Public property	EnsureFirstLetterUpperCase	If true, labels of the controls are processed to have the first letter upper case.
Public property	ErrorLabel	Label for the errors.
Public property	ExpandCategoryImageUrl	Image URL for expanding a category.
Public property	ExplanationTextCssClass	CSS class that is added to container that is wrapping content after text (only if content before text is empty). Default value is "ExplanationText".
Public property	FieldActionsControls	Contains FieldActions controls if the form is in design mode (BasicForm.IsDesignMode property). (Inherited from AbstractBasicForm.)
Public property	FieldCaptionCellCssClass	CSS class for the individual field label cell.
Public property	FieldCaptionCssClass	CSS class for the individual field label.
Public property	FieldControls	Dictionary with FormEngineUserControl objects. (Inherited from AbstractBasicForm.)
Public property	FieldCssClass	CSS class for the whole field (usually row).
Public property	FieldEditingControls	Dictionary with EditingFormControl objects. (Inherited from AbstractBasicForm.)
Public property	FieldErrorCellCssClass	CSS class for the individual field error label cell.
Public property	FieldErrorCssClass	CSS class that is added to editing form control after its validation failed. Default value is "Error".
Public property	FieldErrorLabelCssClass	CSS class for the individual field error label.
Public property	FieldErrorLabels	FieldErrorLabels. (Inherited from AbstractBasicForm.)
Public property	FieldGroupCaptionCssClass	CSS class for the field group caption.
Public property	FieldGroupCssClass	CSS class for the whole field group.
Public property	FieldGroupHeadingIsAnchor	Gets or sets a value indicating whether heading for the field group caption is anchor.
Public property	FieldGroupHeadingLevel	Heading level for the field group caption.
Public property	FieldLabels	FieldLabels. (Inherited from AbstractBasicForm.)
Public property	Fields	List of field names in order they appear in the form. (Inherited from AbstractBasicForm.)
Public property	FieldsToHide	List of fields to hide (empty by default).
Public property	FieldUpdatePanels	Contains update panels which surround the fields (whole rows including labels) if the form is in design mode (BasicForm.IsDesignMode property). (Inherited from AbstractBasicForm.)
Public property	FieldValueCellCssClass	CSS class for the individual field control cell.
Public property	FieldVisibilityCellCssClass	CSS class for the individual field visibility cell.
Public property	FieldVisibilityControls	Visibility controls hashtable. (Inherited from AbstractBasicForm.)
Public property	FieldVisibilityCssClass	CSS class for the individual field visibility control.
Public property	FirstField	First field element.
Public property	ForceReloadCategories	Forces categories to get to default collapsed state.
Public property	FormButtonCssClass	CSS class for the form button.
Public property	FormButtonPanel	Returns panel surrounding submit button if generated by automatic layouts, otherwise returns null.
Public property	FormButtonPanelCssClass	CSS class for the form button panel.
Public property	FormCssClass	CSS class which will be used to wrap form control.
Protected property	FormDefaultStyle	Default form-specific style configuration.
Public property	FormGUID	Identifies the instance of form.
Public property	FormInformation	Form information. (Overrides AbstractBasicForm.FormInformation.)
Public property	FormLayout	Definition of the form layout.
Public property	FormLayoutType	Form layout type.
Public property	FormPanel	Returns form outer panel.
Public property	FormType	Indicates in what control is this basic form used.
Public property	GroupCssClass	CSS class for the whole field group with heading.
Public property	HideSystemFields	If true, system fields are hidden.
Public property	HtmlAreaToolbar	HTML editor toolbar set name.
Public property	HtmlAreaToolbarLocation	HTML editor toolbar location.
Public property	InfoLabel	Information label.
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	IsDesignMode	Determines whether the form is in design mode.
Public property	IsFirstLoad	Indicates if inner controls are loaded for the first time (the form may be initialized on a postback).
Public property	IsInsertMode	Indicates if the control is used for inserting a new object. (Inherited from AbstractBasicForm.)
Public property	IsLiveSite	Indicates if control is used on live site. (Inherited from CMSWebControl.)
Public property	IsSimpleMode	Returns if the form is in simple or advanced mode. Depends on AllowModeSwitch property.
Public property	LastField	Last field element.
Public property	Layout	Layout of the form
Public property	LayoutTemplate	Layout template, if set, the given layout is used.
Public property	MacroTable	Hashtable with IsMacro flags.
Public property	MarkRequiredFields	If true, required field labels are marked with resource string.
Public property	MessagesPlaceHolder	Messages placeholder
Public property	Mode	Gets or sets the mode of the form. (Inherited from AbstractBasicForm.)
Public property	ParentObject	Parent object. Setup in CMSFrom in insert mode, contains TreeNode.
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. (Inherited from AbstractBasicForm.)
Public property	RedirectUrlAfterSave	URL to which the form redirects after successful save.
Public property	ResolverName	Gets or sets macro resolver name.
Public property	SetDefaultValuesToDisabledFields	If true, default values will be set to the disabled fields. 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	ShowImageButton	Show image button flag.
Public property	ShowPrivateFields	Indicates whether to show private fields or not.
Public property	ShowValidationErrorMessage	Indicates if error message should be displayed after validation failed.
Public property	SiteName	Current SiteName.
Public property	SpellCheckFields	List with client Ids of fields that should be spell checked. (Inherited from AbstractBasicForm.)
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	SubmitButton	Form submit button.
Public property	SubmitImageButton	Form submit image button.
Protected property	TagKey	Overrides the generation of the SPAN tag with custom tag. (Overrides WebControl.TagKey.)
Public property	TimeZoneType	Gets or sets time zone type for child controls. Default value is TimeZoneTypeEnum.Inherit. (Inherited from AbstractBasicForm.)
Public property	UIContext	Control's UI Context
Public property	UseColonBehindLabel	If true, colon(:) is placed behind field label.
Public property	ValidationErrorMessage	Optional error message displayed after validation failed.
Public property	VisibilityFormName	This name is used if ApplyVisibility is 'true' to get visibility definition of current user.

Methods

	Name	Description
Public method	AddConfirmation	Adds confirmation text to existing message on the page, optionally with a tooltip text.
Protected method	AddControlsAfterInternal	Internal method to add components after the form from inherited forms.
Protected method	AddControlsBeforeInternal	Internal method to add components before the form from inherited forms.
Public method	AddError	Adds error text to existing message on the page.
Public method	AddInformation	Adds information text to existing message on the page.
Public method	AddWarning	Adds warning text to existing message on the page.
Protected method	AfterSaveActionsInternal	Performs additional actions after save (redirecting or displaying info message).
Protected method	ConnectAssociatedControls	Connects associated controls (labels and inputs) together, for accessibility and other reasons.
Protected method	CreateChildControls	Renders the control at run-time. (Inherited from CMSDynamicWebControl.)
Protected method	CreateMessagesPlaceHolder	Creates local messages placeholder.
Public method	DisplayErrorLabel	Displays error label.
Protected method	EnsureInitialization	Initializes the control. Is called within InitComplete or (Inherited from CMSDynamicWebControl.)
Protected method	EnsureLabels	Ensures the general labels on the form.
Public method	EnsureMessagesPlaceholder	Ensures correct set the messages placeholder.
Public method Static member	FormTypeEnumToString	Returns the string representation of the form type.
Public method	GetDataValue	Returns DataRow value for the specified column. (Inherited from AbstractBasicForm.)
Public method	GetFieldValue	Gets the value of a specified field.
Public method	GetMultifieldValues	Gets the multi-field values of a specified field.
Public method	GetWhereCondition	Gets where condition from all form engine user controls.
Protected method	HandleFieldsValues	Initializes values for invisible fields.
Protected method	InitFormInternal	Internal method to initialize the form.
Protected method	InitializeControl	Initializes the form. (Overrides CMSDynamicWebControl.InitializeControl().)
Protected method	InitializeMainPanel	Initializes main form container.
Protected method	InitResolver	Initializes macro resolver data sources.
Protected method	InitSpellCheck	Initializes the spell checker. (Inherited from AbstractBasicForm.)
Public method	IsAnyFieldVisible	Returns TRUE if basic form displays any control.
Public method	IsCategoryCollapsed	Returns true if the given category is collapsed
Public method	IsFieldAvailable	Checks if control is included in editing controls hashtable.
Public method	IsFieldVisible	Checks if the given field is evaluated as visible.
Public method	ItemChanged	Checks if item has changed. (Inherited from AbstractBasicForm.)
Protected method	layout_OnAfterRegisterFormControl	Event after control has been registered in template layout.
Public method	LoadControlValues	Loads the values from the data container to the form controls. (Inherited from AbstractBasicForm.)
Public method	LoadData(DataRow)	Renders form and sets field values.
Public method	LoadData(IDataContainer)	Renders form and sets field values.
Protected method	LoadDefaultLayout	Loads default layout.
Protected method	LoadFormLayout	Loads form layout.
Protected method	LoadLayout	Loads the form layout.
Protected method	LoadTemplateLayout	Loads the layout template.
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	OnPreRender	Pre-render event handler. (Overrides Control.OnPreRender(EventArgs).)
Protected method	Page_InitComplete	Event handler of page's init complete. (Inherited from CMSDynamicWebControl.)
Public method	PrependError	Prepends error text to existing message on the page.
Protected method	ProcessContextVisibility	Changes fields' visible attribute according to display context.
Protected method	ProcessUserVisibility	Changes fields' visible attribute according to user visibility settings or changes form definition if visibility can be edited.
Protected method	ProcessVisibility	Changes fields' visible attribute according to visibility.
Public method	RaiseOnAfterSave	Raises the OnAfterSave event.
Public method	RaiseOnBeforeRedirect	Raises the OnBeforeRedirect event.
Protected method	RaiseOnCheckPermissions	Invokes OnCheckPermissions event.
Public method	RaiseOnDeleteFile	Raises the OnDeleteFile event.
Public method	RaiseOnSaveFailed	Raises the OnSaveFailed event.
Public method	RaiseOnUploadFile	Raises the OnUploadFile event.
Public method	ReloadData	Reloads the form data.
Protected method	Render	Renders the control at design-time. (Overrides AbstractBasicForm.Render(HtmlTextWriter).)
Public method	ResolveMacros	Resolves the macros within current WebPart context.
Protected method	SaveControlValue	Saves the control value to the data. (Inherited from AbstractBasicForm.)
Public method	SaveData	Saves data and optionally redirects user to specified URL.
Protected method	SaveDataClick	Saves form data into Data container after the submit button is clicked.
Protected method	SaveDataInternal	Internal method to save data to the database.
Protected method	SaveViewState	Customized SaveViewState. (Inherited from CMSDynamicWebControl.)
Protected method	SetDataValue	Sets value of the given column in the data. (Inherited from AbstractBasicForm.)
Public method	ShowChangesSaved	Shows the general changes saved message.
Public method	ShowConfirmation	Shows the general changes saved message.
Public method	ShowError	Shows the specified error message, optionally with a tooltip text.
Public method	ShowInformation	Shows the given information on the page, optionally with a tooltip text.
Public method	ShowWarning	Shows the specified warning message, optionally with a tooltip text.
Public method Static member	StringToFormTypeEnum	Returns the enumeration representation of the form type.
Public method	ValidateData	Validates the data, returns true if succeeded.

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	OnAfterDataLoad	After data load event.
Public event	OnAfterSave	After form data save event. It is called during saving process when the form content is successfully saved.
Public event	OnAfterValidate	After validation event.
Public event	OnBeforeDataLoad	Before data load event.
Public event	OnBeforeDataRetrieval	Before form data retrieval event. It is called during saving process after successful validation and before data are retrieved from form controls.
Public event	OnBeforeRedirect	Before redirect event (after successful save).
Public event	OnBeforeSave	Before form data save event. It is called during saving process after data are retrieved from form controls and can be processed further (e.g. saved to DB).
Public event	OnBeforeValidate	Before validation event.
Public event	OnCheckPermissions	Occurs when permission can be checked. It is called at the beginning of the saving process.
Public event	OnDeleteFile	Occurs when the file is deleted.
Public event	OnGetControlValue	Occurs when a value is being extracted from a form control. (Inherited from AbstractBasicForm.)
Public event	OnItemValidation	Occurs when a field is validated.
Public event	OnSaveFailed	Occurs when saving data to the database fails.
Public event	OnUploadFile	Occurs when the file is uploaded.
Public event	OnValidationFailed	Occurs when validation of the form fails.