BasicForm Properties |
The BasicForm type exposes the following members.
Name | Description | |
---|---|---|
AdditionalData |
Gets a dictionary that provides additional context data for form controls.
| |
AllowEditVisibility |
Indicates if field visibility could be edited.
| |
AllowExternalEditing |
Indicates if external editing should be allowed for the 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.
| |
ApplyVisibility |
Indicates if field visibility should be applied.
| |
AssociatedControls |
Controls associated with FormItems.
| |
AutomaticLabelWidth |
Set width of all labels according to the widest label.
This property is applied only if DefaultFormLayout is set to Divs.
| |
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.
| |
DialogParameters |
Additional parameters for the dialog windows.
| |
DisplayContext |
Gets or sets the current display context which is used if control contains DisplayIn value.
| |
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".
| |
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.
| |
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.
| |
FieldVisibilityCellCssClass |
CSS class for the individual field visibility cell.
| |
FieldVisibilityControls |
Visibility controls hashtable.
(Inherited from AbstractBasicForm.) | |
FieldVisibilityCssClass |
CSS class for the individual field visibility control.
| |
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.
| |
FormType |
Indicates in what control is this basic form used.
| |
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.) | |
IsDesignMode |
Determines whether the form is in design mode.
| |
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.
| |
ShowPrivateFields |
Indicates whether to show private fields or not.
| |
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.
| |
VisibilityFormName |
This name is used if ApplyVisibility is 'true' to get visibility definition of current user.
|