Click or drag to resize
FormInfo Class
Ensures management of XML file that represents the form definition.
Inheritance Hierarchy

Namespace: CMS.FormEngine
Assembly: CMS.FormEngine (in CMS.FormEngine.dll) Version: 8.2.23
Syntax
C#
[SerializableAttribute]
public class FormInfo : DataDefinition

The FormInfo type exposes the following members.

Constructors
  NameDescription
Public methodFormInfo
Constructor, creates the form info structure and loads specified form definition.
Top
Methods
  NameDescription
Public methodAddFormCategory
Add a form category at the specified index or at the end if the index is not specified.
Public methodAddFormItem
Adds form item at the specified index or at the end if the index is not specified.
Public methodClone
Clones the object.
Public methodCombineWithForm(FormInfo, CombineWithFormSettings)
Combines the form with another form info.
Public methodCombineWithForm(FormInfo, Boolean, String, Boolean, Boolean)
Combines the form with another form info.
Public methodCreateDataContainer
Creates data container based on this form definition
Public methodEnsureDefaultValues
Ensures the default values into the data container.
Public methodFieldExists
Returns true if the given field exists in the form definition
Public methodGetCategoryNames
Returns an List of category names.
Public methodGetColumnNames
Returns an List of field names.
Public methodGetDataRow(Boolean)
Returns empty data row with column names and types.
Public methodGetDataRow(Boolean, String) Obsolete.
Returns empty data row with column names and types.
Public methodStatic memberGetEmptyFormDocument
Gets empty root FormInfo XML node.
Public methodGetFields(String)
Returns the List of the FormFieldInfo objects.
Public methodGetFields(FormFieldControlTypeEnum)
Returns the List of the FormFieldInfo objects.
Public methodGetFields(Boolean, Boolean, Boolean, Boolean, Boolean)
Returns an List of FormFieldInfo objects.
Public methodGetFieldsItemType
Gets the field of the given type
(Inherited from DataDefinition.)
Public methodGetFormCategory
Returns CategoryInfo object specified by category name.
Public methodGetFormElements
Returns the List of the form elements.
Public methodGetFormField
Returns field object with data from specified field.
Public methodGetHierarchicalFormElements
Returns hierarchical dictionary of items. Each category contains list of its fields. First fields without category are added to empty category.
Public methodGetUniqueFieldName
Gets a unique field name based on the existing field names in the form
Public methodGetVisibilityXML
Returns FromInfo definition in XML used only for FormVisibilityInfo with limited FormFieldInfo attributes.
Public methodGetXmlDefinition
Returns FormInfo definition in XML.
Public methodLoadDefaultValues(DataRow, Boolean)
Loads the default values into the DataRow.
Public methodLoadDefaultValues(DataRow, FormResolveTypeEnum, Boolean)
Loads the default values into the DataRow.
Public methodLoadDefaultValues(DataRow, String, Boolean)
Loads the default values into the DataRow.
Public methodLoadDefaultValues(IDataContainer, FormResolveTypeEnum, Boolean)
Loads the default values into the data container.
Protected methodLoadField
Loads the field from the XML node
(Overrides DataDefinitionLoadField(XmlNode).)
Protected methodLoadFromXml(String)
Loads the data definition from XML file
(Inherited from DataDefinition.)
Protected methodLoadFromXml(XmlDocument)
Loads the definition from the XML document
(Overrides DataDefinitionLoadFromXml(XmlDocument).)
Protected methodLoadItem
Loads the item from the XML node
(Overrides DataDefinitionLoadItem(XmlNode).)
Public methodMoveFormCategoryDown
Moves specified form category down.
Public methodMoveFormCategoryUp
Moves specified form category up.
Public methodMoveFormFieldDown
Moves specified form field down.
Public methodMoveFormFieldToPositionInCategory
Moves specified form field to specified position in category. If category isn't specified, than field is moved to default category.
Public methodMoveFormFieldUp
Moves specified form field up.
Protected methodNewCategoryDefinition
Creates a new category definition object
Protected methodNewFieldDefinition
Creates a new field definition object
(Overrides DataDefinitionNewFieldDefinition.)
Public methodRemoveEmptyCategories
Removes all categories from the form that do not contain any fields
Public methodRemoveFields
Remove fields matching the given condition
Public methodRemoveFormCategory
Remove specified form category.
Public methodRemoveFormField
Remove specified form field.
Public methodUpdateExistingFields
Updates the existing fields from the FormInfo definition.
Public methodUpdateFormCategory
Update specified category node.
Public methodUpdateFormField
Update specified field node.
Public methodUsesHtmlArea
Returns true, if the form uses one or more visible HTML area fields.
Top
Extension Methods
  NameDescription
Public Extension MethodAsValue
Converts object to a query value which can be used as a query parameter
(Defined by QueryExtensions.)
Public Extension MethodGetAPIString
Gets the string by the specified resource key
(Defined by CoreExtensions.)
Public Extension MethodGetString
Gets the string by the specified resource key
(Defined by CoreExtensions.)
Public Extension MethodToBoolean
Returns the boolean representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToDateTime
Returns the DateTime representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToDouble
Returns the double representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToGuid
Returns the Guid representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToInteger
Returns the integer representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToString
Returns the string representation of an object or default value if not.
(Defined by CoreExtensions.)
Top
Fields
  NameDescription
Public fieldStatic memberATTRIBUTE_VERSION
Name of attribute version used in XML documents.
Public fieldStatic memberDISPLAY_CONTEXT_DASHBOARD
Dashboard display context.
Top
Properties
  NameDescription
Public propertyContextResolver
Context macro resolver.
Public propertyFormName
Gets or sets FormInfo name.
Public propertyItemsList
Returns list of all FormItems.
(Inherited from DataDefinition.)
Top
See Also