| BasicForm Methods |
The BasicForm type exposes the following members.
Methods| Name | Description | |
|---|---|---|
 | AddConfirmation |
Adds confirmation text to existing message on the page, optionally with a tooltip text.
|
 | AddControlsAfterInternal |
Internal method to add components after the form from inherited forms.
|
| AddControlsBeforeInternal |
Internal method to add components before the form from inherited forms.
|
| AddError |
Adds error text to existing message on the page.
|
| AddInformation |
Adds information text to existing message on the page.
|
| AddWarning |
Adds warning text to existing message on the page.
|
| AfterSaveActionsInternal |
Performs additional actions after save (redirecting or displaying info message).
|
| ConnectAssociatedControls |
Connects associated controls (labels and inputs) together, for accessibility and other reasons.
|
| CreateChildControls |
Renders the control at run-time.
(Inherited from CMSDynamicWebControl.) |
| CreateMessagesPlaceHolder |
Creates local messages placeholder.
|
| DisplayErrorLabel |
Displays error label.
|
| EnsureInitialization |
Initializes the control. Is called within InitComplete or
(Inherited from CMSDynamicWebControl.) |
| EnsureLabels |
Ensures the general labels on the form.
|
| EnsureMessagesPlaceholder |
Ensures correct set the messages placeholder.
|
 | FormTypeEnumToString |
Returns the string representation of the form type.
|
| GetAttachment |
Returns attachment info and raises OnGetAttachment event.
|
| GetAttachmentInternal |
Gets attachment
|
| GetDataValue |
Returns DataRow value for the specified column.
(Inherited from AbstractBasicForm.) |
| GetFieldValue |
Gets the value of a specified field.
|
| GetMultifieldValues |
Gets the multi-field values of a specified field.
|
| GetWhereCondition |
Gets where condition from all form engine user controls.
|
| HandleFieldsValues |
Initializes default values for invisible fields.
|
| InitFormInternal |
Internal method to initialize the form.
|
| InitializeControl |
Initializes the form.
(Overrides CMSDynamicWebControlInitializeControl.) |
| InitializeMainPanel |
Initializes main form container.
|
| InitResolver |
Initializes macro resolver data sources.
|
| InitSpellCheck |
Initializes the spell checker.
(Inherited from AbstractBasicForm.) |
| IsAnyFieldVisible |
Returns TRUE if basic form displays any control.
|
| IsCategoryCollapsed |
Returns true if the given category is collapsed
|
| IsFieldAvailable |
Checks if control is included in editing controls hashtable.
|
| IsFieldVisible |
Checks if the given field is evaluated as visible.
|
| ItemChanged |
Checks if item has changed.
(Inherited from AbstractBasicForm.) |
| layout_OnAfterRegisterFormControl |
Event after control has been registered in template layout.
|
| LoadControlValues |
Loads the values from the data container to the form controls.
(Inherited from AbstractBasicForm.) |
| LoadData(DataRow) |
Renders form and sets field values.
|
| LoadData(IDataContainer) |
Renders form and sets field values.
|
| LoadDefaultLayout |
Loads default layout.
|
| LoadFormLayout |
Loads form layout.
|
| LoadLayout |
Loads the form layout.
|
| LoadTemplateLayout |
Loads the layout template.
|
| LoadViewState |
Customized LoadViewState.
(Inherited from CMSDynamicWebControl.) |
| OnInit |
Init event handler.
(Inherited from CMSDynamicWebControl.) |
| OnLoad |
Load event handler.
(Inherited from CMSDynamicWebControl.) |
| OnPreRender |
Pre-render event handler.
(Overrides ControlOnPreRender(EventArgs).) |
| Page_InitComplete |
Event handler of page's init complete.
(Inherited from CMSDynamicWebControl.) |
| PrependError |
Prepends error text to existing message on the page.
|
| ProcessContextVisibility |
Changes fields' visible attribute according to display context.
|
| ProcessUserVisibility |
Changes fields' visible attribute according to user visibility settings or changes form definition if visibility can be edited.
|
| ProcessVisibility |
Changes fields' visible attribute according to visibility.
|
| RaiseOnAfterSave |
Raises the OnAfterSave event.
|
| RaiseOnBeforeRedirect |
Raises the OnBeforeRedirect event.
|
| RaiseOnDeleteFile |
Raises the OnDeleteFile event.
|
| RaiseOnCheckPermissions |
Invokes OnCheckPermissions event.
|
| RaiseOnSaveFailed |
Raises the OnSaveFailed event.
|
| RaiseOnUploadFile |
Raises the OnUploadFile event.
|
| ReloadData |
Reloads the form data.
|
| Render |
Renders the control at design-time.
(Overrides AbstractBasicFormRender(HtmlTextWriter).) |
| ResolveMacros |
Resolves the macros within current WebPart context.
|
| SaveControlValue |
Saves the control value to the data.
(Inherited from AbstractBasicForm.) |
| SaveData |
Saves data and optionally redirects user to specified URL.
|
| SaveDataClick |
Saves form data into Data container after the submit button is clicked.
|
| SaveDataInternal |
Internal method to save data to the database.
|
| SaveViewState |
Customized SaveViewState.
(Inherited from CMSDynamicWebControl.) |
| SetDataValue |
Sets value of the given column in the data.
(Inherited from AbstractBasicForm.) |
| ShowConfirmation |
Shows the general changes saved message.
|
| ShowError |
Shows the specified error message, optionally with a tooltip text.
|
| ShowChangesSaved |
Shows the general changes saved message.
|
| ShowInformation |
Shows the given information on the page, optionally with a tooltip text.
|
| ShowWarning |
Shows the specified warning message, optionally with a tooltip text.
|
| StringToFormTypeEnum |
Returns the enumeration representation of the form type.
|
| ValidateData |
Validates the data, returns true if succeeded.
|
Extension Methods| Name | Description | |
|---|---|---|
 | AddCssClass |
Adds CSS class to control. If class is already present, than adding is skipped. Class names are case sensitive.
(Defined by ControlsExtensions.) |
| AsValue |
Converts object to a query value which can be used as a query parameter
(Defined by QueryExtensions.) |
| 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.) |
| GetAPIString |
Gets the string by the specified resource key
(Defined by CoreExtensions.) |
| GetCssClasses |
Returns all CSS classes of control.
(Defined by ControlsExtensions.) |
| GetRenderedHTML |
Returns HTML which would be rendered by control to page.
(Defined by ControlsExtensions.) |
| GetString |
Gets the string by the specified resource key
(Defined by CoreExtensions.) |
| HasCssClass |
Checks whether the control has given CSS class. Class names are case sensitive.
(Defined by ControlsExtensions.) |
| RemoveCssClass |
Removes all occurrences. Class names are case sensitive.
(Defined by ControlsExtensions.) |
| SetCssClasses |
Sets CSS classes to the control. Current classes will be overridden.
(Defined by ControlsExtensions.) |
| ToBoolean |
Returns the boolean representation of an object or default value if not.
(Defined by CoreExtensions.) |
| ToDateTime |
Returns the DateTime representation of an object or default value if not.
(Defined by CoreExtensions.) |
| ToDouble |
Returns the double representation of an object or default value if not.
(Defined by CoreExtensions.) |
| ToGuid |
Returns the Guid representation of an object or default value if not.
(Defined by CoreExtensions.) |
| ToInteger |
Returns the integer representation of an object or default value if not.
(Defined by CoreExtensions.) |
| ToString |
Returns the string representation of an object or default value if not.
(Defined by CoreExtensions.) |
See Also