AbstractDefaultLayout Class

Default layout

Inheritance Hierarchy

System.Object
  CMS.FormEngine.Web.UI.AbstractLayout
    CMS.FormEngine.Web.UI.AbstractDefaultLayout
      CMS.FormEngine.Web.UI.AbstractTableDefaultLayout
      CMS.FormEngine.Web.UI.DivDefaultLayout

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

Syntax

public abstract class AbstractDefaultLayout : AbstractLayout

The AbstractDefaultLayout type exposes the following members.

Constructors

	Name	Description
Protected method	AbstractDefaultLayout	Constructor for the class.

Fields

	Name	Description
Protected field	categories	Stores initiated categories(with translated captions).
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.)
Protected property	CategoryListPanel	Category list panel, may be displayed above formPanel.
Protected property	FormElements	Gets visible form elements.
Public property	FormPanel	Main form panel (Inherited from AbstractLayout.)
Public property	RequiredMarkCssClass	Gets or sets CSS class for the required mark (*) (Inherited from AbstractLayout.)
Protected property	TotalColumns	Indicates number of form columns.

Methods

	Name	Description
Protected method	AddControlToPanel	Adds control to form panel. (Inherited from AbstractLayout.)
Protected method	CreateCategory	Renders whole category (iterates through fields and renders them).
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	CreateField	Creates the field.
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	CreateInvisibleField	Creates invisible field with default value if field is not public and it is not allowed to be empty.
Protected method	CreateVisibilityControl	Creates the visibility control for a field. (Inherited from AbstractLayout.)
Protected method	GetAnchorID	Gets identifier for anchor element.
Protected method	GetLiteralForLayoutWithTitle	Return literal control initialized with text that will be part of the form's layout and contain title attribute based on field's description.
Protected method	GetLocalizedCategoryCaption	Returns caption from category info or default category name from parent BasicForm with resolved macros (data and/or localization).
Protected method	GetRowCssClassAttribute	Gets row CSS class attribute for form field
Protected method	GetSubmitButton	Adds the submit button to the form.
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	Load	Loads layout based on specific type.
Public method	LoadLayout	Loads the default form layout from the given form information. (Overrides AbstractLayout.LoadLayout().)
Protected method	RegisterButtonPanel	Creates submit panel.
Protected method	RegisterScripts	Registers necessary JavaScripts.

Events

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