Click or drag to resize
UIForm Properties

The UIForm type exposes the following members.

Properties
  NameDescription
Public propertyAdditionalData
Gets a dictionary that provides additional context data for form controls.
(Inherited from BasicForm.)
Public propertyAllowMacroEditing
Determines whether to display the "Edit value" button in EditingFormControls.
(Inherited from BasicForm.)
Public propertyAllowModeSwitch
Determines whether to allow mode switching (simple <-> advanced).
(Inherited from BasicForm.)
Public propertyAllowSpellCheck
Indicates if spell check is allowed. Not allowed by default.
(Inherited from AbstractBasicForm.)
Public propertyAlternativeFormName
Gets or sets the name of the alternative form to use.
Public propertyAltFormInformation
Alternative form information.
(Inherited from BasicForm.)
Public propertyAssociatedControls
Controls associated with FormItems.
(Inherited from BasicForm.)
Public propertyCheckFieldEmptiness
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.)
Protected propertyClassInfo
DataClassInfo of edited object.
(Inherited from BasicForm.)
Public propertyCollapseCategoryImageUrl
Image URL for collapsing a category.
(Inherited from BasicForm.)
Public propertyContextResolver
Form context resolver.
(Inherited from BasicForm.)
Public propertyControlContext
Gets the current control context.
(Inherited from AbstractBasicForm.)
Public propertyCustomTimeZone
Gets or sets custom time zone info. This time zone is used when TimeZoneType is 'custom'.
(Inherited from AbstractBasicForm.)
Public propertyData
Data to be edited.
(Inherited from AbstractBasicForm.)
Public propertyDataRow
Data to be edited.
(Inherited from AbstractBasicForm.)
Public propertyDefaultCategoryName
Default category name.
(Inherited from BasicForm.)
Public propertyDefaultFieldLayout
Default field layout.
(Inherited from BasicForm.)
Public propertyDefaultFormLayout
Form layout.
(Inherited from BasicForm.)
Protected propertyDefaultValidationErrorMessage
Default validation error message.
(Overrides BasicFormDefaultValidationErrorMessage.)
Public propertyDisplayNameChanged
Indicates whether display name of object was changed
Public propertyEditedObject
Edited object.
Public propertyEnabled
Indicates if the form control is enabled.
(Inherited from BasicForm.)
Public propertyEnabledByLockState
Gets or sets a value that indicates if the form enabled state is set automatically based on the lock state of the edited object.
Public propertyEnsureFirstLetterUpperCase
If true, labels of the controls are processed to have the first letter upper case.
(Inherited from BasicForm.)
Public propertyErrorLabel
Label for the errors.
(Inherited from BasicForm.)
Public propertyExpandCategoryImageUrl
Image URL for expanding a category.
(Inherited from BasicForm.)
Public propertyExplanationTextCssClass
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.)
Public propertyFieldCaptionCellCssClass
CSS class for the individual field label cell.
(Inherited from BasicForm.)
Public propertyFieldCaptionCssClass
CSS class for the individual field label.
(Inherited from BasicForm.)
Public propertyFieldControls
Dictionary with FormEngineUserControl objects.
(Inherited from AbstractBasicForm.)
Public propertyFieldCssClass
CSS class for the whole field (usually row).
(Inherited from BasicForm.)
Public propertyFieldEditingControls
Dictionary with EditingFormControl objects.
(Inherited from AbstractBasicForm.)
Public propertyFieldErrorCellCssClass
CSS class for the individual field error label cell.
(Inherited from BasicForm.)
Public propertyFieldErrorCssClass
CSS class that is added to editing form control after its validation failed. Default value is "Error".
(Inherited from BasicForm.)
Public propertyFieldErrorLabelCssClass
CSS class for the individual field error label.
(Inherited from BasicForm.)
Public propertyFieldErrorLabels
FieldErrorLabels.
(Inherited from AbstractBasicForm.)
Public propertyFieldGroupCaptionCssClass
CSS class for the field group caption.
(Inherited from BasicForm.)
Public propertyFieldGroupCssClass
CSS class for the whole field group.
(Inherited from BasicForm.)
Public propertyFieldGroupHeadingIsAnchor
Gets or sets a value indicating whether heading for the field group caption is anchor.
(Inherited from BasicForm.)
Public propertyFieldGroupHeadingLevel
Heading level for the field group caption.
(Inherited from BasicForm.)
Public propertyFieldLabels
FieldLabels.
(Inherited from AbstractBasicForm.)
Public propertyFields
List of field names in order they appear in the form.
(Inherited from AbstractBasicForm.)
Public propertyFieldsToHide
List of fields to hide (empty by default).
(Inherited from BasicForm.)
Public propertyFieldUpdatePanels
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 propertyFieldValueCellCssClass
CSS class for the individual field control cell.
(Inherited from BasicForm.)
Public propertyFirstField
First field element.
(Inherited from BasicForm.)
Public propertyForceReloadCategories
Forces categories to get to default collapsed state.
(Inherited from BasicForm.)
Public propertyFormButtonCssClass
CSS class for the form button.
(Inherited from BasicForm.)
Public propertyFormButtonPanel
Returns panel surrounding submit button if generated by automatic layouts, otherwise returns null.
(Inherited from BasicForm.)
Public propertyFormButtonPanelCssClass
CSS class for the form button panel.
(Inherited from BasicForm.)
Public propertyFormCssClass
CSS class which will be used to wrap form control.
(Inherited from BasicForm.)
Protected propertyFormDefaultStyle
Default form specific style configuration.
(Overrides BasicFormFormDefaultStyle.)
Public propertyFormGUID
Identifies the instance of form.
(Inherited from BasicForm.)
Public propertyFormInformation
Form information.
(Inherited from BasicForm.)
Public propertyFormLayout
Definition of the form layout.
(Inherited from BasicForm.)
Public propertyFormLayoutType
Form layout type.
(Inherited from BasicForm.)
Public propertyFormPanel
Returns form outer panel.
(Inherited from BasicForm.)
Public propertyGroupCssClass
CSS class for the whole field group with heading.
(Inherited from BasicForm.)
Public propertyHideSystemFields
If true, system fields are hidden.
(Inherited from BasicForm.)
Public propertyHtmlAreaToolbar
HTML editor toolbar set name.
(Inherited from BasicForm.)
Public propertyHtmlAreaToolbarLocation
HTML editor toolbar location.
(Inherited from BasicForm.)
Public propertyInfoLabel
Information label.
(Inherited from BasicForm.)
Public propertyInitCompleted
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 propertyInitEarly
If true, the control initializes on BeforeInitComplete, otherwise on InitComplete event.
(Inherited from CMSDynamicWebControl.)
Public propertyIsFirstLoad
Indicates if inner controls are loaded for the first time (the form may be initialized on a postback).
(Inherited from BasicForm.)
Public propertyIsInsertMode
Indicates if the control is used for inserting a new object.
(Inherited from AbstractBasicForm.)
Public propertyIsLiveSite
Indicates if control is used on live site.
(Inherited from CMSWebControl.)
Public propertyIsSimpleMode
Returns if the form is in simple or advanced mode. Depends on AllowModeSwitch property.
(Inherited from BasicForm.)
Public propertyLastField
Last field element.
(Inherited from BasicForm.)
Public propertyLayout
Layout of the form
(Inherited from BasicForm.)
Public propertyLayoutTemplate
Layout template, if set, the given layout is used.
(Inherited from BasicForm.)
Public propertyMacroTable
Hashtable with IsMacro flags.
(Inherited from BasicForm.)
Public propertyMarkRequiredFields
If true, required field labels are marked with resource string.
(Inherited from BasicForm.)
Public propertyMessagesPlaceHolder
Messages placeholder
(Overrides BasicFormMessagesPlaceHolder.)
Public propertyMode
Gets or sets the mode of the form.
(Inherited from AbstractBasicForm.)
Public propertyObjectManager
Gets the object manager control if present on the page.
Public propertyObjectSiteID
Edited object site ID.
Public propertyObjectType
Object type for editing.
Public propertyParentObject
Parent object.
Public propertyProcessDisabledFields
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 propertyRedirectUrlAfterCreate
The URL to which the engine should redirect after creation of the new object. Set to empty string to disable redirect.
Public propertyRedirectUrlAfterSave
URL to which the form redirects after successful save.
(Inherited from BasicForm.)
Public propertyRefreshHeader
Indicates whether header should be automatically refreshed when display name is changed.
Public propertyResolverName
Gets or sets macro resolver name.
(Inherited from BasicForm.)
Public propertySecurityCheck
Security check.
Public propertySetDefaultValuesToDisabledFields
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.)
Public propertyShortID
Short ID of the control.
(Inherited from CMSWebControl.)
Public propertyShowImageButton
Show image button flag.
(Inherited from BasicForm.)
Public propertyShowValidationErrorMessage
Indicates if error message should be displayed after validation failed.
(Inherited from BasicForm.)
Public propertySiteName
Current SiteName.
(Inherited from BasicForm.)
Public propertySpellCheckFields
List with client Ids of fields that should be spell checked.
(Inherited from AbstractBasicForm.)
Public propertyStopProcessing
Indicates if processing of the code of this control should continue. It can be used after raising an event.
(Inherited from CMSDynamicWebControl.)
Public propertySubmitButton
Form submit button.
(Inherited from BasicForm.)
Public propertySubmitImageButton
Form submit image button.
(Inherited from BasicForm.)
Protected propertyTagKey
Overrides the generation of the SPAN tag with custom tag.
(Inherited from BasicForm.)
Public propertyTimeZoneType
Gets or sets time zone type for child controls. Default value is TimeZoneTypeEnum.Inherit.
(Inherited from AbstractBasicForm.)
Public propertyUIContext
Control's UI Context
(Inherited from BasicForm.)
Public propertyUseColonBehindLabel
If true, colon(:) is placed behind field label.
(Inherited from BasicForm.)
Public propertyValidationErrorMessage
Optional error message displayed after validation failed.
(Inherited from BasicForm.)
Top
See Also