BasicForm Class |
Namespace: CMS.FormEngine.Web.UI
public class BasicForm : AbstractBasicForm, IFormStyleConfiguration
The BasicForm type exposes the following members.
Name | Description | |
---|---|---|
BasicForm |
Constructor.
| |
BasicForm(IDataContainer) |
Constructor.
|
Name | Description | |
---|---|---|
mSubmitButton |
Form submit button.
| |
mSubmitImageButton |
Form submit image button.
|
Name | Description | |
---|---|---|
AdditionalData |
Gets a dictionary that provides additional context data for form controls.
| |
AllowMacroEditing |
Determines whether to display the "Edit value" button in EditingFormControls.
| |
AllowModeSwitch |
Determines whether to allow mode switching (simple <-> advanced).
| |
AllowSpellCheck |
Indicates if spell check is allowed. Not allowed by default.
(Inherited from AbstractBasicForm.) | |
AltFormInformation |
Alternative form information.
| |
AssociatedControls |
Controls associated with FormItems.
| |
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.
| |
ClassInfo |
DataClassInfo of edited object.
| |
CollapseCategoryImageUrl |
Image URL for collapsing a category.
| |
ContextResolver |
Form context resolver.
| |
ControlContext |
Gets the current control context.
(Inherited from AbstractBasicForm.) | |
CustomTimeZone |
Gets or sets custom time zone info. This time zone is used when TimeZoneType is 'custom'.
(Inherited from AbstractBasicForm.) | |
Data |
Data to be edited.
(Inherited from AbstractBasicForm.) | |
DataRow |
Data to be edited.
(Inherited from AbstractBasicForm.) | |
DefaultCategoryName |
Default category name.
| |
DefaultFieldLayout |
Default field layout.
| |
DefaultFormLayout |
Form layout.
| |
DefaultValidationErrorMessage |
Default validation error message.
Shown when ValidationErrorMessage is not set manually.
| |
EditedObject |
Edited object. TreeNode in CMSForm, IDataClass in BizForm and CustomTableForm,
AbstractInfo or DataClassInfo in DataForm.
| |
Enabled |
Indicates if the form control is enabled.
(Overrides WebControlEnabled.) | |
EnsureFirstLetterUpperCase |
If true, labels of the controls are processed to have the first letter upper case.
| |
ErrorLabel |
Label for the errors.
| |
ExpandCategoryImageUrl |
Image URL for expanding a category.
| |
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".
| |
FieldCaptionCellCssClass |
CSS class for the individual field label cell.
| |
FieldCaptionCssClass |
CSS class for the individual field label.
| |
FieldControls |
Dictionary with FormEngineUserControl objects.
(Inherited from AbstractBasicForm.) | |
FieldCssClass |
CSS class for the whole field (usually row).
| |
FieldEditingControls |
Dictionary with EditingFormControl objects.
(Inherited from AbstractBasicForm.) | |
FieldErrorCellCssClass |
CSS class for the individual field error label cell.
| |
FieldErrorCssClass |
CSS class that is added to editing form control after its validation failed. Default value is "Error".
| |
FieldErrorLabelCssClass |
CSS class for the individual field error label.
| |
FieldErrorLabels |
FieldErrorLabels.
(Inherited from AbstractBasicForm.) | |
FieldGroupCaptionCssClass |
CSS class for the field group caption.
| |
FieldGroupCssClass |
CSS class for the whole field group.
| |
FieldGroupHeadingIsAnchor |
Gets or sets a value indicating whether heading for the field group caption is anchor.
| |
FieldGroupHeadingLevel |
Heading level for the field group caption.
| |
FieldLabels |
FieldLabels.
(Inherited from AbstractBasicForm.) | |
Fields |
List of field names in order they appear in the form.
(Inherited from AbstractBasicForm.) | |
FieldsToHide |
List of fields to hide (empty by default).
| |
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.) | |
FieldValueCellCssClass |
CSS class for the individual field control cell.
| |
FirstField |
First field element.
| |
ForceReloadCategories |
Forces categories to get to default collapsed state.
| |
FormButtonCssClass |
CSS class for the form button.
| |
FormButtonPanel |
Returns panel surrounding submit button if generated by automatic layouts, otherwise returns null.
| |
FormButtonPanelCssClass |
CSS class for the form button panel.
| |
FormCssClass |
CSS class which will be used to wrap form control.
| |
FormDefaultStyle |
Default form-specific style configuration.
| |
FormGUID |
Identifies the instance of form.
| |
FormInformation |
Form information.
(Overrides AbstractBasicFormFormInformation.) | |
FormLayout |
Definition of the form layout.
| |
FormLayoutType |
Form layout type.
| |
FormPanel |
Returns form outer panel.
| |
GroupCssClass |
CSS class for the whole field group with heading.
| |
HideSystemFields |
If true, system fields are hidden.
| |
HtmlAreaToolbar |
HTML editor toolbar set name.
| |
HtmlAreaToolbarLocation |
HTML editor toolbar location.
| |
InfoLabel |
Information label.
| |
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.) | |
InitEarly |
If true, the control initializes on BeforeInitComplete, otherwise on InitComplete event.
(Inherited from CMSDynamicWebControl.) | |
IsFirstLoad |
Indicates if inner controls are loaded for the first time (the form may be initialized on a postback).
| |
IsInsertMode |
Indicates if the control is used for inserting a new object.
(Inherited from AbstractBasicForm.) | |
IsLiveSite |
Indicates if control is used on live site.
(Inherited from CMSWebControl.) | |
IsSimpleMode |
Returns if the form is in simple or advanced mode. Depends on AllowModeSwitch property.
| |
LastField |
Last field element.
| |
Layout |
Layout of the form
| |
LayoutTemplate |
Layout template, if set, the given layout is used.
| |
MacroTable |
Hashtable with IsMacro flags.
| |
MarkRequiredFields |
If true, required field labels are marked with resource string.
| |
MessagesPlaceHolder |
Messages placeholder
| |
Mode |
Gets or sets the mode of the form.
(Inherited from AbstractBasicForm.) | |
ParentObject |
Parent object. Setup in CMSFrom in insert mode, contains TreeNode.
| |
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.) | |
RedirectUrlAfterSave |
URL to which the form redirects after successful save.
| |
ResolverName |
Gets or sets macro resolver name.
| |
SetDefaultValuesToDisabledFields |
If true, default values will be set to the disabled fields. Default value is true in insert mode and false in edit mode.
| |
ShortID |
Short ID of the control.
(Inherited from CMSWebControl.) | |
ShowImageButton |
Show image button flag.
| |
ShowValidationErrorMessage |
Indicates if error message should be displayed after validation failed.
| |
SiteName |
Current SiteName.
| |
SpellCheckFields |
List with client Ids of fields that should be spell checked.
(Inherited from AbstractBasicForm.) | |
StopProcessing |
Indicates if processing of the code of this control should continue. It can be used after raising an event.
(Inherited from CMSDynamicWebControl.) | |
SubmitButton |
Form submit button.
| |
SubmitImageButton |
Form submit image button.
| |
TagKey |
Overrides the generation of the SPAN tag with custom tag.
(Overrides WebControlTagKey.) | |
TimeZoneType |
Gets or sets time zone type for child controls. Default value is TimeZoneTypeEnum.Inherit.
(Inherited from AbstractBasicForm.) | |
UIContext |
Control's UI Context
| |
UseColonBehindLabel |
If true, colon(:) is placed behind field label.
| |
ValidationErrorMessage |
Optional error message displayed after validation failed.
|
Name | Description | |
---|---|---|
AddConfirmation |
Adds confirmation text to existing message on the page, optionally with a tooltip text.
| |
AddControlsAfterInternal |
Internal method to add components after the form from inherited forms.
| |
AddControlsBeforeInternal |
Internal method to add components before the form from inherited forms.
| |
AddError |
Adds error text to existing message on the page.
| |
AddInformation |
Adds information text to existing message on the page.
| |
AddWarning |
Adds warning text to existing message on the page.
| |
AfterSaveActionsInternal |
Performs additional actions after save (redirecting or displaying info message).
| |
ConnectAssociatedControls |
Connects associated controls (labels and inputs) together, for accessibility and other reasons.
| |
CreateChildControls |
Renders the control at run-time.
(Inherited from CMSDynamicWebControl.) | |
CreateMessagesPlaceHolder |
Creates local messages placeholder.
| |
DisplayErrorLabel |
Displays error label.
| |
EnsureInitialization |
Initializes the control. Is called within InitComplete or
(Inherited from CMSDynamicWebControl.) | |
EnsureLabels |
Ensures the general labels on the form.
| |
EnsureMessagesPlaceholder |
Ensures correct set the messages placeholder.
| |
GetDataValue |
Returns DataRow value for the specified column.
(Inherited from AbstractBasicForm.) | |
GetFieldValue |
Gets the value of a specified field.
| |
GetWhereCondition |
Gets where condition from all form engine user controls.
| |
HandleFieldsValues |
Initializes values for invisible fields.
| |
InitFormInternal |
Internal method to initialize the form.
| |
InitializeControl |
Initializes the form.
(Overrides CMSDynamicWebControlInitializeControl.) | |
InitializeMainPanel |
Initializes main form container.
| |
InitResolver |
Initializes macro resolver data sources.
| |
InitSpellCheck |
Initializes the spell checker.
(Inherited from AbstractBasicForm.) | |
IsAnyFieldVisible |
Returns TRUE if basic form displays any control.
| |
IsCategoryCollapsed |
Returns true if the given category is collapsed
| |
IsFieldAvailable |
Checks if control is included in editing controls hashtable.
| |
IsFieldVisible |
Checks if the given field is evaluated as visible.
| |
ItemChanged |
Checks if item has changed.
(Inherited from AbstractBasicForm.) | |
layout_OnAfterRegisterFormControl |
Event after control has been registered in template layout.
| |
LoadControlValues |
Loads the values from the data container to the form controls.
(Inherited from AbstractBasicForm.) | |
LoadData(DataRow) |
Renders form and sets field values.
| |
LoadData(IDataContainer) |
Renders form and sets field values.
| |
LoadDefaultLayout |
Loads default layout.
| |
LoadFormLayout |
Loads form layout.
| |
LoadLayout |
Loads the form layout.
| |
LoadTemplateLayout |
Loads the layout template.
| |
LoadViewState |
Customized LoadViewState.
(Inherited from CMSDynamicWebControl.) | |
OnInit |
Init event handler.
(Inherited from CMSDynamicWebControl.) | |
OnLoad |
Load event handler.
(Inherited from CMSDynamicWebControl.) | |
OnPreRender |
Pre-render event handler.
(Overrides ControlOnPreRender(EventArgs).) | |
Page_InitComplete |
Event handler of page's init complete.
(Inherited from CMSDynamicWebControl.) | |
PrependError |
Prepends error text to existing message on the page.
| |
RaiseOnAfterSave |
Raises the OnAfterSave event.
| |
RaiseOnBeforeRedirect |
Raises the OnBeforeRedirect event.
| |
RaiseOnCheckPermissions |
Invokes OnCheckPermissions event.
| |
RaiseOnDeleteFile |
Raises the OnDeleteFile event.
| |
RaiseOnSaveFailed |
Raises the OnSaveFailed event.
| |
RaiseOnUploadFile |
Raises the OnUploadFile event.
| |
ReloadData |
Reloads the form data.
| |
Render |
Renders the control at design-time.
(Overrides AbstractBasicFormRender(HtmlTextWriter).) | |
ResolveMacros |
Resolves the macros within current WebPart context.
| |
SaveControlValue |
Saves the control value to the data.
(Inherited from AbstractBasicForm.) | |
SaveData |
Saves data and optionally redirects user to specified URL.
| |
SaveDataClick |
Saves form data into Data container after the submit button is clicked.
| |
SaveDataInternal |
Internal method to save data to the database.
| |
SaveViewState |
Customized SaveViewState.
(Inherited from CMSDynamicWebControl.) | |
SetDataValue |
Sets value of the given column in the data.
(Inherited from AbstractBasicForm.) | |
ShowChangesSaved |
Shows the general changes saved message.
| |
ShowConfirmation |
Shows the general changes saved message.
| |
ShowError |
Shows the specified error message, optionally with a tooltip text.
| |
ShowInformation |
Shows the given information on the page, optionally with a tooltip text.
| |
ShowWarning |
Shows the specified warning message, optionally with a tooltip text.
| |
ValidateData |
Validates the data, returns true if succeeded.
|
Name | Description | |
---|---|---|
AddCssClass |
Adds CSS class to control. If class is already present, than adding is skipped. Class names are case sensitive.
(Defined by ControlsExtensions.) | |
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.) | |
GetCssClasses |
Returns all CSS classes of control.
(Defined by ControlsExtensions.) | |
GetRenderedHTML |
Returns HTML which would be rendered by control to page.
(Defined by ControlsExtensions.) | |
GetString |
Gets the string by the specified resource key
(Defined by ControlsExtensions.) | |
HasCssClass |
Checks whether the control has given CSS class. Class names are case sensitive.
(Defined by ControlsExtensions.) | |
RemoveCssClass |
Removes all occurrences. Class names are case sensitive.
(Defined by ControlsExtensions.) | |
SetCssClasses |
Sets CSS classes to the control. Current classes will be overridden.
(Defined by ControlsExtensions.) |
Name | Description | |
---|---|---|
OnAfterDataLoad |
After data load event.
| |
OnAfterSave |
After form data save event. It is called during saving process when the form content is successfully saved.
| |
OnAfterValidate |
After validation event.
| |
OnBeforeDataLoad |
Before data load event.
| |
OnBeforeDataRetrieval |
Before form data retrieval event. It is called during saving process after successful validation and before data are retrieved from form controls.
| |
OnBeforeRedirect |
Before redirect event (after successful save).
| |
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).
| |
OnBeforeValidate |
Before validation event.
| |
OnCheckPermissions |
Occurs when permission can be checked. It is called at the beginning of the saving process.
| |
OnDeleteFile |
Occurs when the file is deleted.
| |
OnGetControlValue |
Occurs when a value is being extracted from a form control.
(Inherited from AbstractBasicForm.) | |
OnItemValidation |
Occurs when a field is validated.
| |
OnSaveFailed |
Occurs when saving data to the database fails.
| |
OnUploadFile |
Occurs when the file is uploaded.
| |
OnValidationFailed |
Occurs when validation of the form fails.
|