Table of Contents

Class FormFieldInfo

Namespace
CMS.FormEngine
Assembly
CMS.FormEngine.dll

Represents form field definition.

public class FormFieldInfo : FieldBase<FormFieldInfo>, IDataContainer, ISimpleDataContainer, IField, IDataDefinitionItem
Inheritance
object
FormFieldInfo
Implements
Inherited Members
Extension Methods

Properties

AdditionalActionConfigurationsXmlData

Gets or sets the XML data describing additional actions.

public string AdditionalActionConfigurationsXmlData { get; set; }

Property Value

string

Enabled

Indicates whether field is Enabled.

public bool Enabled { get; set; }

Property Value

bool

MappedToField

Indicates field to which this one is mapped.

public string MappedToField { get; set; }

Property Value

string

Resolver

Fields macro resolver. It is null by default, has to be assigned prior to its use.

public MacroResolver Resolver { get; set; }

Property Value

MacroResolver

Settings

Setting of the field form control [name] -> [value]

public Hashtable Settings { get; set; }

Property Value

Hashtable

SettingsMacroTable

Macro table for the settings of the field form control

public Hashtable SettingsMacroTable { get; set; }

Property Value

Hashtable

ValidationRuleConfigurationsXmlData

Gets or sets the XML data describing validation rules.

public string ValidationRuleConfigurationsXmlData { get; set; }

Property Value

string

VisibilityConditionConfigurationXmlData

Gets or sets the XML data describing visibility condition.

public string VisibilityConditionConfigurationXmlData { get; set; }

Property Value

string

Visible

Indicates whether field is visible.

public bool Visible { get; set; }

Property Value

bool

Methods

Clone()

Clones the object.

public override IDataDefinitionItem Clone()

Returns

IDataDefinitionItem

Returns clone of FormFieldInfo

GetComponentName()

Returns name of form component used for rendering this form field.

public string GetComponentName()

Returns

string

Name of form component or null if form field settings contains no component name.

GetDefaultValue(FormResolveTypeEnum, IMacroResolver)

Returns resolved default value based on resolver type and field's setting (GetResolveDefaultValue(bool)).

public string GetDefaultValue(FormResolveTypeEnum resolveType, IMacroResolver macroResolver)

Parameters

resolveType FormResolveTypeEnum

Resolver type

macroResolver IMacroResolver

Macro resolver

Returns

string

GetDisplayName(IMacroResolver)

Returns string that represents human readable form of field name. Tries to resolve field's caption. Field name is returned in case of invalid macro or empty caption.

public string GetDisplayName(IMacroResolver macroResolver)

Parameters

macroResolver IMacroResolver

Macro resolver used to resolve caption, can be null

Returns

string

GetPropertyValue(FormFieldPropertyEnum)

Gets unresolved property value.

public string GetPropertyValue(FormFieldPropertyEnum property)

Parameters

property FormFieldPropertyEnum

Property

Returns

string

GetPropertyValue(FormFieldPropertyEnum, IMacroResolver, MacroSettings, bool)

Gets resolved property value.

public string GetPropertyValue(FormFieldPropertyEnum property, IMacroResolver resolver, MacroSettings macroSettings = null, bool resolveAllMacros = false)

Parameters

property FormFieldPropertyEnum

Property

resolver IMacroResolver

Macro resolver

macroSettings MacroSettings

Macro context

resolveAllMacros bool

Indicates if text values which contain macro expressions should be resolved too, default value is false - only macro values are resolved

Returns

string

GetPropertyValue(FormFieldPropertyEnum, out bool)

Gets unresolved property value.

public string GetPropertyValue(FormFieldPropertyEnum property, out bool isMacro)

Parameters

property FormFieldPropertyEnum

Property

isMacro bool

Returns true if property contains macro

Returns

string

GetResolveDefaultValue(bool)

Returns if resolving of macros in the field's default value is enabled as far as that setting is specified, otherwise given default value is returned.

[Obsolete("Method is deprecated and will be removed in the next version.")]
[ObsoleteSince(28, 0)]
public bool GetResolveDefaultValue(bool defaultValue)

Parameters

defaultValue bool

This value is returned if 'resolve default value' setting is not set

Returns

bool

GetTypedDefaultValue(FormResolveTypeEnum, IMacroResolver, bool)

Returns typed resolved default value based on resolver type and field's setting (GetResolveDefaultValue(bool)).

public object GetTypedDefaultValue(FormResolveTypeEnum resolveType, IMacroResolver macroResolver, bool nullIfDefault = false)

Parameters

resolveType FormResolveTypeEnum

Resolver type

macroResolver IMacroResolver

Macro resolver

nullIfDefault bool

If true, and the resulting value is the default value, returns null

Returns

object

GetXmlNode(XmlDocument)

Returns the XML node representing the FormFieldInfo object.

public override XmlNode GetXmlNode(XmlDocument doc)

Parameters

doc XmlDocument

XML document

Returns

XmlNode

IsMacro(FormFieldPropertyEnum)

Returns true if property is macro.

public bool IsMacro(FormFieldPropertyEnum property)

Parameters

property FormFieldPropertyEnum

Property

Returns

bool

LoadFromTableData(DataRow, bool, bool)

Loads the field info from plain database structure data.

public override void LoadFromTableData(DataRow row, bool isPrimary, bool isSystem)

Parameters

row DataRow

Data row with structure information

isPrimary bool

Indicates if field represents primary key

isSystem bool

Indicates if field is system field

Remarks

Database structure data can be obtained via GetColumnInformation(string, string).

LoadFromXmlNode(XmlNode)

Loads the field info from XML node

public override void LoadFromXmlNode(XmlNode fieldNode)

Parameters

fieldNode XmlNode

Field node

RegisterColumns()

Registers the Columns of this object for resolving data macros.

protected override void RegisterColumns()

SetComponentName(string)

Sets name of form component used for rendering this form field.

public void SetComponentName(string controlName)

Parameters

controlName string

Name of form component.

SetPropertyValue(FormFieldPropertyEnum, string, bool, CultureInfo)

Sets property value.

public void SetPropertyValue(FormFieldPropertyEnum property, string value, bool isMacro = false, CultureInfo culture = null)

Parameters

property FormFieldPropertyEnum

Property which value is set

value string

Property value

isMacro bool

Indicates if value is macro. Default value is false.

culture CultureInfo

Culture used for the value string formating.

SetResolveDefaultValue(bool)

Sets the ability to resolve macros in field's default value.

[Obsolete("Method is deprecated and will be removed in the next version.")]
[ObsoleteSince(28, 0)]
public void SetResolveDefaultValue(bool value)

Parameters

value bool

Value to be set

SettingIsMacro(string)

Returns true if setting is macro.

public bool SettingIsMacro(string settingName)

Parameters

settingName string

Setting name

Returns

bool