FormHelper Class

Class providing form helper methods.

Inheritance Hierarchy

System.Object
  CMS.FormEngine.FormHelper

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

Syntax

public static class FormHelper

The FormHelper type exposes the following members.

Fields

	Name	Description
Public field Static member	CORE	Constant used to determine form field info which doesn't contain before/after definition of system field.
Public field Static member	FORM_PREFIX	Resolver name prefix for forms/classes - 'form.'
Public field Static member	FORMDEFINITION_PREFIX	Resolver name prefix for other objects with form definition - 'formdefinition.'

Methods

	Name	Description
Public method Static member	AddFieldMacroRules	Adds macro rules values to given XmlNode.
Public method Static member	AddLatestVersionAttribute	Adds version attribute with latest version as value to xmlNode.
Public method Static member	BizFormFilesFolder	Gets custom on-line form file folder path.
Public method Static member	ClearFormControlParameters	Clears cached form control parameters.
Public method Static member	ClearFormInfos	Clears cached FormInfo objects.
Public method Static member	ColumnExistsInView	Checks if column name is unique in system tables which are joined with given table into view.
Public method Static member	CombineFormDefinitions	Combines two form definitions together. Fields from second definition are added at the end of first definition.
Public method Static member	ConvertValidationFromAttributesToRules	Converts validation from field attributes to macro rules.
Public method Static member	EnsureDefaultCategory	Ensures category at the beginning of the form definition.
Public method Static member	EnsureDefaultValues	Ensures the default class values to the Data container for required fields (not allowing empty value) without a value.
Public method Static member	GetAvailableControlTypes	Returns DataSet with available form control types for specified column data type and field editor controls.
Public method Static member	GetBasicFormDefinition	Returns basic form definition of the table with primary key only.
Public method Static member	GetBizFormFilesFolderPath	Returns BizForm files folder physical path according to 'CMSBizFormFilesFolder' settings key.
Public method Static member	GetBizFormTempFilesFolderPath	Gets BizForm temporary files folder physical path based on GetTempFilesRootFolderPath(String).
Public method Static member	GetDataTypeColumn	Returns column name of FormUserControlInfo class for given data type.
Public method Static member	GetDataTypeColumnForGroup	Returns column name of FormUserControlInfo class for given data type group.
Public method Static member	GetDataTypeWhereCondition	Gets the where condition for Form controls for the given data type
Public method Static member	GetDateTimeValueInSystemCulture	Gets date-time value in system (en) culture format.
Public method Static member	GetDateValueInSystemCulture	Gets date value in system (en) culture format.
Public method Static member	GetDecimalValueInSystemCulture	Gets decimal value in system (en) culture format.
Public method Static member	GetDoubleValueInSystemCulture	Gets double value in system (en) culture format.
Public method Static member	GetFieldControlTypesWithUserControls	Returns dataset with control types and user controls.
Public method Static member	GetFilePhysicalPath	Gets path to the file in file system.
Public method Static member	GetFormControlParameters	Returns cached form control parameters.
Public method Static member	GetFormControlSettingsFromXML	Gets FormFieldInfo with initialized settings (Settings and SettingMacroTable properties) from specified XML representation.
Public method Static member	GetFormControlSettingsXml	Gets settings XML representation from specified FormFieldInfo.
Public method Static member	GetFormDefinitionDifference	Returns XML differences between original and alternative form definitions (i.e. returns only fields that differs from each other)
Public method Static member	GetFormFieldControlType	Converts string to FormFieldControlType.
Public method Static member	GetFormFieldControlTypeString	Converts FormFieldControlType to string.
Public method Static member	GetFormFieldDataType	Returns form field data type from input table column data.
Public method Static member	GetFormFieldDefaultControlType(String, FieldEditorControlsEnum)	Returns default form field control type according to the form field data type. If the control type of the configured control is not allowed, returns null.
Public method Static member	GetFormFieldDefaultControlType(String, Boolean)	Returns default form field control type according to the form field data type.
Public method Static member	GetFormFieldInfo	Returns initialized FormFieldInfo structure according to the specified table column schema.
Public method Static member	GetFormFieldsWithDefaultValue	Returns "alternative form fields definition" containing only specified attribute and value for all fields E.g. Set visible false for all fields in alt. form.
Public method Static member	GetFormInfo	Returns FormInfo object for specified class name or alternative name. Method loops through supplied class list and returns first object existing. If alternative name is specified then it is merged with default class and then returned If coupled class exists for given alternative form then it is merged as well. If alternative form info not found then its default class is returned. You can also merge two forms in the result by using the + operator between names, such as "customtable.sampletable.filter+customtable.sampletable.extra"
Public method Static member	GetFormUserControlsForDataType	Returns DataSet with FormUserControlInfo objects that supports specified data type.
Public method Static member	GetFullFileName	Returns full file name ([name.extension] if extension is specified) or ([name] only if extension is not specified).
Public method Static member	GetGuidFileName	Returns file name in format [guid].[extension].
Public method Static member	GetInheritedCategories	Gets the table of the categories that are inherited.
Public method Static member	GetInheritedFields	Gets the table of the fields that are inherited
Public method Static member	GetOriginalFileName	Returns file name in format [OriginalFileName].[extension].
Public method Static member	GetPropertyMacroTransformation	Returns a transformation action. If given macro table contains key passed to the action (second action parameter), it replaces current value (third action parameter) in the element passed to the action (first action parameter) and adds "ismacro" attribute to the element.
Public method Static member	GetValidationRuleName	Returns validation rule name.
Public method Static member	GetValidationRuleParameter	Returns value of parameter with given name.
Public method Static member	GetWhereConditionForDataType	Gets WHERE condition to select controls for given data type and control type (on-line forms, page types, etc).
Public method Static member	HasFileUploadControl	Returns if field's control is of file type.
Public method Static member	HasListControl	Returns true if field uses list control (DropDownList, RadioButtonsList, ...)
Public method Static member	HideFieldInAlternativeForms	Hides given field in alternative forms belonging to given class if hiding new fields is enabled.
Public method Static member	IsFieldOfType	Returns true if FormFieldInfo is of specified type.
Public method Static member	IsValidControl	Determines whether given control is valid for given controls enum.
Public method Static member	LoadDefaultValues	Loads the default class values to the Data container.
Public method Static member	MergeFormDefinitions	Merges original and alternative form definitions and returns the result.
Public method Static member	MergeVisibility	Merges original FormInfo and alternative FormInfos and returns the resulting FormInfo.
Public method Static member	RemoveCategoryFromAlternativeDefinition	Removes category from alternative definition and keeps order of other items.
Public method Static member	RemoveFieldFromAlternativeDefinition	Removes field from alternative definition and keeps order of other items.
Public method Static member	RemoveFieldFromAlternativeForms	Removes field from alternative forms belonging to given class.
Public method Static member	RemoveInheritance	Removes the inheritance from the given class.
Public method Static member	RemoveInheritedFields	Removes the inherited fields from the given form info.
Public method Static member	RenameFieldInAlternativeFormLayout	Changes field name in alternative form layout definition.
Public method Static member	RenameFieldInFormLayout	Changes field name in form layout definition.
Public method Static member	UpdateInheritedClass	Updates the class inherited from the given class.
Public method Static member	UpdateInheritedClasses	Updates the classes inherited from the given class.
Public method Static member	UseSiteSpecificCustomFolder	Indicates if site specific custom folder should be used for storing on-line form files.