Click or drag to resize
CMSForm Methods

The CMSForm type exposes the following members.

Methods
  NameDescription
Public methodAddConfirmation
Adds confirmation text to existing message on the page, optionally with a tooltip text.
(Inherited from BasicForm.)
Protected methodAddControlsAfterInternal
Allows to add additional components after the form.
(Overrides BasicFormAddControlsAfterInternal.)
Protected methodAddControlsBeforeInternal
Allows to add additional components before the form.
(Overrides BasicFormAddControlsBeforeInternal.)
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.)
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.)
Protected methodCMSForm_OnAfterDataLoad
OnAfterDataReload event handler.
Protected methodConnectAssociatedControls
Connects associated controls (labels and inputs) together, for accessibility and other reasons.
(Inherited from BasicForm.)
Protected methodCreateChildControls
Renders the control at run-time.
(Inherited from CMSDynamicWebControl.)
Protected methodCreateMessagesPlaceHolder
Creates local messages placeholder.
(Overrides BasicFormCreateMessagesPlaceHolder.)
Public methodDisplayErrorLabel
Displays error label.
(Inherited from BasicForm.)
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.)
Protected methodGetClassName
Extracts class name from the form name.
Public methodGetDataValue
Returns DataRow value for the specified column.
(Inherited from AbstractBasicForm.)
Public methodGetFieldValue
Gets the value of a specified field.
(Inherited from BasicForm.)
Public methodGetMultifieldValues
Gets the multi-field values of a specified field.
(Inherited from BasicForm.)
Public methodGetWhereCondition
Gets where condition from all form engine user controls.
(Inherited from BasicForm.)
Protected methodHandleFieldsValues
Initializes values for invisible fields.
(Inherited from BasicForm.)
Protected methodInitFormInternal
Initializes the form.
(Overrides BasicFormInitFormInternal.)
Protected methodInitializeControl
Initializes the form.
(Inherited from BasicForm.)
Protected methodInitializeMainPanel
Initializes main form container.
(Inherited from BasicForm.)
Protected methodInitResolver
Initializes macro resolver data sources.
(Overrides BasicFormInitResolver.)
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.)
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.)
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 methodOnInit
OnInit event
(Overrides CMSDynamicWebControlOnInit(EventArgs).)
Protected methodOnLoad
Load event handler.
(Inherited from CMSDynamicWebControl.)
Protected methodOnPreRender
OnPreRender event
(Overrides BasicFormOnPreRender(EventArgs).)
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.)
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 methodRender
Renders the control at design-time.
(Overrides BasicFormRender(HtmlTextWriter).)
Public methodResolveMacros
Resolves the macros within current WebPart context.
(Inherited from BasicForm.)
Public methodSave
Saves document data.
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 BasicFormSaveDataInternal.)
Protected methodSaveViewState
Customized SaveViewState.
(Inherited from CMSDynamicWebControl.)
Protected methodSetDataValue
Sets value of the given column in the data.
(Inherited from AbstractBasicForm.)
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 methodValidateData
Validates the data, returns true if succeeded.
(Inherited from BasicForm.)
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