ListFormControl Class

Abstract class for list-type form controls.

Inheritance Hierarchy

System.Object
  System.Web.UI.Control
    System.Web.UI.TemplateControl
      System.Web.UI.UserControl
        CMS.Base.Web.UI.AbstractUserControl
          CMS.Base.Web.UI.InlineUserControl
            CMS.FormEngine.Web.UI.FormEngineUserControl
              CMS.UIControls.ListFormControl

Namespace: CMS.UIControls
Assembly: CMS.UIControls (in CMS.UIControls.dll) Version: 10.0.0

Syntax

public abstract class ListFormControl : FormEngineUserControl

The ListFormControl type exposes the following members.

Constructors

	Name	Description
Protected method	ListFormControl

Properties

	Name	Description
Protected property	CaseSensitiveSelection	If true, the selection of items is case sensitive, otherwise the selection is case insensitive. Default is case insensitive.
Public property	ComponentName	Component name (Inherited from AbstractUserControl.)
Public property	ContextResolver	Gets or sets macro resolver for given control. (Inherited from FormEngineUserControl.)
Public property	ControlStyle	CSS style of the control. (Inherited from FormEngineUserControl.)
Public property	CssClass	CSS class of the control. (Inherited from FormEngineUserControl.)
Public property	CurrentDocument	Current document (Inherited from AbstractUserControl.)
Public property	CurrentPageInfo	Current page info (Inherited from AbstractUserControl.)
Public property	CurrentSite	Current site (Inherited from AbstractUserControl.)
Public property	CurrentUser	Current user (Inherited from AbstractUserControl.)
Public property	Data	Node data. This property is used only for passing values to the control. (Inherited from FormEngineUserControl.)
Protected property	DefaultCssClass	Default CSS class which is applied to the ListControl if no other CSS class was specified.
Public property	DefaultProperties	Control properties (Inherited from FormEngineUserControl.)
Public property	DependsOnAnotherField	Indicates if field depends on another field. (Inherited from FormEngineUserControl.)
Public property	DocumentManager	Document manager control (Inherited from AbstractUserControl.)
Public property	EditedObject	Control's edited object (Inherited from FormEngineUserControl.)
Public property	Enabled	Gets or sets the enabled state of the control. (Overrides FormEngineUserControl.Enabled.)
Public property	ErrorMessage	Control custom error message. (Inherited from FormEngineUserControl.)
Public property	Field	Field name to which the field belongs. (Inherited from FormEngineUserControl.)
Public property	FieldInfo	Field info object. (Inherited from FormEngineUserControl.)
Public property	Form	Parent form. (Inherited from FormEngineUserControl.)
Protected property	FormControlName	Form control name which is used in error message if loading failed.
Public property	FormControlParameter	Helper property to use custom parameter in form control. (Inherited from FormEngineUserControl.)
Public property	HasDependingFields	Indicates if another fields depend on this field. (Inherited from FormEngineUserControl.)
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 FormEngineUserControl.)
Public property	HeaderActions	Header actions control (Inherited from AbstractUserControl.)
Public property	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 file uploaders. Field emptiness validation then must be placed in custom form control in IsValid() method. (Inherited from FormEngineUserControl.)
Public property	CheckMinMaxLength	Indicates that field should be checked on min/max input length in validation step by BasicForm. Default FALSE. It is preferable to set to TRUE for simple text input controls such as TextBox. (Inherited from FormEngineUserControl.)
Public property	CheckRegularExpression	Indicates that field should be checked on regular expressions in validation step by BasicForm. Default FALSE. It is preferable to set to TRUE for controls where user should be able to enter text such as TextBox. (Inherited from FormEngineUserControl.)
Public property	CheckUnique	If true, the field is checked for uniqueness. This property is only supported in templated form. (Inherited from FormEngineUserControl.)
Public property	InputClientID	Client ID of primary input control. If not explicitly set, first client ID of inner control of the form control is returned. (Inherited from FormEngineUserControl.)
Public property	InputControlID	Control ID of primary input control. If not explicitly set, first control ID of inner control of the form control is returned. (Inherited from FormEngineUserControl.)
Public property	IsLiveSite	Indicates if control is used on live site. (Inherited from AbstractUserControl.)
Public property	Item	Gets or sets the value of the column. (Inherited from InlineUserControl.)
Protected property	ListControl	List control.
Public property	MacroSource	Macro source.
Public property	MessagesPlaceHolder	Placeholder for messages (Inherited from AbstractUserControl.)
Public property	Parameter	Control parameter. (Inherited from InlineUserControl.)
Protected property	Properties	Control properties. (Inherited from InlineUserControl.)
Public property	RememberOriginalValue	If true, the control remembers the original value for evaluation (Inherited from FormEngineUserControl.)
Public property	ResolverName	Gets or sets macro resolver name. (Inherited from FormEngineUserControl.)
Public property	ResourcePrefix	Gets or sets resource prefix for custom texts. (Inherited from FormEngineUserControl.)
Public property	ResourcePrefixes	List of cached resource prefixes for the parent hierarchy (Inherited from AbstractUserControl.)
Protected property	SelectionMode	Specifies the selection mode of the ListControl.
Public property	Separator	Contains the character that is placed between selected items in multiple selection mode.
Public property	ShortID	Short ID of the control. (Inherited from AbstractUserControl.)
Public property	SortItems	Indicates whether the items load to the ListControl will be alphabetically sorted.
Public property	StopProcessing	If true, control does not process the data. (Inherited from FormEngineUserControl.)
Public property	Text	Gets or sets Value converted to string. (Inherited from FormEngineUserControl.)
Public property	TextFormat	Text pattern containing macro. Valid when the data source is query or macro.
Public property	Trim	If true, the returned value is trimmed. This property is only supported if used inside the form control. Default false. (Inherited from FormEngineUserControl.)
Protected property	UIContext	Control's UI Context (Inherited from FormEngineUserControl.)
Protected property	UnderlyingFormControl	Underlying form control, if provided, the form control automatically redirects all properties to that control (Inherited from FormEngineUserControl.)
Public property	UsesLocalMessagesPlaceHolder	Indicates if control uses local messages placeholder (Inherited from AbstractUserControl.)
Public property	ValidationError	Validation error string shown when the control is not valid. (Inherited from FormEngineUserControl.)
Public property	Value	Gets or sets form control value. (Overrides FormEngineUserControl.Value.)
Public property	ValueDisplayName	Gets the display name of the value item. Returns null if display name is not available. (Inherited from FormEngineUserControl.)
Public property	ValueElementID	Gets ClientID of the control from which the Value is retrieved or null if such a control can't be specified. (Inherited from FormEngineUserControl.)
Public property	ValueFormat	Value pattern containing macro. Valid when the data source is query or macro.
Public property	ValueForValidation	Returns value prepared for validation. (Inherited from FormEngineUserControl.)
Protected property	ViewState	ViewState - overridden for the Master page ViewState fix. (Inherited from InlineUserControl.)
Public property	WhereConditionFormat	Format of where condition. (Inherited from FormEngineUserControl.)

Methods

	Name	Description
Public method	AddConfirmation	Adds confirmation text to existing message on the page. (Inherited from AbstractUserControl.)
Public method	AddError	Adds error text to existing message on the page. (Inherited from AbstractUserControl.)
Public method	AddHeaderAction	Adds specified action to the page header actions. (Inherited from AbstractUserControl.)
Public method	AddInformation	Adds information text to existing message on the page. (Inherited from AbstractUserControl.)
Public method	AddMessage	Adds message text to existing message on the page. (Inherited from AbstractUserControl.)
Public method	AddWarning	Adds warning text to existing message on the page. (Inherited from AbstractUserControl.)
Protected method	ApplyCssClassAndStyles	Tries to apply CssClass CSS class and ControlStyle style to the control.
Protected method	ConnectToForm	Connects the given form control to a form if necessary (Inherited from FormEngineUserControl.)
Protected method	ContainsColumn	Indicates if form control's DataRow contains requested column. (Inherited from FormEngineUserControl.)
Protected method	ConvertInputValue	Ensures that the given value is represented as null is empty, or converted to proper type. (Inherited from FormEngineUserControl.)
Public method	EnsureControls	Interface for control that is able to explicitly ensure its child controls (Inherited from AbstractUserControl.)
Public method	Eval(String)	Evaluates the given value (Inherited from AbstractUserControl.)
Public method	Eval(String, Boolean)	Evaluates the item data (safe version), with html encoding. (Inherited from AbstractUserControl.)
Public method	EvalBool	Evaluates the item data and converts it to the bool. (Inherited from AbstractUserControl.)
Public method	EvalDateTime	Evaluates the item data and converts it to the date time. (Inherited from AbstractUserControl.)
Public method	EvalDouble	Evaluates the item data and converts it to the integer. (Inherited from AbstractUserControl.)
Public method	EvalGuid	Evaluates the item data and converts it to the guid. (Inherited from AbstractUserControl.)
Public method	EvalHTML	Evaluates the item data and doesn't encode it. Method should be used for columns with html content. (Inherited from AbstractUserControl.)
Public method	EvalHtmlAttribute	Evaluates the item data, encodes it to be used in HTML attribute. (Inherited from AbstractUserControl.)
Public method	EvalInteger	Evaluates the item data and converts it to the integer. (Inherited from AbstractUserControl.)
Public method	EvalJSString	Evaluates the item data, encodes it to be used in javascript code and encapsulates it with "'". (Inherited from AbstractUserControl.)
Public method	EvalText(String)	Evaluates the item data and encodes it. Method should be used for columns with string nonhtml content. (Inherited from AbstractUserControl.)
Public method	EvalText(String, Boolean)	Evaluates the item data and encodes it. Method should be used for columns with string nonhtml content. (Inherited from AbstractUserControl.)
Protected method	Form_ControlWithDependenciesChanged	Another form control, which has some dependencies, has changed. (Inherited from FormEngineUserControl.)
Protected method	GetColumnValue	Gets the given column value from the form data (Inherited from FormEngineUserControl.)
Public method	GetControlInfoMarker	Gets the control info marker code (Inherited from FormEngineUserControl.)
Protected method	GetControlValue	Returns string with selected value of the ListControl. The string may contain more items separated by Separator in multiple selection mode.
Protected method	GetDialogConfiguration	Returns dialog configuration from the specified form control settings. (Inherited from FormEngineUserControl.)
Public method	GetFlagIconUrl	Returns resolved path to the flag image for the specified culture. (Inherited from AbstractUserControl.)
Public method	GetImagePath	Gets UI image relative path. (Inherited from AbstractUserControl.)
Public method	GetImageUrl	Gets UI image relative path. (Inherited from AbstractUserControl.)
Public method	GetOtherValue	Returns a value of other field with specified returned by the control. (Inherited from FormEngineUserControl.)
Public method	GetOtherValues	Returns an array of values of any other fields returned by the control. (Inherited from FormEngineUserControl.)
Public method	GetResolvedValue<ReturnType>	Gets resolved property value (Inherited from FormEngineUserControl.)
Public method	GetSpellCheckFields	Returns the list of the field IDs (Client IDs of the inner controls) that should be spell checked. (Inherited from FormEngineUserControl.)
Public method	GetString	Returns the localized string of the control's hierarchically highest parent that has the ResourcePrefix property and its translation defined. (Inherited from AbstractUserControl.)
Protected method	GetStringValue	Gets the string value from the given value (Inherited from FormEngineUserControl.)
Public method	GetValue(String)	Returns the value of the given property. (Inherited from FormEngineUserControl.)
Public method	GetValue<ReturnType>(String, ReturnType)	Returns the value of the given property. (Inherited from InlineUserControl.)
Public method	GetWhereCondition	Gets a where condition. Returns where condition formatted by WhereConditionFormat from IFilterFormControl interface if form control implements it. Otherwise returns where condition in [FieldName] = 'Value' format. (Inherited from FormEngineUserControl.)
Public method	HasValue	Returns true if the value of the given property is set. (Inherited from InlineUserControl.)
Public method	IsValid	Returns true if entered data is valid. If data is invalid, it returns false and displays an error message. (Inherited from FormEngineUserControl.)
Protected method	LoadAndSelectList	Loads and selects control.
Public method	LoadControlFromFFI	Loads control with values in FormFieldInfo. (Inherited from FormEngineUserControl.)
Public method	LoadControlValue	Loads control value. (Inherited from FormEngineUserControl.)
Public method	LoadDefaultProperties	Loads the default properties from the given form definition (Inherited from FormEngineUserControl.)
Public method	LoadOtherValues	Loads the other fields values to the state of the form control (Inherited from FormEngineUserControl.)
Public method	LoadUserControl	Loads the user control based on the given path (Inherited from AbstractUserControl.)
Public method	LogAndShowError	Logs the exception and (Inherited from AbstractUserControl.)
Public method	OnContentLoaded	Method that is called when the control content is loaded. (Inherited from InlineUserControl.)
Protected method	OnInit	OnInit event. (Inherited from FormEngineUserControl.)
Protected method	OnLoad	Load event handler. (Overrides AbstractUserControl.OnLoad(EventArgs).)
Protected method	OnPreRender	PreRender event handler. (Inherited from AbstractUserControl.)
Protected method	RaiseOnChanged	Raises the Changed event. (Inherited from FormEngineUserControl.)
Protected method	ReloadControl	Reloads control's content. (Overrides FormEngineUserControl.ReloadControl().)
Protected method	Render	Renders user control. (Inherited from FormEngineUserControl.)
Public method	ResolveUrl	Resolves the given URL (Inherited from AbstractUserControl.)
Protected method	SetControlValue	Sets selected item(s) of the ListControl based on the given value. The value may contain more items separated by Separator in multiple selection mode.
Public method	SetValue(String, Object)	Sets the property value of the control, setting the value affects only local property value. (Inherited from FormEngineUserControl.)
Public method	SetValue(String, Object, Boolean)	Sets the property value of the control, setting the value affects only local property value. (Inherited from FormEngineUserControl.)
Public method	ShowConfirmation	Shows the general confirmation message. (Inherited from AbstractUserControl.)
Public method	ShowError	Shows the specified error message, optionally with a tooltip text. (Inherited from AbstractUserControl.)
Public method	ShowChangesSaved	Shows the general changes saved message. (Inherited from AbstractUserControl.)
Public method	ShowInformation	Shows the given information on the page, optionally with a tooltip text. (Inherited from AbstractUserControl.)
Public method	ShowMessage(MessageTypeEnum, String, String, String, Boolean)	Shows the specified message, optionally with a tooltip text. (Inherited from AbstractUserControl.)
Protected method	ShowMessage(MessageTypeEnum, String, String, String, Boolean, Boolean)	Shows the specified message, optionally with a tooltip text. (Inherited from AbstractUserControl.)
Public method	ShowWarning	Shows the specified warning message, optionally with a tooltip text. (Inherited from AbstractUserControl.)
Protected method	TrackViewState	Tracks the view state. (Inherited from InlineUserControl.)
Protected method	UnderlyingFormControl_Changed	Changed handler. (Inherited from FormEngineUserControl.)
Public method	ValidateMacroValue	Returns true if the given macro value is valid value for this control (Inherited from FormEngineUserControl.)

Extension Methods

	Name	Description
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	GetString	Gets the string by the specified resource key (Defined by ControlsExtensions.)

Events

	Name	Description
Public event	Changed	Fired on the change to the form control. (Inherited from FormEngineUserControl.)