FormInfo Class

Ensures management of XML file that represents the form definition.

Inheritance Hierarchy

System.Object
  CMS.DataEngine.DataDefinition
    CMS.FormEngine.FormInfo

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

Syntax

[SerializableAttribute]
public class FormInfo : DataDefinition

The FormInfo type exposes the following members.

Constructors

	Name	Description
Public method	FormInfo()	Empty constructor
Public method	FormInfo(String)	Constructor, creates the form info structure and loads specified form definition.

Fields

	Name	Description
Public field Static member	ATTRIBUTE_VERSION	Name of attribute version used in XML documents.
Public field Static member	DISPLAY_CONTEXT_DASHBOARD	Dashboard display context.

Properties

	Name	Description
Public property	ContextResolver	Context macro resolver.
Public property	FormName	Gets or sets FormInfo name.
Public property	ItemsList	Returns list of all FormItems. (Inherited from DataDefinition.)

Methods

	Name	Description
Public method	AddFormCategory	Add a form category at the specified index or at the end if the index is not specified.
Public method	AddFormItem	Adds form item at the specified index or at the end if the index is not specified.
Public method	Clone	Clones the object.
Public method	CombineWithForm(FormInfo, CombineWithFormSettings)	Combines the form with another form info.
Public method	CombineWithForm(FormInfo, Boolean, String, Boolean, Boolean)	Combines the form with another form info.
Public method	CreateDataContainer	Creates data container based on this form definition
Public method	EnsureDefaultValues	Ensures the default values into the data container.
Public method	FieldExists	Returns true if the given field exists in the form definition
Public method	GetCategoryNames	Returns an List of category names.
Public method	GetClosestCategory	Returns closest category the field is placed under or null if there is no category above the field.
Public method	GetColumnNames	Returns an List of field names.
Public method	GetDataRow	Returns empty data row with column names and types.
Public method Static member	GetEmptyFormDocument	Gets empty root FormInfo XML node.
Public method	GetFields(String)	Returns the List of the FormFieldInfo objects.
Public method	GetFields(FormFieldControlTypeEnum)	Returns the List of the FormFieldInfo objects.
Public method	GetFields(Boolean, Boolean, Boolean, Boolean, Boolean)	Returns an List of FormFieldInfo objects.
Public method	GetFields<ItemType>()	Gets the field of the given type (Inherited from DataDefinition.)
Public method	GetFormCategory	Returns CategoryInfo object specified by category name.
Public method	GetFormElements	Returns the List of the form elements.
Public method	GetFormField(Guid)	Returns field object with data from specified field.
Public method	GetFormField(String)	Returns field object with data from specified field.
Public method	GetHierarchicalFormElements	Returns hierarchical dictionary of items. Each category contains list of its fields. First fields without category are added to empty category.
Public method	GetUniqueFieldName	Gets a unique field name based on the existing field names in the form
Public method	GetVisibilityElement	Returns FromInfo definition in XML used only for FormVisibilityInfo with limited FormFieldInfo attributes.
Public method	GetXmlDefinition	Returns FormInfo definition in XML.
Public method	GetXmlElement	Gets the XML element for the data (Overrides DataDefinition.GetXmlElement(XmlDocument).)
Public method	LoadDefaultValues(DataRow, Boolean)	Loads the default values into the DataRow.
Public method	LoadDefaultValues(DataRow, FormResolveTypeEnum, Boolean)	Loads the default values into the DataRow.
Public method	LoadDefaultValues(DataRow, String, Boolean)	Loads the default values into the DataRow.
Public method	LoadDefaultValues(IDataContainer, FormResolveTypeEnum, Boolean)	Loads the default values into the data container.
Protected method	LoadField	Loads the field from the XML node (Overrides DataDefinition.LoadField(XmlNode).)
Public method	LoadFromDataStructure	Loads the data definition from structure of a database table (Inherited from DataDefinition.)
Public method	LoadFromDefinition	Loads the data definition from XML file (Inherited from DataDefinition.)
Public method	LoadFromXmlElement	Loads the definition from the XML node (Overrides DataDefinition.LoadFromXmlElement(XmlElement).)
Protected method	LoadItem	Loads the item from the XML node (Overrides DataDefinition.LoadItem(XmlNode).)
Public method	MoveFormCategoryDown	Moves specified form category down.
Public method	MoveFormCategoryUp	Moves specified form category up.
Public method	MoveFormFieldDown	Moves specified form field down.
Public method	MoveFormFieldToPositionInCategory	Moves specified form field to specified position in category. If category isn't specified, than field is moved to default category.
Public method	MoveFormFieldUp	Moves specified form field up.
Protected method	NewCategoryDefinition	Creates a new category definition object
Protected method	NewFieldDefinition	Creates a new field definition object (Overrides DataDefinition.NewFieldDefinition().)
Public method	RemoveEmptyCategories	Removes all categories from the form that do not contain any fields
Public method	RemoveFields	Removes fields matching the given condition
Public method	RemoveFormCategory	Remove specified form category.
Public method	RemoveFormField	Removes specified form field.
Public method	UpdateExistingFields	Updates the existing fields from the FormInfo definition.
Public method	UpdateFormCategory	Update specified category node.
Public method	UpdateFormField	Update specified field node.
Public method	UsesHtmlArea	Returns true, if the form uses one or more visible HTML area fields.

Extension Methods

	Name	Description
Public Extension Method	ContainsSmartField	Returns true when given formInfo contains at least one field defined as smart one. (Defined by FormFieldInfoExtensions.)