The CMSForm type exposes the following members.
Back to Top
Back to Top
Back to Top
Back to Top
Back to Top
Back to Top
Constructors
Name | Description | |
---|---|---|
CMSForm |
Constructor.
|
Methods
Name | Description | |
---|---|---|
AddAttributesToRender | Adds HTML attributes and styles that need to be rendered to the specified HtmlTextWriterTag. This method is used primarily by control developers. (Inherited from WebControl.) | |
AddConfirmation |
Adds confirmation text to existing message on the page, optionally with a tooltip text.
(Inherited from BasicForm.) | |
AddedControl | (Inherited from Control.) | |
AddError |
Adds error text to existing message on the page.
(Inherited from BasicForm.) | |
AddInformation |
Adds information text to existing message on the page.
(Inherited from BasicForm.) | |
AddParsedSubObject | Notifies the server control that an element, either XML or HTML, was parsed, and adds the element to the server control's ControlCollection object. (Inherited from Control.) | |
AddWarning |
Adds warning text to existing message on the page.
(Inherited from BasicForm.) | |
AfterSaveActionsInternal |
Performs additional actions after save (redirecting or displaying info message).
(Inherited from BasicForm.) | |
ApplyStyle | 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 WebControl.) | |
ApplyStyleSheetSkin | Applies the style properties defined in the page style sheet to the control. (Inherited from Control.) | |
BuildProfileTree | Gathers information about the server control and delivers it to the Trace property to be displayed when tracing is enabled for the page. (Inherited from Control.) | |
ClearCachedClientID | Sets the cached ClientID value to null. (Inherited from Control.) | |
ClearEffectiveClientIDMode | Sets the ClientIDMode property of the current control instance and of any child controls to Inherit. (Inherited from Control.) | |
ClearChildControlState | Deletes the control-state information for the server control's child controls. (Inherited from Control.) | |
ClearChildState | Deletes the view-state and control-state information for all the server control's child controls. (Inherited from Control.) | |
ClearChildViewState | Deletes the view-state information for all the server control's child controls. (Inherited from Control.) | |
CMSForm_OnAfterDataLoad |
OnAfterDataReload event handler.
| |
ConnectAssociatedControls |
Connects associated controls (labels and inputs) together, for accessibility and other reasons.
(Inherited from BasicForm.) | |
CopyBaseAttributes | Copies the properties not encapsulated by the Style 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 WebControl.) | |
CreateControlCollection | Creates a new ControlCollection object to hold the child controls (both literal and server) of the server control. (Inherited from Control.) | |
CreateControlStyle | Creates the style object that is used internally by the WebControl class to implement all style related properties. This method is used primarily by control developers. (Inherited from WebControl.) | |
CreateChildControls |
Renders the control at run-time.
(Inherited from CMSDynamicWebControl.) | |
CreateMessagesPlaceHolder |
Creates local messages placeholder.
(Overrides BasicForm CreateMessagesPlaceHolder .) | |
DataBind | Binds a data source to the invoked server control and all its child controls. (Inherited from Control.) | |
DataBind(Boolean) | Binds a data source to the invoked server control and all its child controls with an option to raise the DataBinding event. (Inherited from Control.) | |
DataBindChildren | Binds a data source to the server control's child controls. (Inherited from Control.) | |
DisplayErrorLabel |
Displays error label.
(Inherited from BasicForm.) | |
Dispose | Enables a server control to perform final clean up before it is released from memory. (Inherited from Control.) | |
EnsureChildControls | Determines whether the server control contains child controls. If it does not, it creates child controls. (Inherited from Control.) | |
EnsureID | Creates an identifier for controls that do not have an identifier assigned. (Inherited from Control.) | |
EnsureInitialization |
Initializes the control. Is called within InitComplete or
(Inherited from CMSDynamicWebControl.) | |
EnsureLabels |
Ensures the general labels on the form.
(Inherited from BasicForm.) | |
EnsureMessagesPlaceholder |
Ensures correct set the messages placeholder.
(Inherited from BasicForm.) | |
Equals | (Inherited from Object.) | |
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) | |
FindControl(String) | Searches the current naming container for a server control with the specified id parameter. (Inherited from Control.) | |
FindControl(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 FindControl method. (Inherited from Control.) | |
Focus | Sets input focus to a control. (Inherited from Control.) | |
GetAttachment |
Returns attachment info and raises OnGetAttachment event.
(Inherited from BasicForm.) | |
GetAttachmentInternal |
Returns attachment info.
(Overrides BasicForm GetAttachmentInternal(Guid).) | |
GetClassName |
Extracts class name from the form name.
| |
GetDataValue |
Returns DataRow value for the specified column.
(Inherited from AbstractBasicForm.) | |
GetDesignModeState | Gets design-time data for a control. (Inherited from Control.) | |
GetFieldValue |
Gets the value of a specified field.
(Inherited from BasicForm.) | |
GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) | |
GetMultifieldValues |
Gets the multifield values of a specified field.
(Inherited from BasicForm.) | |
GetRouteUrl(Object) | Gets the URL that corresponds to a set of route parameters. (Inherited from Control.) | |
GetRouteUrl(RouteValueDictionary) | Gets the URL that corresponds to a set of route parameters. (Inherited from Control.) | |
GetRouteUrl(String, Object) | Gets the URL that corresponds to a set of route parameters and a route name. (Inherited from Control.) | |
GetRouteUrl(String, RouteValueDictionary) | Gets the URL that corresponds to a set of route parameters and a route name. (Inherited from Control.) | |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
GetUniqueIDRelativeTo | Returns the prefixed portion of the UniqueID property of the specified control. (Inherited from Control.) | |
GetWhereCondition |
Gets where condition from all form engine user controls.
(Inherited from BasicForm.) | |
HandleFieldsValues |
Initializes default values for invisible fields.
(Inherited from BasicForm.) | |
HasControls | Determines if the server control contains any child controls. (Inherited from Control.) | |
HasEvents | Returns a value indicating whether events are registered for the control or any child controls. (Inherited from Control.) | |
InitFormInternal |
Initializes the form.
(Overrides BasicForm InitFormInternal .) | |
InitializeControl |
Initializes the form.
(Inherited from BasicForm.) | |
InitializeMainPanel |
Initializes main form container.
(Inherited from BasicForm.) | |
InitResolver |
Initializes resolver data
(Inherited from BasicForm.) | |
InitSpellCheck |
Initializes the spell checker.
(Inherited from AbstractBasicForm.) | |
IsAnyFieldVisible |
Returns TRUE if basic form displays any control.
(Inherited from BasicForm.) | |
IsCategoryCollapsed |
Returns true if the given category is collapsed
(Inherited from BasicForm.) | |
IsFieldAvailable |
Checks if control is included in editing controls hashtable.
(Inherited from BasicForm.) | |
IsFieldVisible |
Checks if the given field is evaluated as visible.
(Inherited from BasicForm.) | |
IsLiteralContent | Determines if the server control holds only literal content. (Inherited from Control.) | |
ItemChanged |
Checks if item has changed.
(Inherited from AbstractBasicForm.) | |
layout_OnAfterRegisterFormControl |
Event after control has been registered in template layout.
(Inherited from BasicForm.) | |
LoadControlState | Restores control-state information from a previous page request that was saved by the SaveControlState method. (Inherited from Control.) | |
LoadControlValues |
Loads the values from the data container to the form controls.
(Inherited from AbstractBasicForm.) | |
LoadData(DataRow) |
Renders form and sets field values.
(Inherited from BasicForm.) | |
LoadData(IDataContainer) |
Renders form and sets field values.
(Inherited from BasicForm.) | |
LoadDefaultLayout |
Loads default layout.
(Inherited from BasicForm.) | |
LoadForm |
Loads the child controls at run-time.
| |
LoadFormLayout |
Loads form layout.
(Inherited from BasicForm.) | |
LoadLayout |
Loads the form layout.
(Inherited from BasicForm.) | |
LoadTemplateLayout |
Loads the layout template.
(Inherited from BasicForm.) | |
LoadViewState |
Customized LoadViewState.
(Inherited from CMSDynamicWebControl.) | |
MapPathSecure | Retrieves the physical path that a virtual path, either absolute or relative, maps to. (Inherited from Control.) | |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
MergeStyle | 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 WebControl.) | |
OnBubbleEvent | Determines whether the event for the server control is passed up the page's UI server control hierarchy. (Inherited from Control.) | |
OnDataBinding | Raises the DataBinding event. (Inherited from Control.) | |
OnInit |
OnInit event
(Overrides CMSDynamicWebControl OnInit(EventArgs).) | |
OnLoad |
OnLoad event handler.
(Overrides CMSDynamicWebControl OnLoad(EventArgs).) | |
OnPreRender |
OnPreRender event
(Overrides BasicForm OnPreRender(EventArgs).) | |
OnUnload | Raises the Unload event. (Inherited from Control.) | |
OpenFile | Gets a Stream used to read a file. (Inherited from Control.) | |
Page_InitComplete |
Event handler of page's init complete.
(Inherited from CMSDynamicWebControl.) | |
PrependError |
Prepends error text to existing message on the page.
(Inherited from BasicForm.) | |
ProcessContextVisibility |
Changes fields' visible attribute according to display context.
(Inherited from BasicForm.) | |
ProcessUserVisibility |
Changes fields' visible attribute according to user visibility settings or changes form definition if visibility can be edited.
(Inherited from BasicForm.) | |
ProcessVisibility |
Changes fields' visible attribute according to visibility.
(Inherited from BasicForm.) | |
RaiseBubbleEvent | Assigns any sources of the event and its information to the control's parent. (Inherited from Control.) | |
RaiseOnAfterSave |
Raises the OnAfterSave event.
(Inherited from BasicForm.) | |
RaiseOnBeforeRedirect |
Raises the OnBeforeRedirect event.
(Inherited from BasicForm.) | |
RaiseOnDeleteFile |
Raises the OnDeleteFile event.
(Inherited from BasicForm.) | |
RaiseOnCheckPermissions |
Invokes OnCheckPermissions event.
(Inherited from BasicForm.) | |
RaiseOnSaveFailed |
Raises the OnSaveFailed event.
(Inherited from BasicForm.) | |
RaiseOnUploadFile |
Raises the OnUploadFile event.
(Inherited from BasicForm.) | |
ReloadData |
Reloads the form data.
(Inherited from BasicForm.) | |
RemovedControl | (Inherited from Control.) | |
Render |
Renders the control at design-time.
(Overrides BasicForm Render(HtmlTextWriter).) | |
RenderBeginTag | Renders the HTML opening tag of the control to the specified writer. This method is used primarily by control developers. (Inherited from WebControl.) | |
RenderContents | Renders the contents of the control to the specified writer. This method is used primarily by control developers. (Inherited from WebControl.) | |
RenderControl(HtmlTextWriter) | Outputs server control content to a provided HtmlTextWriter object and stores tracing information about the control if tracing is enabled. (Inherited from Control.) | |
RenderControl(HtmlTextWriter, ControlAdapter) | Outputs server control content to a provided HtmlTextWriter object using a provided ControlAdapter object. (Inherited from Control.) | |
RenderEndTag | Renders the HTML closing tag of the control into the specified writer. This method is used primarily by control developers. (Inherited from WebControl.) | |
RenderChildren | Outputs the content of a server control's children to a provided HtmlTextWriter object, which writes the content to be rendered on the client. (Inherited from Control.) | |
ResolveAdapter | Gets the control adapter responsible for rendering the specified control. (Inherited from Control.) | |
ResolveClientUrl | Gets a URL that can be used by the browser. (Inherited from Control.) | |
ResolveMacros |
Resolves the macros within current WebPart context.
(Inherited from BasicForm.) | |
ResolveUrl | Converts a URL into one that is usable on the requesting client. (Inherited from Control.) | |
Save |
Saves document data.
| |
SaveControlState | Saves any server control state changes that have occurred since the time the page was posted back to the server. (Inherited from Control.) | |
SaveControlValue |
Saves the control value to the data.
(Inherited from AbstractBasicForm.) | |
SaveData |
Saves data and optionally redirects user to specified URL.
(Inherited from BasicForm.) | |
SaveDataClick |
Saves form data into Data container after the submit button is clicked.
(Inherited from BasicForm.) | |
SaveDataInternal |
Saves data to database. It's called after mBasicForm.SaveData().
(Overrides BasicForm SaveDataInternal .) | |
SaveViewState |
Customized SaveViewState.
(Inherited from CMSDynamicWebControl.) | |
SetDataValue |
Sets value of the given column in the data.
(Inherited from AbstractBasicForm.) | |
SetDesignModeState | Sets design-time data for a control. (Inherited from Control.) | |
SetRenderMethodDelegate | Assigns an event handler delegate to render the server control and its content into its parent control. (Inherited from Control.) | |
ShowConfirmation |
Shows the general changes saved message.
(Inherited from BasicForm.) | |
ShowError |
Shows the specified error message, optionally with a tooltip text.
(Inherited from BasicForm.) | |
ShowChangesSaved |
Shows the general changes saved message.
(Inherited from BasicForm.) | |
ShowInformation |
Shows the given information on the page, optionally with a tooltip text.
(Inherited from BasicForm.) | |
ShowWarning |
Shows the specified warning message, optionally with a tooltip text.
(Inherited from BasicForm.) | |
ToString | Returns a string that represents the current object. (Inherited from Object.) | |
TrackViewState | Causes the control to track changes to its view state so they can be stored in the object's ViewState property. (Inherited from WebControl.) | |
ValidateData |
Validates the data, returns true if succeeded.
(Inherited from BasicForm.) |
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.) | |
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.) |
Fields
Name | Description | |
---|---|---|
categoryListPanel |
Category list panel, may be displayed above formPanel.
(Inherited from BasicForm.) | |
categoryListPlaceholder |
Placeholder for category list.
(Inherited from BasicForm.) | |
deleteFiles |
List of files (controls) to delete files.
| |
lblError | Obsolete.
Error label.
| |
lblInfo | Obsolete.
Info label.
| |
mDefaultPageTemplateID |
Default page template ID.
| |
mDocumentManager |
Document manager.
| |
mMessagesPlaceHolder |
Messages placeholder
| |
mOwnerID |
Owner ID.
| |
mShowPrivateFields |
Nonpublic fields are shown if true.
(Inherited from BasicForm.) | |
mSubmitButton |
Form submit button.
(Inherited from BasicForm.) | |
mSubmitImageButton |
Form submit image button.
(Inherited from BasicForm.) | |
uploadFiles |
List of files (controls) to upload files.
|
Properties
Name | Description | |
---|---|---|
AccessKey | Gets or sets the access key that allows you to quickly navigate to the Web server control. (Inherited from WebControl.) | |
Adapter | Gets the browser-specific adapter for the control. (Inherited from Control.) | |
AdditionalData |
Gets a dictionary that provides additional context data for form controls.
(Inherited from BasicForm.) | |
AllowEditVisibility |
Indicates if field visibility could be edited.
(Inherited from BasicForm.) | |
AllowExternalEditing |
Indicates if external editing should be allowed for the controls.
(Inherited from BasicForm.) | |
AllowMacroEditing |
Determines whether to display the "Edit value" button in EditingFormControls.
(Inherited from BasicForm.) | |
AllowModeSwitch |
Determines whether to allow mode switching (simple <-> advanced).
(Inherited from BasicForm.) | |
AllowSpellCheck |
Indicates if spell check is allowed. Not allowed by default.
(Inherited from AbstractBasicForm.) | |
AlternativeFormFullName |
Alternative form full name (ClassName.AlternativeFormName).
| |
AltFormInformation |
Alternative form information.
(Inherited from BasicForm.) | |
ApplyVisibility |
Indicates if field visibility should be applied.
(Inherited from BasicForm.) | |
AppRelativeTemplateSourceDirectory | Gets or sets the application-relative virtual directory of the Page or UserControl object that contains this control. (Inherited from Control.) | |
AssociatedControls |
Controls associated with FormItems.
(Inherited from BasicForm.) | |
Attributes | Gets the collection of arbitrary attributes (for rendering only) that do not correspond to properties on the control. (Inherited from WebControl.) | |
AutomaticLabelWidth |
Set width of all labels according to the widest label.
This property is applied only if DefaultFormLayout is set to Divs.
(Inherited from BasicForm.) | |
BackColor | Gets or sets the background color of the Web server control. (Inherited from WebControl.) | |
BindingContainer | Gets the control that contains this control's data binding. (Inherited from Control.) | |
BorderColor | Gets or sets the border color of the Web control. (Inherited from WebControl.) | |
BorderStyle | Gets or sets the border style of the Web server control. (Inherited from WebControl.) | |
BorderWidth | Gets or sets the border width of the Web server control. (Inherited from WebControl.) | |
ClassInfo |
DataClassInfo of edited object.
(Inherited from BasicForm.) | |
ClientID | Gets the control ID for HTML markup that is generated by ASP.NET. (Inherited from Control.) | |
ClientIDMode | Gets or sets the algorithm that is used to generate the value of the ClientID property. (Inherited from Control.) | |
ClientIDSeparator | Gets a character value representing the separator character used in the ClientID property. (Inherited from Control.) | |
CollapseCategoryImageUrl |
Image URL for collapsing a category.
(Inherited from BasicForm.) | |
ComponentName |
Component name.
| |
Context | Gets the HttpContext object associated with the server control for the current Web request. (Inherited from Control.) | |
ContextResolver |
Form context resolver.
(Inherited from BasicForm.) | |
ControlContext |
Gets the current control context.
(Inherited from AbstractBasicForm.) | |
Controls | Gets a ControlCollection object that represents the child controls for a specified server control in the UI hierarchy. (Inherited from Control.) | |
ControlStyle | Gets the style of the Web server control. This property is used primarily by control developers. (Inherited from WebControl.) | |
ControlStyleCreated | Gets a value indicating whether a Style object has been created for the ControlStyle property. This property is primarily used by control developers. (Inherited from WebControl.) | |
CopyDefaultDataFromDocumentId |
Optional DocumentId of the document that should be used as a template with default values.
| |
CssClass | Gets or sets the Cascading Style Sheet (CSS) class rendered by the Web server control on the client. (Inherited from WebControl.) | |
CultureCode |
Culture code.
| |
CustomTimeZone |
Gets or sets custom time zone info. This time zone is used when TimeZoneType is 'custom'.
(Inherited from AbstractBasicForm.) | |
Data |
Data to be edited.
(Inherited from AbstractBasicForm.) | |
DataItemContainer | Gets a reference to the naming container if the naming container implements IDataItemContainer. (Inherited from Control.) | |
DataKeysContainer | Gets a reference to the naming container if the naming container implements IDataKeysControl. (Inherited from Control.) | |
DataRow |
Data to be edited.
(Inherited from AbstractBasicForm.) | |
DefaultCategoryName |
Default category name.
(Inherited from BasicForm.) | |
DefaultFieldLayout |
Default field layout.
(Inherited from BasicForm.) | |
DefaultFormLayout |
Form layout.
(Inherited from BasicForm.) | |
DefaultPageTemplateID |
Default page template ID.
| |
DefaultValidationErrorMessage |
Default validation error message.
| |
DesignMode | Gets a value indicating whether a control is being used on a design surface. (Inherited from Control.) | |
DialogParameters |
Additional parameters for the dialog windows.
(Inherited from BasicForm.) | |
DisplayContext |
Gets or sets the current display context which is used if control contains DisplayIn value.
(Inherited from BasicForm.) | |
DocumentID |
Specifies together with CultureCode edited node.
| |
DocumentManager |
Document manager control
| |
EditedObject |
Edited object. TreeNode in CMSForm, IDataClass in BizForm and CustomTableForm,
AbstractInfo or DataClassInfo in DataForm.
(Inherited from BasicForm.) | |
Enabled |
Indicates if the form control is enabled.
(Inherited from BasicForm.) | |
EnableTheming | Gets or sets a value indicating whether themes apply to this control. (Inherited from WebControl.) | |
EnableViewState | 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 Control.) | |
EnsureFirstLetterUpperCase |
If true, labels of the controls are processed to have the first letter upper case.
(Inherited from BasicForm.) | |
ErrorLabel |
Label for the errors.
(Overrides BasicForm ErrorLabel.) | |
Events | Gets a list of event handler delegates for the control. This property is read-only. (Inherited from Control.) | |
ExpandCategoryImageUrl |
Image URL for expanding a category.
(Inherited from BasicForm.) | |
ExplanationTextCssClass |
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.) | |
FieldActionsControls |
Contains FieldActions controls if the form is in design mode (BasicForm.IsDesignMode property).
(Inherited from AbstractBasicForm.) | |
FieldCaptionCellCssClass |
CSS class for the individual field label cell.
(Inherited from BasicForm.) | |
FieldCaptionCssClass |
CSS class for the individual field label.
(Inherited from BasicForm.) | |
FieldControls |
Dictionary with FormEngineUserControl objects.
(Inherited from AbstractBasicForm.) | |
FieldCssClass |
CSS class for the whole field (usually row).
(Inherited from BasicForm.) | |
FieldEditingControls |
Dictionary with EditingFormControl objects.
(Inherited from AbstractBasicForm.) | |
FieldErrorCellCssClass |
CSS class for the individual field error label cell.
(Inherited from BasicForm.) | |
FieldErrorCssClass |
CSS class that is added to editing form control after its validation failed. Default value is "Error".
(Inherited from BasicForm.) | |
FieldErrorLabelCssClass |
CSS class for the individual field error label.
(Inherited from BasicForm.) | |
FieldErrorLabels |
FieldErrorLabels.
(Inherited from AbstractBasicForm.) | |
FieldGroupCaptionCssClass |
CSS class for the field group caption.
(Inherited from BasicForm.) | |
FieldGroupCssClass |
CSS class for the whole field group.
(Inherited from BasicForm.) | |
FieldGroupHeadingIsAnchor |
Gets or sets a value indicating whether heading for the field group caption is anchor.
(Inherited from BasicForm.) | |
FieldGroupHeadingLevel |
Heading level for the field group caption.
(Inherited from BasicForm.) | |
FieldLabels |
FieldLabels.
(Inherited from AbstractBasicForm.) | |
Fields |
List of field names in order they appear in the form.
(Inherited from AbstractBasicForm.) | |
FieldsToHide |
List of fields to hide (empty by default).
(Inherited from BasicForm.) | |
FieldUpdatePanels |
Contains update panels which surround the fields (whole rows including labels) if the form is in design mode (BasicForm.IsDesignMode property).
(Inherited from AbstractBasicForm.) | |
FieldValueCellCssClass |
CSS class for the individual field control cell.
(Inherited from BasicForm.) | |
FieldVisibilityCellCssClass |
CSS class for the individual field visibility cell.
(Inherited from BasicForm.) | |
FieldVisibilityControls |
Visibility controls hashtable.
(Inherited from AbstractBasicForm.) | |
FieldVisibilityCssClass |
CSS class for the individual field visibility control.
(Inherited from BasicForm.) | |
FirstField |
First field element.
(Inherited from BasicForm.) | |
Font | Gets the font properties associated with the Web server control. (Inherited from WebControl.) | |
ForceReloadCategories |
Forces categories to get to default collapsed state.
(Inherited from BasicForm.) | |
ForeColor | Gets or sets the foreground color (typically the color of the text) of the Web server control. (Inherited from WebControl.) | |
FormButtonCssClass |
CSS class for the form button.
(Inherited from BasicForm.) | |
FormButtonPanel |
Returns panel surrounding submit button if generated by automatic layouts, otherwise returns null.
(Inherited from BasicForm.) | |
FormButtonPanelCssClass |
CSS class for the form button panel.
(Inherited from BasicForm.) | |
FormCssClass |
CSS class which will be used to wrap form control.
(Inherited from BasicForm.) | |
FormDefaultStyle |
Default form-specific style configuration.
(Inherited from BasicForm.) | |
FormGUID |
Identifies the instance of form.
(Inherited from BasicForm.) | |
FormInformation |
Form information.
(Inherited from BasicForm.) | |
FormLayout |
Definition of the form layout.
(Inherited from BasicForm.) | |
FormLayoutType |
Form layout type.
(Inherited from BasicForm.) | |
FormMode |
Form mode - insert or update.
| |
FormName |
Form name in form application.class.form.
| |
FormPanel |
Returns form outer panel.
(Inherited from BasicForm.) | |
FormPrefix |
Form name prefix. If set, form with name in format [FormPrefix][form name] is searched instead of [form name].
| |
FormType |
Indicates in what control is this basic form used.
(Inherited from BasicForm.) | |
GroupCssClass |
CSS class for the whole field group with heading.
(Inherited from BasicForm.) | |
GroupID |
Group ID.
| |
HasAttributes | Gets a value indicating whether the control has attributes set. (Inherited from WebControl.) | |
HasChildViewState | Gets a value indicating whether the current server control's child controls have any saved view-state settings. (Inherited from Control.) | |
Height | Gets or sets the height of the Web server control. (Inherited from WebControl.) | |
HideSystemFields |
If true, system fields are hidden.
(Inherited from BasicForm.) | |
HtmlAreaToolbar |
HTML editor toolbar set name.
(Inherited from BasicForm.) | |
HtmlAreaToolbarLocation |
HTML editor toolbar location.
(Inherited from BasicForm.) | |
CheckFieldEmptiness |
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.) | |
ChildControlsCreated | Gets a value that indicates whether the server control's child controls have been created. (Inherited from Control.) | |
ID | Gets or sets the programmatic identifier assigned to the server control. (Inherited from Control.) | |
IdSeparator | Gets the character used to separate control identifiers. (Inherited from Control.) | |
InfoLabel |
Information label.
(Overrides BasicForm InfoLabel.) | |
InitCompleted |
If true, the initialization of the control has already completed and won't repeat. Set to true in your initialization code.
(Inherited from CMSDynamicWebControl.) | |
InitEarly |
If true, the control initializes on BeforeInitComplete, otherwise on InitComplete event.
(Inherited from CMSDynamicWebControl.) | |
IsDesignMode |
Determines whether the form is in design mode.
(Inherited from BasicForm.) | |
IsEnabled | Gets a value indicating whether the control is enabled. (Inherited from WebControl.) | |
IsFirstLoad |
Indicates if inner controls are loaded for the first time (the form may be initialized on a postback).
(Inherited from BasicForm.) | |
IsChildControlStateCleared | Gets a value indicating whether controls contained within this control have control state. (Inherited from Control.) | |
IsInsertMode |
Indicates if the control is used for inserting a new object.
(Inherited from AbstractBasicForm.) | |
IsLiveSite |
Indicates if control is used on live site.
(Inherited from CMSWebControl.) | |
IsSimpleMode |
Sets simple/advanced mode of basicform.
(Inherited from BasicForm.) | |
IsTrackingViewState | Gets a value that indicates whether the server control is saving changes to its view state. (Inherited from Control.) | |
IsViewStateEnabled | Gets a value indicating whether view state is enabled for this control. (Inherited from Control.) | |
LastField |
Last field element.
(Inherited from BasicForm.) | |
Layout |
Layout of the form
(Inherited from BasicForm.) | |
LayoutTemplate |
Layout template, if set, the given layout is used.
(Inherited from BasicForm.) | |
LoadViewStateByID | Gets a value indicating whether the control participates in loading its view state by ID instead of index. (Inherited from Control.) | |
MacroTable |
Hashtable with IsMacro flags.
(Inherited from BasicForm.) | |
MarkRequiredFields |
If true, required field labels are marked with resource string.
(Inherited from BasicForm.) | |
MessagesPlaceHolder |
Messages placeholder.
(Overrides BasicForm MessagesPlaceHolder.) | |
Mode |
Gets or sets the mode of the form.
(Inherited from AbstractBasicForm.) | |
NamingContainer | Gets a reference to the server control's naming container, which creates a unique namespace for differentiating between server controls with the same ID property value. (Inherited from Control.) | |
Node |
Document node.
| |
NodeId | Obsolete.
Specifies together with CultureCode edited node.
| |
NodeID |
Specifies together with CultureCode edited node.
| |
OwnerID |
Owner ID.
| |
Page | Gets a reference to the Page instance that contains the server control. (Inherited from Control.) | |
Parent | Gets a reference to the server control's parent control in the page control hierarchy. (Inherited from Control.) | |
ParentNodeID |
Parent node ID. Indicates parent node for document insertion.
| |
ParentObject |
Parent object. Setup in CMSFrom in insert mode, contains TreeNode.
(Inherited from BasicForm.) | |
ProcessDisabledFields |
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.) | |
RedirectUrlAfterSave |
URL to which the form redirects after successful save.
(Inherited from BasicForm.) | |
RenderingCompatibility | Gets a value that specifies the ASP.NET version that rendered HTML will be compatible with. (Inherited from Control.) | |
ResolverName |
Gets or sets macro resolver name.
(Inherited from BasicForm.) | |
SetDefaultValuesToDisabledFields |
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.) | |
ShortID |
Short ID of the control.
(Inherited from CMSWebControl.) | |
ShowImageButton |
Show image button flag.
(Inherited from BasicForm.) | |
ShowOkButton |
Indicates if button OK should be displayed.
| |
ShowPrivateFields |
Indicates whether to show private fields or not.
(Inherited from BasicForm.) | |
ShowValidationErrorMessage |
Indicates if error message should be displayed after validation failed.
(Inherited from BasicForm.) | |
Site | Gets information about the container that hosts the current control when rendered on a design surface. (Inherited from Control.) | |
SiteName |
Current SiteName.
(Inherited from BasicForm.) | |
SkinID | Gets or sets the skin to apply to the control. (Inherited from WebControl.) | |
SpellCheckFields |
List with client Ids of fields that should be spell checked.
(Inherited from AbstractBasicForm.) | |
StopProcessing |
Indicates if processing of the code of this control should continue. It can be used after raising an event.
(Inherited from CMSDynamicWebControl.) | |
Style | 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 WebControl.) | |
SubmitButton |
Form submit button.
(Inherited from BasicForm.) | |
SubmitImageButton |
Form submit image button.
(Inherited from BasicForm.) | |
SupportsDisabledAttribute | 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. (Inherited from WebControl.) | |
TabIndex | Gets or sets the tab index of the Web server control. (Inherited from WebControl.) | |
TagKey |
Overrides the generation of the SPAN tag with custom tag.
(Inherited from BasicForm.) | |
TagName | Gets the name of the control tag. This property is used primarily by control developers. (Inherited from WebControl.) | |
TemplateControl | Gets or sets a reference to the template that contains this control. (Inherited from Control.) | |
TemplateSourceDirectory | Gets the virtual directory of the Page or UserControl that contains the current server control. (Inherited from Control.) | |
TimeZoneType |
Gets or sets time zone type for child controls. Default value is TimeZoneTypeEnum.Inherit.
(Inherited from AbstractBasicForm.) | |
ToolTip | Gets or sets the text displayed when the mouse pointer hovers over the Web server control. (Inherited from WebControl.) | |
TreeProvider |
Tree provider instance. If it's not provided, it's created automatically.
| |
UIContext |
Returns control's UI context
(Inherited from CMSWebControl.) | |
UniqueID | Gets the unique, hierarchically qualified identifier for the server control. (Inherited from Control.) | |
UseColonBehindLabel |
If true, colon(:) is placed behind field label.
(Inherited from BasicForm.) | |
ValidationErrorMessage |
Optional error message displayed after validation failed.
(Inherited from BasicForm.) | |
ViewState | 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 Control.) | |
ViewStateIgnoresCase | Gets a value that indicates whether the StateBag object is case-insensitive. (Inherited from Control.) | |
ViewStateMode | Gets or sets the view-state mode of this control. (Inherited from Control.) | |
VisibilityFormName |
This name is used if ApplyVisibility is 'true' to get visibility definition of current user.
(Inherited from BasicForm.) | |
Visible | Gets or sets a value that indicates whether a server control is rendered as UI on the page. (Inherited from Control.) | |
Width | Gets or sets the width of the Web server control. (Inherited from WebControl.) |
Events
Name | Description | |
---|---|---|
DataBinding | Occurs when the server control binds to a data source. (Inherited from Control.) | |
Disposed | 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 Control.) | |
Init | Occurs when the server control is initialized, which is the first step in its lifecycle. (Inherited from Control.) | |
Load | Occurs when the server control is loaded into the Page object. (Inherited from Control.) | |
OnAfterDataLoad |
After data load event.
(Inherited from BasicForm.) | |
OnAfterSave |
After form data save event. It is called during saving process when the form content is successfully saved.
(Inherited from BasicForm.) | |
OnAfterValidate |
After validation event.
(Inherited from BasicForm.) | |
OnBeforeDataLoad |
Before data load event.
(Inherited from BasicForm.) | |
OnBeforeDataRetrieval |
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.) | |
OnBeforeRedirect |
Before redirect event (after successful save).
(Inherited from BasicForm.) | |
OnBeforeSave |
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.) | |
OnBeforeValidate |
Before validation event.
(Inherited from BasicForm.) | |
OnDeleteFile |
Occurs when the file is deleted.
(Inherited from BasicForm.) | |
OnGetAttachment |
Occurs when an attachment is retrieved.
(Inherited from BasicForm.) | |
OnGetControlValue |
Occurs when a value is being extracted from a form control.
(Inherited from AbstractBasicForm.) | |
OnCheckPermissions |
Occurs when permission can be checked. It is called at the beginning of the saving process.
(Inherited from BasicForm.) | |
OnItemValidation |
Occurs when a field is validated.
(Inherited from BasicForm.) | |
OnSaveFailed |
Occurs when saving data to the database fails.
(Inherited from BasicForm.) | |
OnUploadFile |
Occurs when the file is uploaded.
(Inherited from BasicForm.) | |
OnValidationFailed |
Occurs when validation of the form fails.
(Inherited from BasicForm.) | |
PreRender | Occurs after the Control object is loaded but prior to rendering. (Inherited from Control.) | |
Unload | Occurs when the server control is unloaded from memory. (Inherited from Control.) |
See Also