| FormHelper Methods |
The FormHelper type exposes the following members.
Methods| Name | Description | |
|---|---|---|
  | AddFieldMacroRules |
Adds macro rules values to given XmlNode.
|
| AddLatestVersionAttribute |
Adds version attribute with latest version as value to xmlNode.
|
| BizFormFilesFolder |
Gets custom bizform file folder path.
|
| Clear |
Clears all cached objects.
|
| ClearFormControlParameters |
Clears cached form control parameters.
|
| ClearFormInfos |
Clears cached FormInfo objects.
|
| ColumnExistsInView |
Checks if column name is unique in system tables which are joined with given table into view.
|
| CombineFormDefinitions |
Combines two form definitions together. Fields from second definition are added at the end of first definition.
|
| ConvertValidationFromAttributesToRules |
Converts validation from field attributes to macro rules.
|
| EnsureDefaultCategory |
Ensures category at the beginning of the form definition.
|
| EnsureDefaultValues |
Ensures the default class values to the Data container for required fields (not allowing empty value) without a value.
|
| EnsureFormDefinitionFormat |
Ensures form definition format for backward compatibility
|
| GetAlternativeFormsWhere |
Returns where condition allowing to select alternative forms belonging to given class.
|
| GetAvailableControlTypes |
Returns DataSet with available form control types for specified column data type and field editor controls.
|
| GetBasicFormDefinition |
Returns basic form definition of the table with primary key only.
|
| GetBizFormFilesFolderPath |
Returns BizForm files folder physical path according to 'CMSBizFormFilesFolder' settings key.
|
| GetDataTypeColumn |
Returns column name of FormUserControlInfo class for given data type.
|
| GetDataTypeWhereCondition |
Gets the where condition for Form controls for the given data type
|
| GetDateTimeValueInDBCulture | Obsolete.
Gets datetime value in system (en) culture format.
|
| GetDateTimeValueInSystemCulture |
Gets datetime value in system (en) culture format.
|
| GetDateValueInSystemCulture |
Gets date value in system (en) culture format.
|
| GetDoubleValueInDBCulture | Obsolete.
Gets double value in system (en) culture format.
|
| GetDoubleValueInSystemCulture |
Gets double value in system (en) culture format.
|
| GetFieldControlTypesWithUserControls |
Returns dataset with control types and user controls.
|
| GetFieldTypes |
Returns dataset with all field types.
|
| GetFilePhysicalPath |
Gets path to the file in file system.
|
| GetFormControlParameters |
Returns cached form control parameters.
|
| GetFormControlSettingsFromXML |
Gets FormFieldInfo with initialized settings (Settings and SettingMacroTable properties) from specified XML representation.
|
| GetFormControlSettingsXml |
Gets settings XML representation from specified FormFieldInfo.
|
| GetFormDefinitionDifference |
Returns XML differences between original and alternative form definitions
(i.e. returns only fields that differs from each other)
|
| GetFormFieldControlType |
Converts string to FormFieldControlType.
|
| GetFormFieldControlTypeString |
Converts FormFieldControlType to string.
|
| GetFormFieldDataType |
Returns form field data type from input table column data.
|
| GetFormFieldDefaultControlType(String) |
Returns default form field control type according to the form field data type.
|
| GetFormFieldDefaultControlType(String, Boolean) |
Returns default form field control type according to the form field data type.
|
| GetFormFieldInfo |
Returns initialized FormFieldInfo structure according to the specified table column schema.
|
| 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.
|
| 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"
|
| GetFormUserControlsForDataType |
Returns DataSet with FormUserControlInfo objects that supports specified datatype.
|
| GetFullFileName |
Returns full file name ([name.extension] if extension is specified) or ([name] only if extension is not specified).
|
| GetGuidFileName |
Returns file name in format [guid].[extension].
|
| GetInheritedCategories |
Gets the table of the categories that are inherited.
|
| GetInheritedFields |
Gets the table of the fields that are inherited
|
| GetOriginalFileName |
Returns file name in format [OriginalFileName].[extension].
|
| GetSelectedValuesFromListItemCollection |
Returns string with selected values (e.g.: "value1|value2|value3").
|
| GetValidationRuleName |
Returns validation rule name.
|
| GetValidationRuleParameter |
Returns value of parameter with given name.
|
| GetWhereConditionForDataType |
Gets WHERE condition to select controls for given data type and control type (bizforms, document types, etc).
|
| GetXmlFormDefinitionFromXmlSchema |
Returns xml form definition from input xml schema.
|
| HasFileUploadControl |
Returns if field's control is of file type.
|
| HasListControl |
Returns true if field uses list control (DropDownList, RadioButtonsList, ...)
|
| HideFieldInAlternativeForms |
Hides given field in alternative forms belonging to given class if hiding new fields is enabled.
|
| InitTable |
Initializes given dictionary.
|
| IsFieldOfType |
Returns true if FormFieldInfo is of specified type.
|
| IsValidControl |
Determines whether given control is valid for given controls enum.
|
| LoadDefaultValues |
Loads the default class values to the Data container.
|
| LoadItemsIntoList |
Loads items into list type of control.
|
| MergeFormDefinitions |
Merges original and alternative form definitions and returns the result.
|
| MergeVisibility |
Merges original FormInfo and alternative FormInfos and returns the resulting FormInfo.
|
| RemoveCategoryFromAlternativeDefinition |
Removes category from alternative definition and keeps order of other items.
|
| RemoveFieldFromAlternativeDefinition |
Removes field from alternative definition and keeps order of other items.
|
| RemoveFieldFromAlternativeForms |
Removes field from alternative forms belonging to given class.
|
| RemoveInheritance |
Removes the inheritance from the given class.
|
| RemoveInheritedFields |
Removes the inherited fields from the given form info.
|
| RenameFieldInAlternativeFormLayout |
Changes field name in alternative form layout definition.
|
| RenameFieldInFormLayout |
Changes field name in form layout definition.
|
| SelectMultipleValues |
Selects multiple values in control.
|
| SelectSingleValue |
Selects single value in control of type ListControl.
|
| UpdateInheritedClass |
Updates the class inherited from the given class.
|
| UpdateInheritedClasses |
Updates the classes inherited from the given class.
|
| UseSiteSpecificCustomFolder |
Indicates if site specific custom folder should be used for storing bizform files.
|
See Also