Click or drag to resize
FormControl Class
Form control for the forms.
Inheritance Hierarchy

Namespace: CMS.FormEngine.Web.UI
Assembly: CMS.FormEngine.Web.UI (in CMS.FormEngine.Web.UI.dll) Version: 12.0.0
Syntax
C#
public class FormControl : CMSDynamicWebControl, 
	INamingContainer

The FormControl type exposes the following members.

Constructors
  NameDescription
Public methodFormControl
Top
Properties
  NameDescription
Public propertyAutoPostBack
Gets or sets whether a postback automatically occurs.
Public propertyCheckUnique
If true, the field is checked for uniqueness. This property is only supported in UIForm.
Public propertyCssClass
Control CSS class.
Public propertyEditingControl
Editing control.
Public propertyEnabled
Gets or sets state enable.
(Overrides WebControlEnabled.)
Public propertyField
Field name for the inner controls. This property is only supported in templated form.
Public propertyForm
Form where the control is used.
Public propertyFormControlName
Form control name.
Public propertyFormFieldInfo
FormFieldInfo for current control.
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 propertyIsLiveSite
Indicates if control is used on live site.
Public propertyProperties
Properties definition.
Public propertyShortID
Short ID of the control.
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 propertySupportsDisabledAttribute
Gets a value that indicates whether the control should set the disabled attribute of the rendered HTML element to "disabled" when the control's IsEnabled property is false.
(Overrides WebControlSupportsDisabledAttribute.)
Protected propertyTagKey
TagKey used to render (Div).
(Overrides WebControlTagKey.)
Public propertyText
Gets or sets value converted to string
Public propertyTrim
If true, the value is trimmed. This property is only supported if used inside the form control.
Public propertyUseFFI
Indicates if control should load properties from FormFieldInfo. Default TRUE.
Public propertyValue
Value used for initialization as default value.
Top
Methods
  NameDescription
Protected methodCreateChildControls
Renders the control at run-time.
(Inherited from CMSDynamicWebControl.)
Protected methodEnsureChildControlControlType
Ensures the first found child control of the given type in the given variable
Protected methodEnsureInitialization
Initializes the control. Is called within InitComplete or
(Inherited from CMSDynamicWebControl.)
Public methodGetValue(String)
Returns the value of the given web part property property.
Public methodGetValueReturnType(String, ReturnType)
Returns the value of the given web part property property.
Protected methodInitializeControl
Loads the form control
(Overrides CMSDynamicWebControlInitializeControl.)
Protected methodLoadViewState
Customized LoadViewState.
(Inherited from CMSDynamicWebControl.)
Protected methodOnInit
Init event handler.
(Inherited from CMSDynamicWebControl.)
Protected methodOnLoad
Load event handler.
(Inherited from CMSDynamicWebControl.)
Protected methodOnPreRender
OnPreRender override.
(Overrides ControlOnPreRender(EventArgs).)
Protected methodPage_InitComplete
Event handler of page's init complete.
(Inherited from CMSDynamicWebControl.)
Public methodReload
Reloads inner controls. Can be used after additional initialization.
Protected methodSaveViewState
Customized SaveViewState.
(Inherited from CMSDynamicWebControl.)
Public methodSetValue
Sets the property value of the control, setting the value affects only local property value.
Top
Extension Methods
  NameDescription
Public Extension MethodAddCssClass
Adds CSS class to control. If class is already present, than adding is skipped. Class names are case sensitive.
(Defined by ControlsExtensions.)
Public Extension MethodCallHandled
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 MethodGetCssClasses
Returns all CSS classes of control.
(Defined by ControlsExtensions.)
Public Extension MethodGetRenderedHTML
Returns HTML which would be rendered by control to page.
(Defined by ControlsExtensions.)
Public Extension MethodGetString
Gets the string by the specified resource key
(Defined by ControlsExtensions.)
Public Extension MethodHasCssClass
Checks whether the control has given CSS class. Class names are case sensitive.
(Defined by ControlsExtensions.)
Public Extension MethodRemoveCssClass
Removes all occurrences. Class names are case sensitive.
(Defined by ControlsExtensions.)
Public Extension MethodSetCssClasses
Sets CSS classes to the control. Current classes will be overridden.
(Defined by ControlsExtensions.)
Top
See Also
Inheritance Hierarchy
SystemObject
  System.Web.UIControl
    System.Web.UI.WebControlsWebControl
      CMS.Base.Web.UICMSWebControl
        CMS.Base.Web.UICMSDynamicWebControl
          CMS.FormEngine.Web.UIFormControl
            CMS.Blogs.Web.UISelectBlogName
            CMS.Community.Web.UIGroupSelector
            CMS.Community.Web.UIViewGroupAccess
            CMS.Community.Web.UIViewGroupAvatar
            CMS.Ecommerce.Web.UISelectBundleInventoryType
            CMS.Forums.Web.UIFullForumSelector
            CMS.MediaLibrary.Web.UIFullMediaLibrarySelector
            CMS.MessageBoards.Web.UISelectBoardWithAll
            CMS.Newsletters.Web.UINewsletterSelectorSimple
            CMS.Notifications.Web.UIMultipleNotificationGatewaySelector
            CMS.Notifications.Web.UINotificationTemplateSelector
            CMS.Reporting.Web.UIReportGraphSelector
            CMS.Reporting.Web.UIReportSelector
            CMS.Reporting.Web.UIReportTableSelector
            CMS.Reporting.Web.UIReportValueSelector
            CMS.Reporting.Web.UISelectReportCategory
            CMS.TranslationServices.Web.UITranslationPriority
            CMS.TranslationServices.Web.UITranslationStatus
            CMS.UIControlsBannerCategorySelector
            CMS.UIControlsBannerTypeSelector
            CMS.UIControlsCaptchaSelector
            CMS.UIControlsDocumentStylesheetSelector
            CMS.UIControlsEmailTemplateTypeSelector
            CMS.UIControlsEventLogTypeSelector
            CMS.UIControlsGenderSelector
            CMS.UIControlsIndexSelector
            CMS.UIControlsLicenseSelector
            CMS.UIControlsSelectCulture
            CMS.UIControlsSelectHierarchicalTransformation
            CMS.UIControlsSelectPageTemplateCategory
            CMS.UIControlsSelectRoles
            CMS.UIControlsSelectSettingsCategory
            CMS.UIControlsSelectSinglePath
            CMS.UIControlsSelectSite
            CMS.UIControlsSelectSites
            CMS.UIControlsSelectSiteWithAllForAdmin
            CMS.UIControlsSelectUserName
            CMS.UIControlsSelectUsers
            CMS.UIControlsSelectWebpart
            CMS.UIControlsSelectWidgetCategory
            CMS.UIControlsSiteCultureSelectorAll
            CMS.UIControlsSiteOrGlobalSelector
            CMS.UIControlsSupportedCultureSelector
            CMS.UIControlsTimeZoneTypeSelector
            CMS.UIControlsUICultureSelector
            CMS.UIControlsUrlSelector
            CMS.UIControlsViewBadgeImage
            CMS.UIControlsViewBadgeText
            CMS.UIControlsViewDate
            CMS.UIControlsViewInteger
            CMS.UIControlsViewSecureText
            CMS.UIControlsViewUserAvatar
            CMS.UIControlsViewUserGender