CMSForm MembersKentico 8.0 API Reference
The CMSForm type exposes the following members.
Constructors

  NameDescription
Public methodCMSForm
Constructor.
Back to Top
Methods

  NameDescription
Protected methodOnlineAddAttributesToRender
Adds HTML attributes and styles that need to be rendered to the specified OnlineHtmlTextWriterTag. This method is used primarily by control developers.
(Inherited from OnlineWebControl.)
Public methodAddConfirmation
Adds confirmation text to existing message on the page, optionally with a tooltip text.
(Inherited from BasicForm.)
Protected methodOnlineAddedControl
Called after a child control is added to the OnlineControls collection of the OnlineControl object.
(Inherited from OnlineControl.)
Public methodAddError
Adds error text to existing message on the page.
(Inherited from BasicForm.)
Public methodAddInformation
Adds information text to existing message on the page.
(Inherited from BasicForm.)
Protected methodOnlineAddParsedSubObject
Notifies the server control that an element, either XML or HTML, was parsed, and adds the element to the server control's OnlineControlCollection object.
(Inherited from OnlineControl.)
Public methodAddWarning
Adds warning text to existing message on the page.
(Inherited from BasicForm.)
Protected methodAfterSaveActionsInternal
Performs additional actions after save (redirecting or displaying info message).
(Inherited from BasicForm.)
Public methodOnlineApplyStyle
Copies any nonblank elements of the specified style to the Web control, overwriting any existing style elements of the control. This method is primarily used by control developers.
(Inherited from OnlineWebControl.)
Public methodOnlineApplyStyleSheetSkin
Applies the style properties defined in the page style sheet to the control.
(Inherited from OnlineControl.)
Protected methodOnlineBuildProfileTree
Gathers information about the server control and delivers it to the OnlineTrace property to be displayed when tracing is enabled for the page.
(Inherited from OnlineControl.)
Protected methodOnlineClearCachedClientID
Sets the cached OnlineClientID value to null.
(Inherited from OnlineControl.)
Protected methodOnlineClearEffectiveClientIDMode
Sets the OnlineClientIDMode property of the current control instance and of any child controls to OnlineInherit.
(Inherited from OnlineControl.)
Protected methodOnlineClearChildControlState
Deletes the control-state information for the server control's child controls.
(Inherited from OnlineControl.)
Protected methodOnlineClearChildState
Deletes the view-state and control-state information for all the server control's child controls.
(Inherited from OnlineControl.)
Protected methodOnlineClearChildViewState
Deletes the view-state information for all the server control's child controls.
(Inherited from OnlineControl.)
Protected methodCMSForm_OnAfterDataLoad
OnAfterDataReload event handler.
Protected methodConnectAssociatedControls
Connects associated controls (labels and inputs) together, for accessibility and other reasons.
(Inherited from BasicForm.)
Public methodOnlineCopyBaseAttributes
Copies the properties not encapsulated by the OnlineStyle object from the specified Web server control to the Web server control that this method is called from. This method is used primarily by control developers.
(Inherited from OnlineWebControl.)
Protected methodOnlineCreateControlCollection
Creates a new OnlineControlCollection object to hold the child controls (both literal and server) of the server control.
(Inherited from OnlineControl.)
Protected methodOnlineCreateControlStyle
Creates the style object that is used internally by the OnlineWebControl class to implement all style related properties. This method is used primarily by control developers.
(Inherited from OnlineWebControl.)
Protected methodCreateChildControls
Renders the control at run-time.
(Inherited from CMSDynamicWebControl.)
Protected methodCreateMessagesPlaceHolder
Creates local messages placeholder.
(Overrides BasicForm CreateMessagesPlaceHolder .)
Public methodOnlineDataBind 
Binds a data source to the invoked server control and all its child controls.
(Inherited from OnlineControl.)
Protected methodOnlineDataBind(Boolean)
Binds a data source to the invoked server control and all its child controls with an option to raise the OnlineDataBinding event.
(Inherited from OnlineControl.)
Protected methodOnlineDataBindChildren
Binds a data source to the server control's child controls.
(Inherited from OnlineControl.)
Public methodDisplayErrorLabel
Displays error label.
(Inherited from BasicForm.)
Public methodOnlineDispose
Enables a server control to perform final clean up before it is released from memory.
(Inherited from OnlineControl.)
Protected methodOnlineEnsureChildControls
Determines whether the server control contains child controls. If it does not, it creates child controls.
(Inherited from OnlineControl.)
Protected methodOnlineEnsureID
Creates an identifier for controls that do not have an identifier assigned.
(Inherited from OnlineControl.)
Protected methodEnsureInitialization
Initializes the control. Is called within InitComplete or
(Inherited from CMSDynamicWebControl.)
Protected methodEnsureLabels
Ensures the general labels on the form.
(Inherited from BasicForm.)
Public methodEnsureMessagesPlaceholder
Ensures correct set the messages placeholder.
(Inherited from BasicForm.)
Public methodOnlineEquals
Determines whether the specified OnlineObject is equal to the current OnlineObject.
(Inherited from OnlineObject.)
Protected methodOnlineFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from OnlineObject.)
Public methodOnlineFindControl(String)
Searches the current naming container for a server control with the specified id parameter.
(Inherited from OnlineControl.)
Protected methodOnlineFindControl(String, Int32)
Searches the current naming container for a server control with the specified id and an integer, specified in the pathOffset parameter, which aids in the search. You should not override this version of the OnlineFindControl  method.
(Inherited from OnlineControl.)
Public methodOnlineFocus
Sets input focus to a control.
(Inherited from OnlineControl.)
Public methodGetAttachment
Returns attachment info and raises OnGetAttachment event.
(Inherited from BasicForm.)
Protected methodGetAttachmentInternal
Returns attachment info.
(Overrides BasicForm GetAttachmentInternal(Guid).)
Protected methodGetClassName
Extracts class name from the form name.
Public methodGetDataValue
Returns DataRow value for the specified column.
(Inherited from AbstractBasicForm.)
Protected methodOnlineGetDesignModeState
Gets design-time data for a control.
(Inherited from OnlineControl.)
Public methodGetFieldValue
Gets the value of a specified field.
(Inherited from BasicForm.)
Public methodOnlineGetHashCode
Serves as a hash function for a particular type.
(Inherited from OnlineObject.)
Public methodGetMultifieldValues
Gets the multifield values of a specified field.
(Inherited from BasicForm.)
Public methodOnlineGetRouteUrl(Object)
Gets the URL that corresponds to a set of route parameters.
(Inherited from OnlineControl.)
Public methodOnlineGetRouteUrl(RouteValueDictionary)
Gets the URL that corresponds to a set of route parameters.
(Inherited from OnlineControl.)
Public methodOnlineGetRouteUrl(String, Object)
Gets the URL that corresponds to a set of route parameters and a route name.
(Inherited from OnlineControl.)
Public methodOnlineGetRouteUrl(String, RouteValueDictionary)
Gets the URL that corresponds to a set of route parameters and a route name.
(Inherited from OnlineControl.)
Public methodOnlineGetType
Gets the OnlineType of the current instance.
(Inherited from OnlineObject.)
Public methodOnlineGetUniqueIDRelativeTo
Returns the prefixed portion of the OnlineUniqueID property of the specified control.
(Inherited from OnlineControl.)
Public methodGetWhereCondition
Gets where condition from all form engine user controls.
(Inherited from BasicForm.)
Protected methodHandleFieldsValues
Initializes default values for invisible fields.
(Inherited from BasicForm.)
Public methodOnlineHasControls
Determines if the server control contains any child controls.
(Inherited from OnlineControl.)
Protected methodOnlineHasEvents
Returns a value indicating whether events are registered for the control or any child controls.
(Inherited from OnlineControl.)
Protected methodInitFormInternal
Initializes the form.
(Overrides BasicForm InitFormInternal .)
Protected methodInitializeControl
Initializes the form.
(Inherited from BasicForm.)
Protected methodInitializeMainPanel
Initializes main form container.
(Inherited from BasicForm.)
Protected methodInitResolver
Initializes resolver data
(Inherited from BasicForm.)
Protected methodInitSpellCheck
Initializes the spell checker.
(Inherited from AbstractBasicForm.)
Public methodIsAnyFieldVisible
Returns TRUE if basic form displays any control.
(Inherited from BasicForm.)
Public methodIsCategoryCollapsed
Returns true if the given category is collapsed
(Inherited from BasicForm.)
Public methodIsFieldAvailable
Checks if control is included in editing controls hashtable.
(Inherited from BasicForm.)
Public methodIsFieldVisible
Checks if the given field is evaluated as visible.
(Inherited from BasicForm.)
Protected methodOnlineIsLiteralContent
Determines if the server control holds only literal content.
(Inherited from OnlineControl.)
Public methodItemChanged
Checks if item has changed.
(Inherited from AbstractBasicForm.)
Protected methodlayout_OnAfterRegisterFormControl
Event after control has been registered in template layout.
(Inherited from BasicForm.)
Protected methodOnlineLoadControlState
Restores control-state information from a previous page request that was saved by the OnlineSaveControlState  method.
(Inherited from OnlineControl.)
Public methodLoadControlValues
Loads the values from the data container to the form controls.
(Inherited from AbstractBasicForm.)
Public methodLoadData(DataRow)
Renders form and sets field values.
(Inherited from BasicForm.)
Public methodLoadData(IDataContainer)
Renders form and sets field values.
(Inherited from BasicForm.)
Protected methodLoadDefaultLayout
Loads default layout.
(Inherited from BasicForm.)
Public methodLoadForm
Loads the child controls at run-time.
Protected methodLoadFormLayout
Loads form layout.
(Inherited from BasicForm.)
Protected methodLoadLayout
Loads the form layout.
(Inherited from BasicForm.)
Protected methodLoadTemplateLayout
Loads the layout template.
(Inherited from BasicForm.)
Protected methodLoadViewState
Customized LoadViewState.
(Inherited from CMSDynamicWebControl.)
Protected methodOnlineMapPathSecure
Retrieves the physical path that a virtual path, either absolute or relative, maps to.
(Inherited from OnlineControl.)
Protected methodOnlineMemberwiseClone
Creates a shallow copy of the current OnlineObject.
(Inherited from OnlineObject.)
Public methodOnlineMergeStyle
Copies any nonblank elements of the specified style to the Web control, but will not overwrite any existing style elements of the control. This method is used primarily by control developers.
(Inherited from OnlineWebControl.)
Protected methodOnlineOnBubbleEvent
Determines whether the event for the server control is passed up the page's UI server control hierarchy.
(Inherited from OnlineControl.)
Protected methodOnlineOnDataBinding
Raises the OnlineDataBinding event.
(Inherited from OnlineControl.)
Protected methodOnInit
OnInit event
(Overrides CMSDynamicWebControl OnInit(EventArgs).)
Protected methodOnLoad
OnLoad event handler.
(Overrides CMSDynamicWebControl OnLoad(EventArgs).)
Protected methodOnPreRender
OnPreRender event
(Overrides BasicForm OnPreRender(EventArgs).)
Protected methodOnlineOnUnload
Raises the OnlineUnload event.
(Inherited from OnlineControl.)
Protected methodOnlineOpenFile
Gets a OnlineStream used to read a file.
(Inherited from OnlineControl.)
Protected methodPage_InitComplete
Event handler of page's init complete.
(Inherited from CMSDynamicWebControl.)
Public methodPrependError
Prepends error text to existing message on the page.
(Inherited from BasicForm.)
Protected methodProcessContextVisibility
Changes fields' visible attribute according to display context.
(Inherited from BasicForm.)
Protected methodProcessUserVisibility
Changes fields' visible attribute according to user visibility settings or changes form definition if visibility can be edited.
(Inherited from BasicForm.)
Protected methodProcessVisibility
Changes fields' visible attribute according to visibility.
(Inherited from BasicForm.)
Protected methodOnlineRaiseBubbleEvent
Assigns any sources of the event and its information to the control's parent.
(Inherited from OnlineControl.)
Public methodRaiseOnAfterSave
Raises the OnAfterSave event.
(Inherited from BasicForm.)
Public methodRaiseOnBeforeRedirect
Raises the OnBeforeRedirect event.
(Inherited from BasicForm.)
Public methodRaiseOnDeleteFile
Raises the OnDeleteFile event.
(Inherited from BasicForm.)
Protected methodRaiseOnCheckPermissions
Invokes OnCheckPermissions event.
(Inherited from BasicForm.)
Public methodRaiseOnSaveFailed
Raises the OnSaveFailed event.
(Inherited from BasicForm.)
Public methodRaiseOnUploadFile
Raises the OnUploadFile event.
(Inherited from BasicForm.)
Public methodReloadData
Reloads the form data.
(Inherited from BasicForm.)
Protected methodOnlineRemovedControl
Called after a child control is removed from the OnlineControls collection of the OnlineControl object.
(Inherited from OnlineControl.)
Protected methodRender
Renders the control at design-time.
(Overrides BasicForm Render(HtmlTextWriter).)
Public methodOnlineRenderBeginTag
Renders the HTML opening tag of the control to the specified writer. This method is used primarily by control developers.
(Inherited from OnlineWebControl.)
Protected methodOnlineRenderContents
Renders the contents of the control to the specified writer. This method is used primarily by control developers.
(Inherited from OnlineWebControl.)
Public methodOnlineRenderControl(HtmlTextWriter)
Outputs server control content to a provided OnlineHtmlTextWriter object and stores tracing information about the control if tracing is enabled.
(Inherited from OnlineControl.)
Protected methodOnlineRenderControl(HtmlTextWriter, ControlAdapter)
Outputs server control content to a provided OnlineHtmlTextWriter object using a provided OnlineControlAdapter object.
(Inherited from OnlineControl.)
Public methodOnlineRenderEndTag
Renders the HTML closing tag of the control into the specified writer. This method is used primarily by control developers.
(Inherited from OnlineWebControl.)
Protected methodOnlineRenderChildren
Outputs the content of a server control's children to a provided OnlineHtmlTextWriter object, which writes the content to be rendered on the client.
(Inherited from OnlineControl.)
Protected methodOnlineResolveAdapter
Gets the control adapter responsible for rendering the specified control.
(Inherited from OnlineControl.)
Public methodOnlineResolveClientUrl
Gets a URL that can be used by the browser.
(Inherited from OnlineControl.)
Public methodResolveMacros
Resolves the macros within current WebPart context.
(Inherited from BasicForm.)
Public methodOnlineResolveUrl
Converts a URL into one that is usable on the requesting client.
(Inherited from OnlineControl.)
Public methodSave
Saves document data.
Protected methodOnlineSaveControlState
Saves any server control state changes that have occurred since the time the page was posted back to the server.
(Inherited from OnlineControl.)
Protected methodSaveControlValue
Saves the control value to the data.
(Inherited from AbstractBasicForm.)
Public methodSaveData
Saves data and optionally redirects user to specified URL.
(Inherited from BasicForm.)
Protected methodSaveDataClick
Saves form data into Data container after the submit button is clicked.
(Inherited from BasicForm.)
Protected methodSaveDataInternal
Saves data to database. It's called after mBasicForm.SaveData().
(Overrides BasicForm SaveDataInternal .)
Protected methodSaveViewState
Customized SaveViewState.
(Inherited from CMSDynamicWebControl.)
Protected methodSetDataValue
Sets value of the given column in the data.
(Inherited from AbstractBasicForm.)
Protected methodOnlineSetDesignModeState
Sets design-time data for a control.
(Inherited from OnlineControl.)
Public methodOnlineSetRenderMethodDelegate
Assigns an event handler delegate to render the server control and its content into its parent control.
(Inherited from OnlineControl.)
Public methodShowConfirmation
Shows the general changes saved message.
(Inherited from BasicForm.)
Public methodShowError
Shows the specified error message, optionally with a tooltip text.
(Inherited from BasicForm.)
Public methodShowChangesSaved
Shows the general changes saved message.
(Inherited from BasicForm.)
Public methodShowInformation
Shows the given information on the page, optionally with a tooltip text.
(Inherited from BasicForm.)
Public methodShowWarning
Shows the specified warning message, optionally with a tooltip text.
(Inherited from BasicForm.)
Public methodOnlineToString
Returns a string that represents the current object.
(Inherited from OnlineObject.)
Protected methodOnlineTrackViewState
Causes the control to track changes to its view state so they can be stored in the object's OnlineViewState property.
(Inherited from OnlineWebControl.)
Public methodValidateData
Validates the data, returns true if succeeded.
(Inherited from BasicForm.)
Back to 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 MethodGetAPIString
Gets the string by the specified resource key
(Defined by CoreExtensions.)
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 CoreExtensions.)
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.)
Public Extension MethodToBoolean
Returns the boolean representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToDateTime
Returns the DateTime representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToDouble
Returns the double representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToGuid
Returns the Guid representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToInteger
Returns the integer representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToString
Returns the string representation of an object or default value if not.
(Defined by CoreExtensions.)
Back to Top
Fields

  NameDescription
Protected fieldcategoryListPanel
Category list panel, may be displayed above formPanel.
(Inherited from BasicForm.)
Protected fieldcategoryListPlaceholder
Placeholder for category list.
(Inherited from BasicForm.)
Protected fielddeleteFiles
List of files (controls) to delete files.
Public fieldlblErrorObsolete.
Error label.
Public fieldlblInfoObsolete.
Info label.
Protected fieldmDefaultPageTemplateID
Default page template ID.
Protected fieldmDocumentManager
Document manager.
Protected fieldmMessagesPlaceHolder
Messages placeholder
Protected fieldmOwnerID
Owner ID.
Protected fieldmShowPrivateFields
Nonpublic fields are shown if true.
(Inherited from BasicForm.)
Protected fieldmSubmitButton
Form submit button.
(Inherited from BasicForm.)
Protected fieldmSubmitImageButton
Form submit image button.
(Inherited from BasicForm.)
Protected fielduploadFiles
List of files (controls) to upload files.
Back to Top
Properties

  NameDescription
Public propertyOnlineAccessKey
Gets or sets the access key that allows you to quickly navigate to the Web server control.
(Inherited from OnlineWebControl.)
Protected propertyOnlineAdapter
Gets the browser-specific adapter for the control.
(Inherited from OnlineControl.)
Public propertyAdditionalData
Gets a dictionary that provides additional context data for form controls.
(Inherited from BasicForm.)
Public propertyAllowEditVisibility
Indicates if field visibility could be edited.
(Inherited from BasicForm.)
Public propertyAllowExternalEditing
Indicates if external editing should be allowed for the 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 propertyAlternativeFormFullName
Alternative form full name (ClassName.AlternativeFormName).
Public propertyAltFormInformation
Alternative form information.
(Inherited from BasicForm.)
Public propertyApplyVisibility
Indicates if field visibility should be applied.
(Inherited from BasicForm.)
Public propertyOnlineAppRelativeTemplateSourceDirectory
Gets or sets the application-relative virtual directory of the OnlinePage or OnlineUserControl object that contains this control.
(Inherited from OnlineControl.)
Public propertyAssociatedControls
Controls associated with FormItems.
(Inherited from BasicForm.)
Public propertyOnlineAttributes
Gets the collection of arbitrary attributes (for rendering only) that do not correspond to properties on the control.
(Inherited from OnlineWebControl.)
Public propertyAutomaticLabelWidth
Set width of all labels according to the widest label. This property is applied only if DefaultFormLayout is set to Divs.
(Inherited from BasicForm.)
Public propertyOnlineBackColor
Gets or sets the background color of the Web server control.
(Inherited from OnlineWebControl.)
Public propertyOnlineBindingContainer
Gets the control that contains this control's data binding.
(Inherited from OnlineControl.)
Public propertyOnlineBorderColor
Gets or sets the border color of the Web control.
(Inherited from OnlineWebControl.)
Public propertyOnlineBorderStyle
Gets or sets the border style of the Web server control.
(Inherited from OnlineWebControl.)
Public propertyOnlineBorderWidth
Gets or sets the border width of the Web server control.
(Inherited from OnlineWebControl.)
Protected propertyClassInfo
DataClassInfo of edited object.
(Inherited from BasicForm.)
Public propertyOnlineClientID
Gets the control ID for HTML markup that is generated by ASP.NET.
(Inherited from OnlineControl.)
Public propertyOnlineClientIDMode
Gets or sets the algorithm that is used to generate the value of the OnlineClientID property.
(Inherited from OnlineControl.)
Protected propertyOnlineClientIDSeparator
Gets a character value representing the separator character used in the OnlineClientID property.
(Inherited from OnlineControl.)
Public propertyCollapseCategoryImageUrl
Image URL for collapsing a category.
(Inherited from BasicForm.)
Public propertyComponentName
Component name.
Protected propertyOnlineContext
Gets the OnlineHttpContext object associated with the server control for the current Web request.
(Inherited from OnlineControl.)
Public propertyContextResolver
Form context resolver.
(Inherited from BasicForm.)
Public propertyControlContext
Gets the current control context.
(Inherited from AbstractBasicForm.)
Public propertyOnlineControls
Gets a OnlineControlCollection object that represents the child controls for a specified server control in the UI hierarchy.
(Inherited from OnlineControl.)
Public propertyOnlineControlStyle
Gets the style of the Web server control. This property is used primarily by control developers.
(Inherited from OnlineWebControl.)
Public propertyOnlineControlStyleCreated
Gets a value indicating whether a OnlineStyle object has been created for the OnlineControlStyle property. This property is primarily used by control developers.
(Inherited from OnlineWebControl.)
Public propertyCopyDefaultDataFromDocumentId
Optional DocumentId of the document that should be used as a template with default values.
Public propertyOnlineCssClass
Gets or sets the Cascading Style Sheet (CSS) class rendered by the Web server control on the client.
(Inherited from OnlineWebControl.)
Public propertyCultureCode
Culture code.
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 propertyOnlineDataItemContainer
Gets a reference to the naming container if the naming container implements OnlineIDataItemContainer.
(Inherited from OnlineControl.)
Public propertyOnlineDataKeysContainer
Gets a reference to the naming container if the naming container implements OnlineIDataKeysControl.
(Inherited from OnlineControl.)
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.)
Public propertyDefaultPageTemplateID
Default page template ID.
Public propertyDefaultValidationErrorMessage
Default validation error message.
Protected propertyOnlineDesignMode
Gets a value indicating whether a control is being used on a design surface.
(Inherited from OnlineControl.)
Public propertyDialogParameters
Additional parameters for the dialog windows.
(Inherited from BasicForm.)
Public propertyDisplayContext
Gets or sets the current display context which is used if control contains DisplayIn value.
(Inherited from BasicForm.)
Public propertyDocumentID
Specifies together with CultureCode edited node.
Public propertyDocumentManager
Document manager control
Public propertyEditedObject
Edited object. TreeNode in CMSForm, IDataClass in BizForm and CustomTableForm, AbstractInfo or DataClassInfo in DataForm.
(Inherited from BasicForm.)
Public propertyEnabled
Indicates if the form control is enabled.
(Inherited from BasicForm.)
Public propertyOnlineEnableTheming
Gets or sets a value indicating whether themes apply to this control.
(Inherited from OnlineWebControl.)
Public propertyOnlineEnableViewState
Gets or sets a value indicating whether the server control persists its view state, and the view state of any child controls it contains, to the requesting client.
(Inherited from OnlineControl.)
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.
(Overrides BasicForm ErrorLabel.)
Protected propertyOnlineEvents
Gets a list of event handler delegates for the control. This property is read-only.
(Inherited from OnlineControl.)
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 propertyFieldActionsControls
Contains FieldActions controls if the form is in design mode (BasicForm.IsDesignMode property).
(Inherited from AbstractBasicForm.)
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 propertyFieldVisibilityCellCssClass
CSS class for the individual field visibility cell.
(Inherited from BasicForm.)
Public propertyFieldVisibilityControls
Visibility controls hashtable.
(Inherited from AbstractBasicForm.)
Public propertyFieldVisibilityCssClass
CSS class for the individual field visibility control.
(Inherited from BasicForm.)
Public propertyFirstField
First field element.
(Inherited from BasicForm.)
Public propertyOnlineFont
Gets the font properties associated with the Web server control.
(Inherited from OnlineWebControl.)
Public propertyForceReloadCategories
Forces categories to get to default collapsed state.
(Inherited from BasicForm.)
Public propertyOnlineForeColor
Gets or sets the foreground color (typically the color of the text) of the Web server control.
(Inherited from OnlineWebControl.)
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.
(Inherited from BasicForm.)
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 propertyFormMode
Form mode - insert or update.
Public propertyFormName
Form name in form application.class.form.
Public propertyFormPanel
Returns form outer panel.
(Inherited from BasicForm.)
Public propertyFormPrefix
Form name prefix. If set, form with name in format [FormPrefix][form name] is searched instead of [form name].
Public propertyFormType
Indicates in what control is this basic form used.
(Inherited from BasicForm.)
Public propertyGroupCssClass
CSS class for the whole field group with heading.
(Inherited from BasicForm.)
Public propertyGroupID
Group ID.
Public propertyOnlineHasAttributes
Gets a value indicating whether the control has attributes set.
(Inherited from OnlineWebControl.)
Protected propertyOnlineHasChildViewState
Gets a value indicating whether the current server control's child controls have any saved view-state settings.
(Inherited from OnlineControl.)
Public propertyOnlineHeight
Gets or sets the height of the Web server control.
(Inherited from OnlineWebControl.)
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 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 propertyOnlineChildControlsCreated
Gets a value that indicates whether the server control's child controls have been created.
(Inherited from OnlineControl.)
Public propertyOnlineID
Gets or sets the programmatic identifier assigned to the server control.
(Inherited from OnlineControl.)
Protected propertyOnlineIdSeparator
Gets the character used to separate control identifiers.
(Inherited from OnlineControl.)
Public propertyInfoLabel
Information label.
(Overrides BasicForm InfoLabel.)
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 propertyIsDesignMode
Determines whether the form is in design mode.
(Inherited from BasicForm.)
Protected propertyOnlineIsEnabled
Gets a value indicating whether the control is enabled.
(Inherited from OnlineWebControl.)
Public propertyIsFirstLoad
Indicates if inner controls are loaded for the first time (the form may be initialized on a postback).
(Inherited from BasicForm.)
Protected propertyOnlineIsChildControlStateCleared
Gets a value indicating whether controls contained within this control have control state.
(Inherited from OnlineControl.)
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
Sets simple/advanced mode of basicform.
(Inherited from BasicForm.)
Protected propertyOnlineIsTrackingViewState
Gets a value that indicates whether the server control is saving changes to its view state.
(Inherited from OnlineControl.)
Protected propertyOnlineIsViewStateEnabled
Gets a value indicating whether view state is enabled for this control.
(Inherited from OnlineControl.)
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.)
Protected propertyOnlineLoadViewStateByID
Gets a value indicating whether the control participates in loading its view state by OnlineID instead of index.
(Inherited from OnlineControl.)
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 BasicForm MessagesPlaceHolder.)
Public propertyMode
Gets or sets the mode of the form.
(Inherited from AbstractBasicForm.)
Public propertyOnlineNamingContainer
Gets a reference to the server control's naming container, which creates a unique namespace for differentiating between server controls with the same OnlineID property value.
(Inherited from OnlineControl.)
Public propertyNode
Document node.
Public propertyNodeIdObsolete.
Specifies together with CultureCode edited node.
Public propertyNodeID
Specifies together with CultureCode edited node.
Public propertyOwnerID
Owner ID.
Public propertyOnlinePage
Gets a reference to the OnlinePage instance that contains the server control.
(Inherited from OnlineControl.)
Public propertyOnlineParent
Gets a reference to the server control's parent control in the page control hierarchy.
(Inherited from OnlineControl.)
Public propertyParentNodeID
Parent node ID. Indicates parent node for document insertion.
Public propertyParentObject
Parent object. Setup in CMSFrom in insert mode, contains TreeNode.
(Inherited from BasicForm.)
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 propertyRedirectUrlAfterSave
URL to which the form redirects after successful save.
(Inherited from BasicForm.)
Public propertyOnlineRenderingCompatibility
Gets a value that specifies the ASP.NET version that rendered HTML will be compatible with.
(Inherited from OnlineControl.)
Public propertyResolverName
Gets or sets macro resolver name.
(Inherited from BasicForm.)
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 propertyShowOkButton
Indicates if button OK should be displayed.
Public propertyShowPrivateFields
Indicates whether to show private fields or not.
(Inherited from BasicForm.)
Public propertyShowValidationErrorMessage
Indicates if error message should be displayed after validation failed.
(Inherited from BasicForm.)
Public propertyOnlineSite
Gets information about the container that hosts the current control when rendered on a design surface.
(Inherited from OnlineControl.)
Public propertySiteName
Current SiteName.
(Inherited from BasicForm.)
Public propertyOnlineSkinID
Gets or sets the skin to apply to the control.
(Inherited from OnlineWebControl.)
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 propertyOnlineStyle
Gets a collection of text attributes that will be rendered as a style attribute on the outer tag of the Web server control.
(Inherited from OnlineWebControl.)
Public propertySubmitButton
Form submit button.
(Inherited from BasicForm.)
Public propertySubmitImageButton
Form submit image button.
(Inherited from BasicForm.)
Public propertyOnlineSupportsDisabledAttribute
Gets a value that indicates whether the control should set the disabled attribute of the rendered HTML element to "disabled" when the control's OnlineIsEnabled property is false.
(Inherited from OnlineWebControl.)
Public propertyOnlineTabIndex
Gets or sets the tab index of the Web server control.
(Inherited from OnlineWebControl.)
Protected propertyTagKey
Overrides the generation of the SPAN tag with custom tag.
(Inherited from BasicForm.)
Protected propertyOnlineTagName
Gets the name of the control tag. This property is used primarily by control developers.
(Inherited from OnlineWebControl.)
Public propertyOnlineTemplateControl
Gets or sets a reference to the template that contains this control.
(Inherited from OnlineControl.)
Public propertyOnlineTemplateSourceDirectory
Gets the virtual directory of the OnlinePage or OnlineUserControl that contains the current server control.
(Inherited from OnlineControl.)
Public propertyTimeZoneType
Gets or sets time zone type for child controls. Default value is TimeZoneTypeEnum.Inherit.
(Inherited from AbstractBasicForm.)
Public propertyOnlineToolTip
Gets or sets the text displayed when the mouse pointer hovers over the Web server control.
(Inherited from OnlineWebControl.)
Public propertyTreeProvider
Tree provider instance. If it's not provided, it's created automatically.
Public propertyUIContext
Returns control's UI context
(Inherited from CMSWebControl.)
Public propertyOnlineUniqueID
Gets the unique, hierarchically qualified identifier for the server control.
(Inherited from OnlineControl.)
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.)
Protected propertyOnlineViewState
Gets a dictionary of state information that allows you to save and restore the view state of a server control across multiple requests for the same page.
(Inherited from OnlineControl.)
Protected propertyOnlineViewStateIgnoresCase
Gets a value that indicates whether the OnlineStateBag object is case-insensitive.
(Inherited from OnlineControl.)
Public propertyOnlineViewStateMode
Gets or sets the view-state mode of this control.
(Inherited from OnlineControl.)
Public propertyVisibilityFormName
This name is used if ApplyVisibility is 'true' to get visibility definition of current user.
(Inherited from BasicForm.)
Public propertyOnlineVisible
Gets or sets a value that indicates whether a server control is rendered as UI on the page.
(Inherited from OnlineControl.)
Public propertyOnlineWidth
Gets or sets the width of the Web server control.
(Inherited from OnlineWebControl.)
Back to Top
Events

  NameDescription
Public eventOnlineDataBinding
Occurs when the server control binds to a data source.
(Inherited from OnlineControl.)
Public eventOnlineDisposed
Occurs when a server control is released from memory, which is the last stage of the server control lifecycle when an ASP.NET page is requested.
(Inherited from OnlineControl.)
Public eventOnlineInit
Occurs when the server control is initialized, which is the first step in its lifecycle.
(Inherited from OnlineControl.)
Public eventOnlineLoad
Occurs when the server control is loaded into the OnlinePage object.
(Inherited from OnlineControl.)
Public eventOnAfterDataLoad
After data load event.
(Inherited from BasicForm.)
Public eventOnAfterSave
After form data save event. It is called during saving process when the form content is successfully saved.
(Inherited from BasicForm.)
Public eventOnAfterValidate
After validation event.
(Inherited from BasicForm.)
Public eventOnBeforeDataLoad
Before data load event.
(Inherited from BasicForm.)
Public eventOnBeforeDataRetrieval
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 eventOnBeforeRedirect
Before redirect event (after successful save).
(Inherited from BasicForm.)
Public eventOnBeforeSave
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 eventOnBeforeValidate
Before validation event.
(Inherited from BasicForm.)
Public eventOnDeleteFile
Occurs when the file is deleted.
(Inherited from BasicForm.)
Public eventOnGetAttachment
Occurs when an attachment is retrieved.
(Inherited from BasicForm.)
Public eventOnGetControlValue
Occurs when a value is being extracted from a form control.
(Inherited from AbstractBasicForm.)
Public eventOnCheckPermissions
Occurs when permission can be checked. It is called at the beginning of the saving process.
(Inherited from BasicForm.)
Public eventOnItemValidation
Occurs when a field is validated.
(Inherited from BasicForm.)
Public eventOnSaveFailed
Occurs when saving data to the database fails.
(Inherited from BasicForm.)
Public eventOnUploadFile
Occurs when the file is uploaded.
(Inherited from BasicForm.)
Public eventOnValidationFailed
Occurs when validation of the form fails.
(Inherited from BasicForm.)
Public eventOnlinePreRender
Occurs after the OnlineControl object is loaded but prior to rendering.
(Inherited from OnlineControl.)
Public eventOnlineUnload
Occurs when the server control is unloaded from memory.
(Inherited from OnlineControl.)
Back to Top
See Also