UIForm Class

Form control for the admin UI.

Inheritance Hierarchy

System.Object
  System.Web.UI.Control
    System.Web.UI.WebControls.WebControl
      CMS.Base.Web.UI.CMSWebControl
        CMS.Base.Web.UI.CMSDynamicWebControl
          CMS.FormEngine.Web.UI.AbstractBasicForm
            CMS.FormEngine.Web.UI.BasicForm
              CMS.PortalEngine.Web.UI.UIForm

Namespace: CMS.PortalEngine.Web.UI
Assembly: CMS.PortalEngine.Web.UI (in CMS.PortalEngine.Web.UI.dll) Version: 13.0.131

Syntax

public class UIForm : BasicForm, IObjectTypeDriven

The UIForm type exposes the following members.

Constructors

	Name	Description
Public method	UIForm	Constructor.

Fields

	Name	Description
Protected field	mSubmitButton	Form submit button. (Inherited from BasicForm.)
Protected field	mSubmitImageButton	Form submit image button. (Inherited from BasicForm.)

Properties

	Name	Description
Public property	AdditionalData	Gets a dictionary that provides additional context data for form controls. (Inherited from BasicForm.)
Public property	AllowMacroEditing	Determines whether to display the "Edit value" button in EditingFormControls. (Inherited from BasicForm.)
Public property	AllowModeSwitch	Determines whether to allow mode switching (simple <-> advanced). (Inherited from BasicForm.)
Public property	AllowSpellCheck	Indicates if spell check is allowed. Not allowed by default. (Inherited from AbstractBasicForm.)
Public property	AlternativeFormName	Gets or sets the name of the alternative form to use.
Public property	AltFormInformation	Alternative form information. (Inherited from BasicForm.)
Public property	AssociatedControls	Controls associated with FormItems. (Inherited from BasicForm.)
Public property	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.)
Protected property	ClassInfo	DataClassInfo of edited object. (Inherited from BasicForm.)
Public property	CollapseCategoryImageUrl	Image URL for collapsing a category. (Inherited from BasicForm.)
Public property	ContextResolver	Form context resolver. (Inherited from BasicForm.)
Public property	ControlContext	Gets the current control context. (Inherited from AbstractBasicForm.)
Public property	CustomTimeZone	Gets or sets custom time zone info. This time zone is used when TimeZoneType is 'custom'. (Inherited from AbstractBasicForm.)
Public property	Data	Data to be edited. (Inherited from AbstractBasicForm.)
Public property	DataRow	Data to be edited. (Inherited from AbstractBasicForm.)
Public property	DefaultCategoryName	Default category name. (Inherited from BasicForm.)
Public property	DefaultFieldLayout	Default field layout. (Inherited from BasicForm.)
Public property	DefaultFormLayout	Form layout. (Inherited from BasicForm.)
Protected property	DefaultValidationErrorMessage	Default validation error message. (Overrides BasicForm.DefaultValidationErrorMessage.)
Public property	DisplayNameChanged	Indicates whether display name of object was changed
Public property	EditedObject	Edited object.
Public property	Enabled	Indicates if the form control is enabled. (Inherited from BasicForm.)
Public property	EnabledByLockState	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 property	EnsureFirstLetterUpperCase	If true, labels of the controls are processed to have the first letter upper case. (Inherited from BasicForm.)
Public property	ErrorLabel	Label for the errors. (Inherited from BasicForm.)
Public property	ExpandCategoryImageUrl	Image URL for expanding a category. (Inherited from BasicForm.)
Public property	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.)
Public property	FieldCaptionCellCssClass	CSS class for the individual field label cell. (Inherited from BasicForm.)
Public property	FieldCaptionCssClass	CSS class for the individual field label. (Inherited from BasicForm.)
Public property	FieldControls	Dictionary with FormEngineUserControl objects. (Inherited from AbstractBasicForm.)
Public property	FieldCssClass	CSS class for the whole field (usually row). (Inherited from BasicForm.)
Public property	FieldEditingControls	Dictionary with EditingFormControl objects. (Inherited from AbstractBasicForm.)
Public property	FieldErrorCellCssClass	CSS class for the individual field error label cell. (Inherited from BasicForm.)
Public property	FieldErrorCssClass	CSS class that is added to editing form control after its validation failed. Default value is "Error". (Inherited from BasicForm.)
Public property	FieldErrorLabelCssClass	CSS class for the individual field error label. (Inherited from BasicForm.)
Public property	FieldErrorLabels	FieldErrorLabels. (Inherited from AbstractBasicForm.)
Public property	FieldGroupCaptionCssClass	CSS class for the field group caption. (Inherited from BasicForm.)
Public property	FieldGroupCssClass	CSS class for the whole field group. (Inherited from BasicForm.)
Public property	FieldGroupHeadingIsAnchor	Gets or sets a value indicating whether heading for the field group caption is anchor. (Inherited from BasicForm.)
Public property	FieldGroupHeadingLevel	Heading level for the field group caption. (Inherited from BasicForm.)
Public property	FieldLabels	FieldLabels. (Inherited from AbstractBasicForm.)
Public property	Fields	List of field names in order they appear in the form. (Inherited from AbstractBasicForm.)
Public property	FieldsToHide	List of fields to hide (empty by default). (Inherited from BasicForm.)
Public property	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.)
Public property	FieldValueCellCssClass	CSS class for the individual field control cell. (Inherited from BasicForm.)
Public property	FirstField	First field element. (Inherited from BasicForm.)
Public property	ForceReloadCategories	Forces categories to get to default collapsed state. (Inherited from BasicForm.)
Public property	FormButtonCssClass	CSS class for the form button. (Inherited from BasicForm.)
Public property	FormButtonPanel	Returns panel surrounding submit button if generated by automatic layouts, otherwise returns null. (Inherited from BasicForm.)
Public property	FormButtonPanelCssClass	CSS class for the form button panel. (Inherited from BasicForm.)
Public property	FormCssClass	CSS class which will be used to wrap form control. (Inherited from BasicForm.)
Protected property	FormDefaultStyle	Default form specific style configuration. (Overrides BasicForm.FormDefaultStyle.)
Public property	FormGUID	Identifies the instance of form. (Inherited from BasicForm.)
Public property	FormInformation	Form information. (Inherited from BasicForm.)
Public property	FormLayout	Definition of the form layout. (Inherited from BasicForm.)
Public property	FormLayoutType	Form layout type. (Inherited from BasicForm.)
Public property	FormPanel	Returns form outer panel. (Inherited from BasicForm.)
Public property	GroupCssClass	CSS class for the whole field group with heading. (Inherited from BasicForm.)
Public property	HideSystemFields	If true, system fields are hidden. (Inherited from BasicForm.)
Public property	HtmlAreaToolbar	HTML editor toolbar set name. (Inherited from BasicForm.)
Public property	HtmlAreaToolbarLocation	HTML editor toolbar location. (Inherited from BasicForm.)
Public property	InfoLabel	Information label. (Inherited from BasicForm.)
Public property	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.)
Protected property	InitEarly	If true, the control initializes on BeforeInitComplete, otherwise on InitComplete event. (Inherited from CMSDynamicWebControl.)
Public property	IsFirstLoad	Indicates if inner controls are loaded for the first time (the form may be initialized on a postback). (Inherited from BasicForm.)
Public property	IsInsertMode	Indicates if the control is used for inserting a new object. (Inherited from AbstractBasicForm.)
Public property	IsLiveSite	Indicates if control is used on live site. (Inherited from CMSWebControl.)
Public property	IsSimpleMode	Returns if the form is in simple or advanced mode. Depends on AllowModeSwitch property. (Inherited from BasicForm.)
Public property	LastField	Last field element. (Inherited from BasicForm.)
Public property	Layout	Layout of the form (Inherited from BasicForm.)
Public property	LayoutTemplate	Layout template, if set, the given layout is used. (Inherited from BasicForm.)
Public property	MacroTable	Hashtable with IsMacro flags. (Inherited from BasicForm.)
Public property	MarkRequiredFields	If true, required field labels are marked with resource string. (Inherited from BasicForm.)
Public property	MessagesPlaceHolder	Messages placeholder (Overrides BasicForm.MessagesPlaceHolder.)
Public property	Mode	Gets or sets the mode of the form. (Inherited from AbstractBasicForm.)
Public property	ObjectManager	Gets the object manager control if present on the page.
Public property	ObjectSiteID	Edited object site ID.
Public property	ObjectType	Object type for editing.
Public property	ParentObject	Parent object.
Public property	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.)
Public property	RedirectUrlAfterCreate	The URL to which the engine should redirect after creation of the new object. Set to empty string to disable redirect.
Public property	RedirectUrlAfterSave	URL to which the form redirects after successful save. (Inherited from BasicForm.)
Public property	RefreshHeader	Indicates whether header should be automatically refreshed when display name is changed.
Public property	ResolverName	Gets or sets macro resolver name. (Inherited from BasicForm.)
Public property	SecurityCheck	Security check.
Public property	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.)
Public property	ShortID	Short ID of the control. (Inherited from CMSWebControl.)
Public property	ShowImageButton	Show image button flag. (Inherited from BasicForm.)
Public property	ShowValidationErrorMessage	Indicates if error message should be displayed after validation failed. (Inherited from BasicForm.)
Public property	SiteName	Current SiteName. (Inherited from BasicForm.)
Public property	SpellCheckFields	List with client Ids of fields that should be spell checked. (Inherited from AbstractBasicForm.)
Public property	StopProcessing	Indicates if processing of the code of this control should continue. It can be used after raising an event. (Inherited from CMSDynamicWebControl.)
Public property	SubmitButton	Form submit button. (Inherited from BasicForm.)
Public property	SubmitImageButton	Form submit image button. (Inherited from BasicForm.)
Protected property	TagKey	Overrides the generation of the SPAN tag with custom tag. (Inherited from BasicForm.)
Public property	TimeZoneType	Gets or sets time zone type for child controls. Default value is TimeZoneTypeEnum.Inherit. (Inherited from AbstractBasicForm.)
Public property	UIContext	Control's UI Context (Inherited from BasicForm.)
Public property	UseColonBehindLabel	If true, colon(:) is placed behind field label. (Inherited from BasicForm.)
Public property	ValidationErrorMessage	Optional error message displayed after validation failed. (Inherited from BasicForm.)

Methods

	Name	Description
Public method	AddConfirmation	Adds confirmation text to existing message on the page, optionally with a tooltip text. (Inherited from BasicForm.)
Protected method	AddControlsAfterInternal	Allows to add additional components after the form. (Overrides BasicForm.AddControlsAfterInternal().)
Protected method	AddControlsBeforeInternal	Internal method to add components before the form from inherited forms. (Inherited from BasicForm.)
Public method	AddError	Adds error text to existing message on the page. (Inherited from BasicForm.)
Public method	AddInformation	Adds information text to existing message on the page. (Inherited from BasicForm.)
Public method	AddWarning	Adds warning text to existing message on the page. (Inherited from BasicForm.)
Protected method	AfterSaveActionsInternal	Executes additional actions after successful save. (Overrides BasicForm.AfterSaveActionsInternal(String, Boolean).)
Protected method	ConnectAssociatedControls	Connects associated controls (labels and inputs) together, for accessibility and other reasons. (Inherited from BasicForm.)
Protected method	CreateChildControls	Renders the control at run-time. (Inherited from CMSDynamicWebControl.)
Protected method	CreateMessagesPlaceHolder	Creates local messages placeholder. (Inherited from BasicForm.)
Public method	DisplayErrorLabel	Displays error label. (Inherited from BasicForm.)
Public method	EnableByLockState	Enables or disables form according to current checkout state with respect to current user.
Protected method	EnsureInitialization	Initializes the control. Is called within InitComplete or (Inherited from CMSDynamicWebControl.)
Protected method	EnsureLabels	Ensures the general labels on the form. (Inherited from BasicForm.)
Public method	EnsureMessagesPlaceholder	Ensures correct set the messages placeholder. (Inherited from BasicForm.)
Public method	GetDataValue	Returns DataRow value for the specified column. (Inherited from AbstractBasicForm.)
Public method	GetFieldValue	Gets the value of a specified field. (Inherited from BasicForm.)
Public method	GetWhereCondition	Gets where condition from all form engine user controls. (Inherited from BasicForm.)
Protected method	HandleFieldsValues	Initializes values for invisible fields. (Inherited from BasicForm.)
Protected method	InitFormInternal	Initializes the form information. (Overrides BasicForm.InitFormInternal().)
Protected method	InitializeControl	Initializes the form. (Inherited from BasicForm.)
Protected method	InitializeMainPanel	Initializes main form container. (Inherited from BasicForm.)
Protected method	InitResolver	Initializes macro resolver data sources. (Overrides BasicForm.InitResolver().)
Protected method	InitSpellCheck	Initializes the spell checker. (Inherited from AbstractBasicForm.)
Public method	IsAnyFieldVisible	Returns TRUE if basic form displays any control. (Inherited from BasicForm.)
Public method	IsCategoryCollapsed	Returns true if the given category is collapsed (Inherited from BasicForm.)
Public method	IsFieldAvailable	Checks if control is included in editing controls hashtable. (Inherited from BasicForm.)
Public method	IsFieldVisible	Checks if the given field is evaluated as visible. (Inherited from BasicForm.)
Public method	ItemChanged	Checks if item has changed. (Inherited from AbstractBasicForm.)
Protected method	layout_OnAfterRegisterFormControl	Event after control has been registered in template layout. (Inherited from BasicForm.)
Public method	LoadControlValues	Loads the values from the data container to the form controls. (Inherited from AbstractBasicForm.)
Public method	LoadData(DataRow)	Renders form and sets field values. (Inherited from BasicForm.)
Public method	LoadData(IDataContainer)	Renders form and sets field values. (Inherited from BasicForm.)
Protected method	LoadDefaultLayout	Loads default layout. (Inherited from BasicForm.)
Protected method	LoadFormLayout	Loads form layout. (Inherited from BasicForm.)
Protected method	LoadLayout	Loads the form layout. (Inherited from BasicForm.)
Protected method	LoadTemplateLayout	Loads the layout template. (Inherited from BasicForm.)
Protected method	LoadViewState	Customized LoadViewState. (Inherited from CMSDynamicWebControl.)
Protected method	OnInit	OnInit method. (Overrides CMSDynamicWebControl.OnInit(EventArgs).)
Protected method	OnLoad	Onload method. (Overrides CMSDynamicWebControl.OnLoad(EventArgs).)
Protected method	OnPreRender	OnPreRender method. (Overrides BasicForm.OnPreRender(EventArgs).)
Protected method	Page_InitComplete	Event handler of page's init complete. (Inherited from CMSDynamicWebControl.)
Protected method	PageHelper_InitComplete	Init complete event handler
Public method	PrependError	Prepends error text to existing message on the page. (Inherited from BasicForm.)
Public method	RaiseOnAfterSave	Raises the OnAfterSave event. (Inherited from BasicForm.)
Public method	RaiseOnBeforeRedirect	Raises the OnBeforeRedirect event. (Inherited from BasicForm.)
Protected method	RaiseOnCheckPermissions	Invokes OnCheckPermissions event. (Inherited from BasicForm.)
Public method	RaiseOnDeleteFile	Raises the OnDeleteFile event. (Inherited from BasicForm.)
Public method	RaiseOnSaveFailed	Raises the OnSaveFailed event. (Inherited from BasicForm.)
Public method	RaiseOnUploadFile	Raises the OnUploadFile event. (Inherited from BasicForm.)
Public method	ReloadData	Reloads the form data. (Inherited from BasicForm.)
Protected method	Render	Renders the control at design-time. (Inherited from BasicForm.)
Public method	ResolveMacros	Resolves the macros within current WebPart context. (Inherited from BasicForm.)
Protected method	SaveControlValue	Saves the control value to the data. (Inherited from AbstractBasicForm.)
Public method	SaveData	Saves data and optionally redirects user to specified URL. (Inherited from BasicForm.)
Protected method	SaveDataClick	Saves form data into Data container after the submit button is clicked. (Inherited from BasicForm.)
Protected method	SaveDataInternal	Internal method to save data to the database. (Overrides BasicForm.SaveDataInternal().)
Protected method	SaveViewState	Customized SaveViewState. (Inherited from CMSDynamicWebControl.)
Protected method	SetDataValue	Sets value of the given column in the data. (Inherited from AbstractBasicForm.)
Public method	ShowChangesSaved	Shows the general changes saved message. (Inherited from BasicForm.)
Public method	ShowConfirmation	Shows the general changes saved message. (Inherited from BasicForm.)
Public method	ShowError	Shows the specified error message, optionally with a tooltip text. (Inherited from BasicForm.)
Public method	ShowInformation	Shows the given information on the page, optionally with a tooltip text. (Inherited from BasicForm.)
Public method	ShowWarning	Shows the specified warning message, optionally with a tooltip text. (Inherited from BasicForm.)
Protected method	UIForm_OnCheckPermissions	Check permissions event handler.
Protected method	UIForm_OnItemValidation	Fired on the item validation.
Public method	ValidateData	Validates the data, returns true if succeeded. (Inherited from BasicForm.)

Extension Methods

	Name	Description
Public Extension Method	AddCssClass	Adds CSS class to control. If class is already present, than adding is skipped. Class names are case sensitive. (Defined by ControlsExtensions.)
Public Extension Method	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.)
Public Extension Method	GetCssClasses	Returns all CSS classes of control. (Defined by ControlsExtensions.)
Public Extension Method	GetRenderedHTML	Returns HTML which would be rendered by control to page. (Defined by ControlsExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by ControlsExtensions.)
Public Extension Method	HasCssClass	Checks whether the control has given CSS class. Class names are case sensitive. (Defined by ControlsExtensions.)
Public Extension Method	RemoveCssClass	Removes all occurrences. Class names are case sensitive. (Defined by ControlsExtensions.)
Public Extension Method	SetCssClasses	Sets CSS classes to the control. Current classes will be overridden. (Defined by ControlsExtensions.)

Events

	Name	Description
Public event	OnAfterDataLoad	After data load event. (Inherited from BasicForm.)
Public event	OnAfterSave	After form data save event. It is called during saving process when the form content is successfully saved. (Inherited from BasicForm.)
Public event	OnAfterValidate	After validation event. (Inherited from BasicForm.)
Public event	OnBeforeDataLoad	Before data load event. (Inherited from BasicForm.)
Public event	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.)
Public event	OnBeforeRedirect	Before redirect event (after successful save). (Inherited from BasicForm.)
Public event	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.)
Public event	OnBeforeValidate	Before validation event. (Inherited from BasicForm.)
Public event	OnCheckPermissions	Occurs when permission can be checked. It is called at the beginning of the saving process. (Inherited from BasicForm.)
Public event	OnCreate	Event for early initialization
Public event	OnDeleteFile	Occurs when the file is deleted. (Inherited from BasicForm.)
Public event	OnGetControlValue	Occurs when a value is being extracted from a form control. (Inherited from AbstractBasicForm.)
Public event	OnItemValidation	Occurs when a field is validated. (Inherited from BasicForm.)
Public event	OnSaveFailed	Occurs when saving data to the database fails. (Inherited from BasicForm.)
Public event	OnUploadFile	Occurs when the file is uploaded. (Inherited from BasicForm.)
Public event	OnValidationFailed	Occurs when validation of the form fails. (Inherited from BasicForm.)