Class BaseDataClassFieldsManager

Namespace

CMS.FormEngine

Assembly

CMS.FormEngine.dll

The class represents the default implementation of IDataClassFieldsManager.

public class BaseDataClassFieldsManager : AbstractFieldManager, IDataClassFieldsManager

Inheritance

object

AbstractFieldManager

BaseDataClassFieldsManager

Implements

IDataClassFieldsManager

Extension Methods

DataExtensions.With<T>(T, Action<T>)

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

Constructors

BaseDataClassFieldsManager()

public BaseDataClassFieldsManager()

Methods

ConfigureDataClass(string, DataClassInfo, FormFieldInfo)

Allows to configure given dataClass based on field.

protected virtual void ConfigureDataClass(string fieldName, DataClassInfo dataClass, FormFieldInfo field)

Parameters

fieldName string

dataClass DataClassInfo

field FormFieldInfo

CreateField(string, FormFieldInfo)

Tries to create a new field with data from formField.

public FieldValidationResult CreateField(string className, FormFieldInfo formField)

Parameters

className string

Class name or alternative form name of the form the field belongs to.

formField FormFieldInfo

Field containing the data of the new field.

Returns

FieldValidationResult

Instance of FieldValidationResult, if the validation result is valid, new field was created. Otherwise it was not and validation result indicates why.

Exceptions

ArgumentNullException

No field definition was provided.

InvalidOperationException

The corresponding data class was not found.

CreateFormDefinition(DataClassInfo, FormInfo, FormFieldInfo)

Creates a new field specified by newField in the form provided to it by form and updates the database accordingly.

protected virtual void CreateFormDefinition(DataClassInfo dataClass, FormInfo form, FormFieldInfo newField)

Parameters

dataClass DataClassInfo

Data class info of the edited data class.

form FormInfo

Form info that has a new field inserted.

newField FormFieldInfo

Model containing field data.

DeleteField(string, string)

Tries to delete a field specified by fieldName

public FieldValidationResult DeleteField(string className, string fieldName)

Parameters

className string

Class name or alternative form name of the form the field belongs to.

fieldName string

Name of the field to be deleted.

Returns

FieldValidationResult

Instance of FieldValidationResult if the validation result is valid and the field was deleted. Otherwise, it is not deleted and the validation result indicates why.

Exceptions

InvalidOperationException

The corresponding data class was not found.

DeleteFieldFromDefinition(DataClassInfo, FormInfo, string)

Deletes the field specified by fieldName from the form given by form and from the database.

protected virtual void DeleteFieldFromDefinition(DataClassInfo dataClass, FormInfo form, string fieldName)

Parameters

dataClass DataClassInfo

Data class info of the edited data class.

form FormInfo

Form info containing deleted field.

fieldName string

Deleted field name.

MoveField(string, int, int)

public void MoveField(string className, int sourceIndex, int destinationIndex)

Parameters

className string

sourceIndex int

destinationIndex int

UpdateAlternativeForms(DataClassInfo)

Update all alternative forms connected to given dataClass.

protected virtual void UpdateAlternativeForms(DataClassInfo dataClass)

Parameters

dataClass DataClassInfo

Data class info object with updated form definition.

Remarks

Coupled class for each alternative form is handled as well.

UpdateField(string, string, FormFieldInfo)

Tries to update a field given by fieldName with data from formField.

public FieldValidationResult UpdateField(string className, string fieldName, FormFieldInfo formField)

Parameters

className string

Class name or alternative form name of the form the field belongs to.

fieldName string

Name of a field that is being updated.

formField FormFieldInfo

Field which contains updated data.

Returns

FieldValidationResult

Instance of FieldValidationResult, if the validation result is valid, update was performed. Otherwise it was not and validation result indicates why.

Exceptions

ArgumentNullException

No field definition provided.

InvalidOperationException

Unknown className or fieldName provided.

UpdateFormDefinition(DataClassInfo, FormInfo)

Updates a form definition of the dataClass using the data from formInfo and alters database table structure appropriately.

protected virtual void UpdateFormDefinition(DataClassInfo dataClass, FormInfo formInfo)

Parameters

dataClass DataClassInfo

Edited data class info.

formInfo FormInfo

Form info that updates the form definition.

UpdateFormDefinition(DataClassInfo, FormInfo, string, FormFieldInfo)

Updates a form definition of given editedFieldName using the data from newFormFieldInfo and alters database table structure appropriately.

protected virtual void UpdateFormDefinition(DataClassInfo dataClass, FormInfo form, string editedFieldName, FormFieldInfo newFormFieldInfo)

Parameters

dataClass DataClassInfo

Edited data class info.

form FormInfo

Form info to be updated.

editedFieldName string

Edited field name.

newFormFieldInfo FormFieldInfo

New form field info.