CMSForm Class |
Namespace: CMS.FormControls
public class CMSForm : BasicForm
The CMSForm type exposes the following members.
Name | Description | |
---|---|---|
AddConfirmation |
Adds confirmation text to existing message on the page, optionally with a tooltip text.
(Inherited from BasicForm.) | |
AddControlsAfterInternal |
Allows to add additional components after the form.
(Overrides BasicFormAddControlsAfterInternal.) | |
AddControlsBeforeInternal |
Allows to add additional components before the form.
(Overrides BasicFormAddControlsBeforeInternal.) | |
AddError |
Adds error text to existing message on the page.
(Inherited from BasicForm.) | |
AddInformation |
Adds information text to existing message on the page.
(Inherited from BasicForm.) | |
AddWarning |
Adds warning text to existing message on the page.
(Inherited from BasicForm.) | |
AfterSaveActionsInternal |
Performs additional actions after save (redirecting or displaying info message).
(Inherited from BasicForm.) | |
CMSForm_OnAfterDataLoad |
OnAfterDataReload event handler.
| |
ConnectAssociatedControls |
Connects associated controls (labels and inputs) together, for accessibility and other reasons.
(Inherited from BasicForm.) | |
CreateChildControls |
Renders the control at run-time.
(Inherited from CMSDynamicWebControl.) | |
CreateMessagesPlaceHolder |
Creates local messages placeholder.
(Overrides BasicFormCreateMessagesPlaceHolder.) | |
DisplayErrorLabel |
Displays error label.
(Inherited from BasicForm.) | |
EnsureInitialization |
Initializes the control. Is called within InitComplete or
(Inherited from CMSDynamicWebControl.) | |
EnsureLabels |
Ensures the general labels on the form.
(Inherited from BasicForm.) | |
EnsureMessagesPlaceholder |
Ensures correct set the messages placeholder.
(Inherited from BasicForm.) | |
GetAttachment |
Returns attachment info and raises OnGetAttachment event.
(Inherited from BasicForm.) | |
GetAttachmentInternal |
Returns attachment info.
(Overrides BasicFormGetAttachmentInternal(Guid).) | |
GetClassName |
Extracts class name from the form name.
| |
GetDataValue |
Returns DataRow value for the specified column.
(Inherited from AbstractBasicForm.) | |
GetFieldValue |
Gets the value of a specified field.
(Inherited from BasicForm.) | |
GetMultifieldValues |
Gets the multi-field values of a specified field.
(Inherited from BasicForm.) | |
GetWhereCondition |
Gets where condition from all form engine user controls.
(Inherited from BasicForm.) | |
HandleFieldsValues |
Initializes default values for invisible fields.
(Inherited from BasicForm.) | |
InitFormInternal |
Initializes the form.
(Overrides BasicFormInitFormInternal.) | |
InitializeControl |
Initializes the form.
(Inherited from BasicForm.) | |
InitializeMainPanel |
Initializes main form container.
(Inherited from BasicForm.) | |
InitResolver |
Initializes macro resolver data sources.
(Overrides BasicFormInitResolver.) | |
InitSpellCheck |
Initializes the spell checker.
(Inherited from AbstractBasicForm.) | |
IsAnyFieldVisible |
Returns TRUE if basic form displays any control.
(Inherited from BasicForm.) | |
IsCategoryCollapsed |
Returns true if the given category is collapsed
(Inherited from BasicForm.) | |
IsFieldAvailable |
Checks if control is included in editing controls hashtable.
(Inherited from BasicForm.) | |
IsFieldVisible |
Checks if the given field is evaluated as visible.
(Inherited from BasicForm.) | |
ItemChanged |
Checks if item has changed.
(Inherited from AbstractBasicForm.) | |
layout_OnAfterRegisterFormControl |
Event after control has been registered in template layout.
(Inherited from BasicForm.) | |
LoadControlValues |
Loads the values from the data container to the form controls.
(Inherited from AbstractBasicForm.) | |
LoadData(DataRow) |
Renders form and sets field values.
(Inherited from BasicForm.) | |
LoadData(IDataContainer) |
Renders form and sets field values.
(Inherited from BasicForm.) | |
LoadDefaultLayout |
Loads default layout.
(Inherited from BasicForm.) | |
LoadForm |
Loads the child controls at run-time.
| |
LoadFormLayout |
Loads form layout.
(Inherited from BasicForm.) | |
LoadLayout |
Loads the form layout.
(Inherited from BasicForm.) | |
LoadTemplateLayout |
Loads the layout template.
(Inherited from BasicForm.) | |
LoadViewState |
Customized LoadViewState.
(Inherited from CMSDynamicWebControl.) | |
OnInit |
OnInit event
(Overrides CMSDynamicWebControlOnInit(EventArgs).) | |
OnLoad |
Load event handler.
(Inherited from CMSDynamicWebControl.) | |
OnPreRender |
OnPreRender event
(Overrides BasicFormOnPreRender(EventArgs).) | |
Page_InitComplete |
Event handler of page's init complete.
(Inherited from CMSDynamicWebControl.) | |
PrependError |
Prepends error text to existing message on the page.
(Inherited from BasicForm.) | |
ProcessContextVisibility |
Changes fields' visible attribute according to display context.
(Inherited from BasicForm.) | |
ProcessUserVisibility |
Changes fields' visible attribute according to user visibility settings or changes form definition if visibility can be edited.
(Inherited from BasicForm.) | |
ProcessVisibility |
Changes fields' visible attribute according to visibility.
(Inherited from BasicForm.) | |
RaiseOnAfterSave |
Raises the OnAfterSave event.
(Inherited from BasicForm.) | |
RaiseOnBeforeRedirect |
Raises the OnBeforeRedirect event.
(Inherited from BasicForm.) | |
RaiseOnDeleteFile |
Raises the OnDeleteFile event.
(Inherited from BasicForm.) | |
RaiseOnCheckPermissions |
Invokes OnCheckPermissions event.
(Inherited from BasicForm.) | |
RaiseOnSaveFailed |
Raises the OnSaveFailed event.
(Inherited from BasicForm.) | |
RaiseOnUploadFile |
Raises the OnUploadFile event.
(Inherited from BasicForm.) | |
ReloadData |
Reloads the form data.
(Inherited from BasicForm.) | |
Render |
Renders the control at design-time.
(Overrides BasicFormRender(HtmlTextWriter).) | |
ResolveMacros |
Resolves the macros within current WebPart context.
(Inherited from BasicForm.) | |
Save |
Saves document data.
| |
SaveControlValue |
Saves the control value to the data.
(Inherited from AbstractBasicForm.) | |
SaveData |
Saves data and optionally redirects user to specified URL.
(Inherited from BasicForm.) | |
SaveDataClick |
Saves form data into Data container after the submit button is clicked.
(Inherited from BasicForm.) | |
SaveDataInternal |
Saves data to database. It's called after mBasicForm.SaveData().
(Overrides BasicFormSaveDataInternal.) | |
SaveViewState |
Customized SaveViewState.
(Inherited from CMSDynamicWebControl.) | |
SetDataValue |
Sets value of the given column in the data.
(Inherited from AbstractBasicForm.) | |
ShowConfirmation |
Shows the general changes saved message.
(Inherited from BasicForm.) | |
ShowError |
Shows the specified error message, optionally with a tooltip text.
(Inherited from BasicForm.) | |
ShowChangesSaved |
Shows the general changes saved message.
(Inherited from BasicForm.) | |
ShowInformation |
Shows the given information on the page, optionally with a tooltip text.
(Inherited from BasicForm.) | |
ShowWarning |
Shows the specified warning message, optionally with a tooltip text.
(Inherited from BasicForm.) | |
ValidateData |
Validates the data, returns true if succeeded.
(Inherited from BasicForm.) |
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.) | |
AsValue |
Converts object to a query value which can be used as a query parameter
(Defined by QueryExtensions.) | |
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.) | |
GetAPIString |
Gets the string by the specified resource key
(Defined by CoreExtensions.) | |
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 CoreExtensions.) | |
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.) | |
ToBoolean |
Returns the boolean representation of an object or default value if not.
(Defined by CoreExtensions.) | |
ToDateTime |
Returns the DateTime representation of an object or default value if not.
(Defined by CoreExtensions.) | |
ToDouble |
Returns the double representation of an object or default value if not.
(Defined by CoreExtensions.) | |
ToGuid |
Returns the Guid representation of an object or default value if not.
(Defined by CoreExtensions.) | |
ToInteger |
Returns the integer representation of an object or default value if not.
(Defined by CoreExtensions.) | |
ToString |
Returns the string representation of an object or default value if not.
(Defined by CoreExtensions.) |
Name | Description | |
---|---|---|
categoryListPanel |
Category list panel, may be displayed above formPanel.
(Inherited from BasicForm.) | |
categoryListPlaceholder |
Placeholder for category list.
(Inherited from BasicForm.) | |
deleteFiles |
List of files (controls) to delete files.
| |
lblError | Obsolete.
Error label.
| |
lblInfo | Obsolete.
Info label.
| |
mDefaultPageTemplateID |
Default page template ID.
| |
mDocumentManager |
Document manager.
| |
mMessagesPlaceHolder |
Messages placeholder
| |
mOwnerID |
Owner ID.
| |
mShowPrivateFields |
Nonpublic fields are shown if true.
(Inherited from BasicForm.) | |
mSubmitButton |
Form submit button.
(Inherited from BasicForm.) | |
mSubmitImageButton |
Form submit image button.
(Inherited from BasicForm.) | |
uploadFiles |
List of files (controls) to upload files.
|
Name | Description | |
---|---|---|
AdditionalData |
Gets a dictionary that provides additional context data for form controls.
(Inherited from BasicForm.) | |
AllowEditVisibility |
Indicates if field visibility could be edited.
(Inherited from BasicForm.) | |
AllowExternalEditing |
Indicates if external editing should be allowed for the controls.
(Inherited from BasicForm.) | |
AllowMacroEditing |
Determines whether to display the "Edit value" button in EditingFormControls.
(Inherited from BasicForm.) | |
AllowModeSwitch |
Determines whether to allow mode switching (simple <-> advanced).
(Inherited from BasicForm.) | |
AllowSpellCheck |
Indicates if spell check is allowed. Not allowed by default.
(Inherited from AbstractBasicForm.) | |
AlternativeFormFullName |
Alternative form full name (ClassName.AlternativeFormName).
| |
AltFormInformation |
Alternative form information.
(Inherited from BasicForm.) | |
ApplyVisibility |
Indicates if field visibility should be applied.
(Inherited from BasicForm.) | |
AssociatedControls |
Controls associated with FormItems.
(Inherited from BasicForm.) | |
AutomaticLabelWidth |
Set width of all labels according to the widest label.
This property is applied only if DefaultFormLayout is set to Divs.
(Inherited from BasicForm.) | |
ClassInfo |
DataClassInfo of edited object.
(Inherited from BasicForm.) | |
CollapseCategoryImageUrl |
Image URL for collapsing a category.
(Inherited from BasicForm.) | |
ComponentName |
Component name.
| |
ContextResolver |
Form context resolver.
(Inherited from BasicForm.) | |
ControlContext |
Gets the current control context.
(Inherited from AbstractBasicForm.) | |
CopyDefaultDataFromDocumentId |
Optional DocumentId of the document that should be used as a template with default values.
| |
CultureCode |
Culture code.
| |
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.
(Inherited from BasicForm.) | |
DefaultFieldLayout |
Default field layout.
(Inherited from BasicForm.) | |
DefaultFormLayout |
Form layout.
(Inherited from BasicForm.) | |
DefaultPageTemplateID |
Default page template ID.
| |
DefaultValidationErrorMessage |
Default validation error message.
(Overrides BasicFormDefaultValidationErrorMessage.) | |
DialogParameters |
Additional parameters for the dialog windows.
(Inherited from BasicForm.) | |
DisplayContext |
Gets or sets the current display context which is used if control contains DisplayIn value.
(Inherited from BasicForm.) | |
DocumentID |
Specifies together with CultureCode edited node.
| |
DocumentManager |
Document manager control
| |
EditedObject |
Edited object. TreeNode in CMSForm, IDataClass in BizForm and CustomTableForm,
AbstractInfo or DataClassInfo in DataForm.
(Inherited from BasicForm.) | |
Enabled |
Indicates if the form control is enabled.
(Inherited from BasicForm.) | |
EnsureFirstLetterUpperCase |
If true, labels of the controls are processed to have the first letter upper case.
(Inherited from BasicForm.) | |
ErrorLabel |
Label for the errors.
(Overrides BasicFormErrorLabel.) | |
ExpandCategoryImageUrl |
Image URL for expanding a category.
(Inherited from BasicForm.) | |
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".
(Inherited from BasicForm.) | |
FieldActionsControls |
Contains FieldActions controls if the form is in design mode (BasicForm.IsDesignMode property).
(Inherited from AbstractBasicForm.) | |
FieldCaptionCellCssClass |
CSS class for the individual field label cell.
(Inherited from BasicForm.) | |
FieldCaptionCssClass |
CSS class for the individual field label.
(Inherited from BasicForm.) | |
FieldControls |
Dictionary with FormEngineUserControl objects.
(Inherited from AbstractBasicForm.) | |
FieldCssClass |
CSS class for the whole field (usually row).
(Inherited from BasicForm.) | |
FieldEditingControls |
Dictionary with EditingFormControl objects.
(Inherited from AbstractBasicForm.) | |
FieldErrorCellCssClass |
CSS class for the individual field error label cell.
(Inherited from BasicForm.) | |
FieldErrorCssClass |
CSS class that is added to editing form control after its validation failed. Default value is "Error".
(Inherited from BasicForm.) | |
FieldErrorLabelCssClass |
CSS class for the individual field error label.
(Inherited from BasicForm.) | |
FieldErrorLabels |
FieldErrorLabels.
(Inherited from AbstractBasicForm.) | |
FieldGroupCaptionCssClass |
CSS class for the field group caption.
(Inherited from BasicForm.) | |
FieldGroupCssClass |
CSS class for the whole field group.
(Inherited from BasicForm.) | |
FieldGroupHeadingIsAnchor |
Gets or sets a value indicating whether heading for the field group caption is anchor.
(Inherited from BasicForm.) | |
FieldGroupHeadingLevel |
Heading level for the field group caption.
(Inherited from BasicForm.) | |
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).
(Inherited from BasicForm.) | |
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.
(Inherited from BasicForm.) | |
FieldVisibilityCellCssClass |
CSS class for the individual field visibility cell.
(Inherited from BasicForm.) | |
FieldVisibilityControls |
Visibility controls hashtable.
(Inherited from AbstractBasicForm.) | |
FieldVisibilityCssClass |
CSS class for the individual field visibility control.
(Inherited from BasicForm.) | |
FirstField |
First field element.
(Inherited from BasicForm.) | |
ForceReloadCategories |
Forces categories to get to default collapsed state.
(Inherited from BasicForm.) | |
FormButtonCssClass |
CSS class for the form button.
(Inherited from BasicForm.) | |
FormButtonPanel |
Returns panel surrounding submit button if generated by automatic layouts, otherwise returns null.
(Inherited from BasicForm.) | |
FormButtonPanelCssClass |
CSS class for the form button panel.
(Inherited from BasicForm.) | |
FormCssClass |
CSS class which will be used to wrap form control.
(Inherited from BasicForm.) | |
FormDefaultStyle |
Default form-specific style configuration.
(Inherited from BasicForm.) | |
FormGUID |
Identifies the instance of form.
(Inherited from BasicForm.) | |
FormInformation |
Form information.
(Inherited from BasicForm.) | |
FormLayout |
Definition of the form layout.
(Inherited from BasicForm.) | |
FormLayoutType |
Form layout type.
(Inherited from BasicForm.) | |
FormMode |
Form mode - insert or update.
| |
FormName |
Form name in form application.class.form.
| |
FormPanel |
Returns form outer panel.
(Inherited from BasicForm.) | |
FormPrefix |
Form name prefix. If set, form with name in format [FormPrefix][form name] is searched instead of [form name].
| |
FormType |
Indicates in what control is this basic form used.
(Inherited from BasicForm.) | |
GroupCssClass |
CSS class for the whole field group with heading.
(Inherited from BasicForm.) | |
GroupID |
Group ID.
| |
HideSystemFields |
If true, system fields are hidden.
(Inherited from BasicForm.) | |
HtmlAreaToolbar |
HTML editor toolbar set name.
(Inherited from BasicForm.) | |
HtmlAreaToolbarLocation |
HTML editor toolbar location.
(Inherited from BasicForm.) | |
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.
(Inherited from BasicForm.) | |
InfoLabel |
Information label.
(Overrides BasicFormInfoLabel.) | |
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.) | |
IsDesignMode |
Determines whether the form is in design mode.
(Inherited from BasicForm.) | |
IsFirstLoad |
Indicates if inner controls are loaded for the first time (the form may be initialized on a postback).
(Inherited from BasicForm.) | |
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 |
Sets simple/advanced mode of basicform.
(Inherited from BasicForm.) | |
LastField |
Last field element.
(Inherited from BasicForm.) | |
Layout |
Layout of the form
(Inherited from BasicForm.) | |
LayoutTemplate |
Layout template, if set, the given layout is used.
(Inherited from BasicForm.) | |
MacroTable |
Hashtable with IsMacro flags.
(Inherited from BasicForm.) | |
MarkRequiredFields |
If true, required field labels are marked with resource string.
(Inherited from BasicForm.) | |
MessagesPlaceHolder |
Messages placeholder.
(Overrides BasicFormMessagesPlaceHolder.) | |
Mode |
Gets or sets the mode of the form.
(Inherited from AbstractBasicForm.) | |
Node |
Document node.
| |
NodeID |
Specifies together with CultureCode edited node.
| |
OwnerID |
Owner ID.
| |
ParentNodeID |
Parent node ID. Indicates parent node for document insertion.
| |
ParentObject |
Parent node of currently edited/inserted node
| |
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.
(Inherited from BasicForm.) | |
ResolverName |
Gets or sets macro resolver name.
(Inherited from BasicForm.) | |
SetDefaultValuesToDisabledFields |
If true, default values will be set to the disabled fields. Default value is true in insert mode and false in edit mode.
(Inherited from BasicForm.) | |
ShortID |
Short ID of the control.
(Inherited from CMSWebControl.) | |
ShowImageButton |
Show image button flag.
(Inherited from BasicForm.) | |
ShowOkButton |
Indicates if button OK should be displayed.
| |
ShowPrivateFields |
Indicates whether to show private fields or not.
(Inherited from BasicForm.) | |
ShowValidationErrorMessage |
Indicates if error message should be displayed after validation failed.
(Inherited from BasicForm.) | |
SiteName |
Current SiteName.
(Inherited from BasicForm.) | |
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.
(Inherited from BasicForm.) | |
SubmitImageButton |
Form submit image button.
(Inherited from BasicForm.) | |
TagKey |
Overrides the generation of the SPAN tag with custom tag.
(Inherited from BasicForm.) | |
TimeZoneType |
Gets or sets time zone type for child controls. Default value is TimeZoneTypeEnum.Inherit.
(Inherited from AbstractBasicForm.) | |
TreeProvider |
Tree provider instance. If it's not provided, it's created automatically.
| |
UIContext |
Returns control's UI context
(Inherited from CMSWebControl.) | |
UseColonBehindLabel |
If true, colon(:) is placed behind field label.
(Inherited from BasicForm.) | |
ValidationErrorMessage |
Optional error message displayed after validation failed.
(Inherited from BasicForm.) | |
VisibilityFormName |
This name is used if ApplyVisibility is 'true' to get visibility definition of current user.
(Inherited from BasicForm.) |
Name | Description | |
---|---|---|
OnAfterDataLoad |
After data load event.
(Inherited from BasicForm.) | |
OnAfterSave |
After form data save event. It is called during saving process when the form content is successfully saved.
(Inherited from BasicForm.) | |
OnAfterValidate |
After validation event.
(Inherited from BasicForm.) | |
OnBeforeDataLoad |
Before data load event.
(Inherited from BasicForm.) | |
OnBeforeDataRetrieval |
Before form data retrieval event. It is called during saving process after successful validation and before data are retrieved from form controls.
(Inherited from BasicForm.) | |
OnBeforeRedirect |
Before redirect event (after successful save).
(Inherited from BasicForm.) | |
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).
(Inherited from BasicForm.) | |
OnBeforeValidate |
Before validation event.
(Inherited from BasicForm.) | |
OnDeleteFile |
Occurs when the file is deleted.
(Inherited from BasicForm.) | |
OnGetAttachment |
Occurs when an attachment is retrieved.
(Inherited from BasicForm.) | |
OnGetControlValue |
Occurs when a value is being extracted from a form control.
(Inherited from AbstractBasicForm.) | |
OnCheckPermissions |
Occurs when permission can be checked. It is called at the beginning of the saving process.
(Inherited from BasicForm.) | |
OnItemValidation |
Occurs when a field is validated.
(Inherited from BasicForm.) | |
OnSaveFailed |
Occurs when saving data to the database fails.
(Inherited from BasicForm.) | |
OnUploadFile |
Occurs when the file is uploaded.
(Inherited from BasicForm.) | |
OnValidationFailed |
Occurs when validation of the form fails.
(Inherited from BasicForm.) |