CMSForm Properties |
The CMSForm type exposes the following members.
Name | Description | |
---|---|---|
AdditionalData |
Gets a dictionary that provides additional context data for form 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.) | |
AssociatedControls |
Controls associated with FormItems.
(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.) | |
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.) | |
DefaultValidationErrorMessage |
Default validation error message.
(Overrides BasicFormDefaultValidationErrorMessage.) | |
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.) | |
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.) | |
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].
| |
GroupCssClass |
CSS class for the whole field group with heading.
(Inherited from BasicForm.) | |
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.) | |
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.) | |
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 |
Returns if the form is in simple or advanced mode. Depends on AllowModeSwitch property.
(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.
| |
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 |
Control's UI Context
(Inherited from BasicForm.) | |
UseColonBehindLabel |
If true, colon(:) is placed behind field label.
(Inherited from BasicForm.) | |
ValidationErrorMessage |
Optional error message displayed after validation failed.
(Inherited from BasicForm.) |