LayoutForm Class

Represents custom user layout specified by text with macros.

Inheritance Hierarchy

System.Object
  CMS.FormControls.AbstractLayout
    CMS.FormControls.LayoutForm

Namespace: CMS.FormControls
Assembly: CMS.FormControls (in CMS.FormControls.dll) Version: 8.2.23

Syntax

public class LayoutForm : AbstractLayout

The LayoutForm type exposes the following members.

Constructors

	Name	Description
Public method	LayoutForm	Default constructor.

Methods

	Name	Description
Protected method	AddControlToPanel	Adds control to form panel. (Inherited from AbstractLayout.)
Protected method	AddFormElement	Adds control for the field according to specified type.
Protected method	AddNonMacroContent	Adds other content from form layout into the form.
Protected method	AddSubmitButton	Inserts submit button to form.
Protected method	CreateCollapsibleImage	Gets collapsible image. (Inherited from AbstractLayout.)
Protected method	CreateEditingFormControl	Creates new EditingFormControl and puts it into FieldEditingControls hash table. (Inherited from AbstractLayout.)
Protected method	CreateErrorLabel	Creates the validation label for a field. (Inherited from AbstractLayout.)
Protected method	CreateFieldActions	Creates additional field action buttons and puts them into FieldActionsControls dictionary. (Inherited from AbstractLayout.)
Protected method	CreateFieldLabel	Creates the field label. (Inherited from AbstractLayout.)
Protected method	CreateVisibilityControl	Creates the visibility control for a field. (Inherited from AbstractLayout.)
Protected method	ElementCanBeAdded	Indicates if element can be added into layout.
Protected method	GenerateMacroContent	Creates form content according to found macro.
Public method	IsCategoryCollapsed	Returns true if the given category is collapsed (Inherited from AbstractLayout.)
Protected method	IsExcludedRequiredField	Indicates if field is excluded from applying the required field format string. (Inherited from AbstractLayout.)
Protected method	LoadHiddenControls	Loads hidden controls from layout.
Public method	LoadLayout	Loads form layout (Overrides AbstractLayout.LoadLayout().)

Extension Methods

	Name	Description
Public Extension Method	AsValue	Converts object to a query value which can be used as a query parameter (Defined by QueryExtensions.)
Public Extension Method	GetAPIString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	ToBoolean	Returns the boolean representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDateTime	Returns the DateTime representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDouble	Returns the double representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToGuid	Returns the Guid representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToInteger	Returns the integer representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToString	Returns the string representation of an object or default value if not. (Defined by CoreExtensions.)

Fields

	Name	Description
Protected field	mCollapsibleImages	Dictionary of the collapsible images indexed by category name (Inherited from AbstractLayout.)

Properties

	Name	Description
Protected property	BasicForm	Form (Inherited from AbstractLayout.)
Public property	FormPanel	Main form panel (Inherited from AbstractLayout.)
Public property	RequiredMarkCssClass	Gets or sets CSS class for the required mark (*) (Inherited from AbstractLayout.)

Events

	Name	Description
Public event	OnAfterRegisterFormControl	Event representing control registration. (Inherited from AbstractLayout.)