Click or drag to resize
BasicForm Methods

The BasicForm type exposes the following members.

Methods
  NameDescription
Public methodAddConfirmation
Adds confirmation text to existing message on the page, optionally with a tooltip text.
Protected methodAddControlsAfterInternal
Internal method to add components after the form from inherited forms.
Protected methodAddControlsBeforeInternal
Internal method to add components before the form from inherited forms.
Public methodAddError
Adds error text to existing message on the page.
Public methodAddInformation
Adds information text to existing message on the page.
Public methodAddWarning
Adds warning text to existing message on the page.
Protected methodAfterSaveActionsInternal
Performs additional actions after save (redirecting or displaying info message).
Protected methodConnectAssociatedControls
Connects associated controls (labels and inputs) together, for accessibility and other reasons.
Protected methodCreateChildControls
Renders the control at run-time.
(Inherited from CMSDynamicWebControl.)
Protected methodCreateMessagesPlaceHolder
Creates local messages placeholder.
Public methodDisplayErrorLabel
Displays error label.
Protected methodEnsureInitialization
Initializes the control. Is called within InitComplete or
(Inherited from CMSDynamicWebControl.)
Protected methodEnsureLabels
Ensures the general labels on the form.
Public methodEnsureMessagesPlaceholder
Ensures correct set the messages placeholder.
Public methodStatic memberFormTypeEnumToString
Returns the string representation of the form type.
Public methodGetDataValue
Returns DataRow value for the specified column.
(Inherited from AbstractBasicForm.)
Public methodGetFieldValue
Gets the value of a specified field.
Public methodGetMultifieldValues
Gets the multi-field values of a specified field.
Public methodGetWhereCondition
Gets where condition from all form engine user controls.
Protected methodHandleFieldsValues
Initializes values for invisible fields.
Protected methodInitFormInternal
Internal method to initialize the form.
Protected methodInitializeControl
Initializes the form.
(Overrides CMSDynamicWebControlInitializeControl.)
Protected methodInitializeMainPanel
Initializes main form container.
Protected methodInitResolver
Initializes macro resolver data sources.
Protected methodInitSpellCheck
Initializes the spell checker.
(Inherited from AbstractBasicForm.)
Public methodIsAnyFieldVisible
Returns TRUE if basic form displays any control.
Public methodIsCategoryCollapsed
Returns true if the given category is collapsed
Public methodIsFieldAvailable
Checks if control is included in editing controls hashtable.
Public methodIsFieldVisible
Checks if the given field is evaluated as visible.
Public methodItemChanged
Checks if item has changed.
(Inherited from AbstractBasicForm.)
Protected methodlayout_OnAfterRegisterFormControl
Event after control has been registered in template layout.
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.
Public methodLoadData(IDataContainer)
Renders form and sets field values.
Protected methodLoadDefaultLayout
Loads default layout.
Protected methodLoadFormLayout
Loads form layout.
Protected methodLoadLayout
Loads the form layout.
Protected methodLoadTemplateLayout
Loads the layout template.
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
Pre-render event handler.
(Overrides ControlOnPreRender(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.
Protected methodProcessContextVisibility
Changes fields' visible attribute according to display context.
Protected methodProcessUserVisibility
Changes fields' visible attribute according to user visibility settings or changes form definition if visibility can be edited.
Protected methodProcessVisibility
Changes fields' visible attribute according to visibility.
Public methodRaiseOnAfterSave
Raises the OnAfterSave event.
Public methodRaiseOnBeforeRedirect
Raises the OnBeforeRedirect event.
Public methodRaiseOnDeleteFile
Raises the OnDeleteFile event.
Protected methodRaiseOnCheckPermissions
Invokes OnCheckPermissions event.
Public methodRaiseOnSaveFailed
Raises the OnSaveFailed event.
Public methodRaiseOnUploadFile
Raises the OnUploadFile event.
Public methodReloadData
Reloads the form data.
Protected methodRender
Renders the control at design-time.
(Overrides AbstractBasicFormRender(HtmlTextWriter).)
Public methodResolveMacros
Resolves the macros within current WebPart context.
Protected methodSaveControlValue
Saves the control value to the data.
(Inherited from AbstractBasicForm.)
Public methodSaveData
Saves data and optionally redirects user to specified URL.
Protected methodSaveDataClick
Saves form data into Data container after the submit button is clicked.
Protected methodSaveDataInternal
Internal method to save data to the database.
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.
Public methodShowError
Shows the specified error message, optionally with a tooltip text.
Public methodShowChangesSaved
Shows the general changes saved message.
Public methodShowInformation
Shows the given information on the page, optionally with a tooltip text.
Public methodShowWarning
Shows the specified warning message, optionally with a tooltip text.
Public methodStatic memberStringToFormTypeEnum
Returns the enumeration representation of the form type.
Public methodValidateData
Validates the data, returns true if succeeded.
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