Table of Contents

Class FormInfo

Namespace
CMS.FormEngine
Assembly
CMS.FormEngine.dll

Ensures management of XML file that represents the form definition.

public class FormInfo : DataDefinition, IStructuredData
Inheritance
object
FormInfo
Implements
Inherited Members
Extension Methods

Constructors

FormInfo()

Empty constructor

public FormInfo()

FormInfo(string)

Constructor, creates the form info structure and loads specified form definition.

public FormInfo(string formDefinition)

Parameters

formDefinition string

XML definition of the form

Methods

AddFormCategory(FormCategoryInfo, int)

Add a form category at the specified index or at the end if the index is not specified.

[Obsolete("Use AddFormItem(IDataDefinitionItem, int) instead.")]
public void AddFormCategory(FormCategoryInfo categObj, int index = -1)

Parameters

categObj FormCategoryInfo

FormCategoryInfo object with data to add

index int

Index to which to add the category

AddFormItem(IDataDefinitionItem, int)

Adds form item at the specified index or at the end if the index is not specified.

public void AddFormItem(IDataDefinitionItem formItem, int index = -1)

Parameters

formItem IDataDefinitionItem

Inserted form item

index int

Index of newly inserted item

Clone()

Clones the object.

public FormInfo Clone()

Returns

FormInfo

CombineWithForm(FormInfo, CombineWithFormSettings)

Combines the form with another form info.

public void CombineWithForm(FormInfo newForm, CombineWithFormSettings settings)

Parameters

newForm FormInfo

Form to include

settings CombineWithFormSettings

Combine settings

CombineWithForm(FormInfo, bool, string, bool, bool)

Combines the form with another form info.

[Obsolete("Method is deprecated and will be removed in the next version. Use CombineWithForm(FormInfo, CombineWithFormSettings) instead.")]
public void CombineWithForm(FormInfo newForm, bool overwriteExisting, string excludeColumns = null, bool includeCategories = false, bool preserveCategory = true)

Parameters

newForm FormInfo

Form to include

overwriteExisting bool

If true, existing fields from source form are overwritten by new form fields if their names match

excludeColumns string

Columns to exclude from form combining, separated by semicolon (;)

includeCategories bool

If true, categories from the new form will be added

preserveCategory bool

If false than even if overwriteExisting is false, field is moved to the current category (but the properties of the field are not overwritten)

EnsureDefaultValues(IDataContainer, FormResolveTypeEnum)

Ensures the default values into the data container.

[Obsolete("Method is deprecated and will be removed in the next version. Use LoadDefaultValues(IDataContainer, FormResolveTypeEnum, bool) instead.")]
public bool EnsureDefaultValues(IDataContainer container, FormResolveTypeEnum resolveType = FormResolveTypeEnum.None)

Parameters

container IDataContainer

Container to load

resolveType FormResolveTypeEnum

Type of macro resolving

Returns

bool

FieldExists(string)

Returns true if the given field exists in the form definition

public bool FieldExists(string fieldName)

Parameters

fieldName string

Field name to check

Returns

bool

GetCategoryNames()

Returns an List of category names.

public List<string> GetCategoryNames()

Returns

List<string>

GetColumnNames(bool, Func<FormFieldInfo, bool>)

Returns an List of field names.

public List<string> GetColumnNames(bool includeDummyFields = true, Func<FormFieldInfo, bool> order = null)

Parameters

includeDummyFields bool

Indicates if dummy fields should be included.

order Func<FormFieldInfo, bool>

Allows to order fields before names are returned.

Returns

List<string>

GetEmptyFormDocument()

Gets empty root FormInfo XML node.

public static XmlDocument GetEmptyFormDocument()

Returns

XmlDocument

GetFields(bool, bool, bool, bool, bool)

Returns an List of FormFieldInfo objects.

public List<FormFieldInfo> GetFields(bool visible, bool invisible, bool includeSystem = true, bool onlyPrimaryKeys = false, bool includeDummyFields = true)

Parameters

visible bool

Indicates whether object with visible set to 'True' should be returned

invisible bool

Indicates whether object with visible set to 'False' should be returned

includeSystem bool

Indicates whether also system fields are included

onlyPrimaryKeys bool

Indicates whether only primary keys should be returned

includeDummyFields bool

Indicates whether dummy fields are included

Returns

List<FormFieldInfo>

GetFields(string)

Returns the List of the FormFieldInfo objects.

public List<FormFieldInfo> GetFields(string fieldDataType)

Parameters

fieldDataType string

Form field data type

Returns

List<FormFieldInfo>

GetFormCategory(string)

Returns CategoryInfo object specified by category name.

public FormCategoryInfo GetFormCategory(string name)

Parameters

name string

Category name

Returns

FormCategoryInfo

GetFormElements(bool, bool, bool)

Returns the List of the form elements.

public List<IDataDefinitionItem> GetFormElements(bool visible, bool invisible, bool hideSystemFields = false)

Parameters

visible bool

Return visible fields

invisible bool

Return invisible fields

hideSystemFields bool

Return non-system fields only

Returns

List<IDataDefinitionItem>

GetFormField(Guid)

Returns field object with data from specified field.

public FormFieldInfo GetFormField(Guid guid)

Parameters

guid Guid

Form field guid

Returns

FormFieldInfo

Field or null if field does not exist

GetFormField(string)

Returns field object with data from specified field.

public FormFieldInfo GetFormField(string fieldName)

Parameters

fieldName string

Field to get data from

Returns

FormFieldInfo

Field or null if field does not exist

GetFormSchema(string)

Returns SchemaInfo object specified by schema name.

public FormSchemaInfo GetFormSchema(string schemaName)

Parameters

schemaName string

Schema name

Returns

FormSchemaInfo

Exceptions

ArgumentException

Thrown when schemaName is null or empty.

GetXmlDefinition()

Returns FormInfo definition in XML.

public string GetXmlDefinition()

Returns

string

GetXmlElement(XmlDocument)

Gets the XML element for the data

public override XmlElement GetXmlElement(XmlDocument doc)

Parameters

doc XmlDocument

Parent XML document

Returns

XmlElement

LoadDefaultValues(IDataContainer, FormResolveTypeEnum, bool)

Loads the default values into the data container.

public void LoadDefaultValues(IDataContainer container, FormResolveTypeEnum resolveType = FormResolveTypeEnum.None, bool onlyVisible = false)

Parameters

container IDataContainer

Container to load

resolveType FormResolveTypeEnum

Type of macro resolving

onlyVisible bool

If set True data are loaded for visible fields only; default value is False

LoadItem(XmlNode)

Loads the item from the XML node

protected override IDataDefinitionItem LoadItem(XmlNode node)

Parameters

node XmlNode

XML node

Returns

IDataDefinitionItem

MoveFormItem(int, int)

Moves form item in the form items collection from source index to destination index.

public void MoveFormItem(int sourceIndex, int destinationIndex)

Parameters

sourceIndex int

Index of the form item to be moved.

destinationIndex int

Index where to move the form item.

NewCategoryDefinition()

Creates a new category definition object.

protected virtual IDataDefinitionItem NewCategoryDefinition()

Returns

IDataDefinitionItem

NewFieldDefinition()

Creates a new field definition object.

protected override IDataDefinitionItem NewFieldDefinition()

Returns

IDataDefinitionItem

NewSchemaDefinition()

Creates a new schema definition object.

protected virtual IDataDefinitionItem NewSchemaDefinition()

Returns

IDataDefinitionItem

RemoveEmptyCategories()

Removes all categories from the form that do not contain any fields

public void RemoveEmptyCategories()

RemoveFields(Func<FormFieldInfo, bool>)

Removes fields matching the given condition

public bool RemoveFields(Func<FormFieldInfo, bool> condition)

Parameters

condition Func<FormFieldInfo, bool>

Field condition

Returns

bool

Returns true if at least one item was removed

RemoveFormCategory(string)

Remove specified form category.

public void RemoveFormCategory(string categoryName)

Parameters

categoryName string

Name of a category to remove

RemoveFormField(string)

Removes specified form field.

public bool RemoveFormField(string fieldName)

Parameters

fieldName string

Name of a field to remove

Returns

bool

True if successfully removed, false otherwise

RemoveFormSchema(string)

Remove specified form schema.

public void RemoveFormSchema(string schemaName)

Parameters

schemaName string

Name of a schema to remove.

Exceptions

ArgumentException

Thrown when schemaName is null or empty.

InvalidOperationException

Thrown when no schema with schemaName name was found.

UpdateFormCategory(string, FormCategoryInfo)

Update specified category node.

public void UpdateFormCategory(string categoryName, FormCategoryInfo fci)

Parameters

categoryName string

Name of category to update

fci FormCategoryInfo

FormCategoryInfo object with data for update

UpdateFormField(string, FormFieldInfo)

Update specified field node.

public void UpdateFormField(string fieldName, FormFieldInfo field)

Parameters

fieldName string

Name of a field to update

field FormFieldInfo

Data for update

Exceptions

ArgumentOutOfRangeException

Field fieldName does not exist

UpdateFormSchema(string, FormSchemaInfo)

Update specified schema node.

public void UpdateFormSchema(string schemaName, FormSchemaInfo formSchemaInfo)

Parameters

schemaName string

Name of schema to update.

formSchemaInfo FormSchemaInfo

FormSchemaInfo object with data for update.

Exceptions

ArgumentException

Thrown when schemaName is null or empty.

ArgumentNullException

Thrown when formSchemaInfo is null.

InvalidOperationException

Thrown when no schema with schemaName name was found.