EditingFormControl Class

EditingFormControl control.

Inheritance Hierarchy

System.Object
  System.Web.UI.Control
    System.Web.UI.WebControls.WebControl
      CMS.FormEngine.Web.UI.FormEngineWebControl
        CMS.FormEngine.Web.UI.EditingFormControl

Namespace: CMS.FormEngine.Web.UI
Assembly: CMS.FormEngine.Web.UI (in CMS.FormEngine.Web.UI.dll) Version: 10.0.0

Syntax

public class EditingFormControl : FormEngineWebControl, 
	ICallbackEventHandler

The EditingFormControl type exposes the following members.

Constructors

	Name	Description
Public method	EditingFormControl()	Constructor.
Public method	EditingFormControl(FormFieldInfo, BasicForm)	Constructor.

Properties

	Name	Description
Public property	AllowMacroEditing	Determines whether to display the "Edit macro" button.
Public property	BadWordsList	List of found bad words.
Public property	BadWordsResult	Result of bad word check.
Public property	ContextResolver	Gets or sets macro resolver for given control.
Public property	ControlStyle	CSS style of the control. (Inherited from FormEngineWebControl.)
Public property	CssClass	CSS class of the control. (Inherited from FormEngineWebControl.)
Public property	Data	Data to be edited.
Public property	DataDR	Node data. This property is used only for passing values to the control. (Inherited from FormEngineWebControl.)
Public property	DataValue	Data value.
Public property	Enabled	Enabled. (Overrides WebControl.Enabled.)
Public property	Field	Field name to which the field belongs. This property is only supported in templated form.
Public property	FieldInfo	Field info object. (Inherited from FormEngineWebControl.)
Public property	FieldType	Field type.
Public property	Form	Parent form. (Inherited from FormEngineWebControl.)
Public property	FormControlName	Form control code name.
Public property	FormControlParameter	Helper property to use custom parameter in form control. (Inherited from FormEngineWebControl.)
Public property	FormControlPath	Form control path.
Public property	HasValue	Returns true if the control has value, if false, the value from the control should not be used within the form to update the data (Inherited from FormEngineWebControl.)
Public property	IsDefaultValueAndMacro	Returns true if default value of formfield is macro expression and current value is the default value.
Public property	IsInsertMode	Is insert mode.
Public property	IsLiveSite	Indicates if the control is on live site.
Public property	IsMacro	Determines whether the value is macro or not.
Protected property	ItemName	Name of the edited item.
Public property	MacroEditButton	Gets the button control which shows the modal dialog with macro editor.
Public property	MacroTable	Macro table.
Public property	Mode	Mode of the form.
Public property	NestedControl	Gets the nested control.
Public property	NestedControlPanel	Gets the Panel where the nested control is placed.
Protected property	OriginalValue	Original control value
Public property	RemoveMacroButton	Gets the button control for removing macro.
Public property	ResolverName	Gets or sets macro resolver name.
Public property	StopProcessing	If true, control does not process the data. (Inherited from FormEngineWebControl.)
Public property	ValidationError	Validation error string shown when the control is not valid. (Inherited from FormEngineWebControl.)
Public property	Value	Gets or sets the value to the nested control. (Overrides FormEngineWebControl.Value.)
Public property	ValueDisplayName	Gets the display name of the value item. Returns null if display name is not available. (Inherited from FormEngineWebControl.)
Public property	ValueElementID	Gets ClientID of the control from which the Value is retrieved or null if such a control can't be specified. (Overrides FormEngineWebControl.ValueElementID.)
Public property	ValueForValidation	Returns value prepared for validation. (Overrides FormEngineWebControl.ValueForValidation.)

Methods

	Name	Description
Protected method	CreateChildControls	Renders the control at run-time. (Overrides Control.CreateChildControls().)
Public method	EnsureControls	Ensures the inner controls.
Public method	GetCallbackResult	Gets callback result.
Public method Static member	GetInputClientID(ControlCollection)	Gets client ID of first inner input control which is not already associated with some label.
Public method Static member	GetInputClientID(ControlCollection, Hashtable)	Obsolete. Goes through controls collection and insert into provided hashtable input, select and file controls without associated label.
Public method Static member	GetInputControlID	Gets control ID of first inner input control which is not already associated with some label.
Public method	GetOtherValues	Redirects to NestedControl GetOtherValues() or returns null if nested control is not FormEngineUserControl. (Overrides FormEngineWebControl.GetOtherValues().)
Public method	GetSpellCheckFields	Returns the list of the field IDs (Client IDs of the inner controls) that should be spell checked. (Inherited from FormEngineWebControl.)
Public method	CheckBadWords	Perform bad words check.
Public method	IsValid	Validation of the control. (Overrides FormEngineWebControl.IsValid().)
Public method	LoadControlValue	Loads control value (Inherited from FormEngineWebControl.)
Public method	LoadOtherValues	Loads the other fields values to the state of the form control (Inherited from FormEngineWebControl.)
Protected method	LoadViewState	Customized LoadViewState. (Overrides WebControl.LoadViewState(Object).)
Protected method	OnInit	Init event handler. (Overrides Control.OnInit(EventArgs).)
Protected method	OnPreRender	PreRender event handler. (Overrides Control.OnPreRender(EventArgs).)
Protected method	Page_InitComplete	Event handler of page's init complete.
Public method	RaiseCallbackEvent	Raise callback method.
Public method	Reload	Reloads the control.
Protected method	Render	Renders the control at design-time. (Overrides FormEngineWebControl.Render(HtmlTextWriter).)
Protected method	SaveViewState	Customized SaveViewState. (Overrides WebControl.SaveViewState().)
Public method	SetValue	Sets control value.

Extension Methods

	Name	Description
Public Extension Method	AddCssClass	Adds CSS class to control. If class is already present, than adding is skipped. Class names are case sensitive. (Defined by ControlsExtensions.)
Public Extension Method	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.)
Public Extension Method	GetCssClasses	Returns all CSS classes of control. (Defined by ControlsExtensions.)
Public Extension Method	GetRenderedHTML	Returns HTML which would be rendered by control to page. (Defined by ControlsExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by ControlsExtensions.)
Public Extension Method	HasCssClass	Checks whether the control has given CSS class. Class names are case sensitive. (Defined by ControlsExtensions.)
Public Extension Method	RemoveCssClass	Removes all occurrences. Class names are case sensitive. (Defined by ControlsExtensions.)
Public Extension Method	SetCssClasses	Sets CSS classes to the control. Current classes will be overridden. (Defined by ControlsExtensions.)