LayoutTemplate Class

Represents layout based on a template.

Inheritance Hierarchy

System.Object
  CMS.FormEngine.Web.UI.AbstractLayout
    CMS.FormEngine.Web.UI.LayoutTemplate

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

Syntax

public class LayoutTemplate : AbstractLayout

The LayoutTemplate type exposes the following members.

Constructors

	Name	Description
Public method	LayoutTemplate	Constructor for the class.

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.)

Methods

	Name	Description
Protected method	AddControlToPanel	Adds control to form panel. (Inherited from AbstractLayout.)
Protected method	CollectFormElements	Collects form elements from the given container.
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	EnsureErrorLabels	Ensures the existence of the error labels for fields.
Protected method	GetFieldName	Gets the name for the given field.
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.)
Public method	LoadLayout	Loads the template layout for the form. (Overrides AbstractLayout.LoadLayout().)
Protected method	RegisterCategory	Registers BasicForm's form category.
Protected method	RegisterEditingFormControl	Registers EditingFormControl into BasicForm controls.
Protected method	RegisterErrorLabel	Registers error label for specified field in BasicForm.
Protected method	RegisterFormControl	Registers the given form control within the form.
Protected method	RegisterFormControlControl	Registers FormControl into BasicForm controls.
Protected method	RegisterFormEngineUserControl	Registers FormEngineUserControl into BasicForm controls.
Protected method	RegisterFormErrorMessageLabel	Registers message error label for whole form.
Protected method	RegisterFormFieldControl	Registers FormField into BasicForm controls.
Protected method	RegisterFormInfoMessageLabel	Registers message info label for whole form.
Protected method	RegisterLabel	Registers info label for specified control.
Protected method	RegisterSubmitButton	Registers BasicForm's submit button.

Events

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