FormFieldInfo Class

Represents form field definition.

Inheritance Hierarchy

System.Object
  CMS.Base.AbstractSimpleDataContainer<FormFieldInfo>
    CMS.Base.AbstractDataContainer<FormFieldInfo>
      CMS.DataEngine.FieldBase<FormFieldInfo>
        CMS.FormEngine.FormFieldInfo

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

Syntax

public class FormFieldInfo : FieldBase<FormFieldInfo>

The FormFieldInfo type exposes the following members.

Constructors

	Name	Description
Public method	FormFieldInfo

Methods

	Name	Description
Public method	Clone	Clones the object. (Overrides FieldBase<FieldType>.Clone().)
Public method	ContainsColumn	Returns true if specified column is available in current structure. (Inherited from AbstractDataContainer<ParentObjectType>.)
Public method	GetDefaultValue	Returns resolved default value based on resolver type and field's setting (GetResolveDefaultValue(Boolean)).
Public method	GetDisplayName	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 method	GetHiddenNode	Returns the XML node with visibility attribute set to false.
Public method	GetMaxInputLength	Gets the maximum input length for a given field
Public method	GetPropertyValue(FormFieldPropertyEnum)	Gets unresolved property value.
Public method	GetPropertyValue(FormFieldPropertyEnum, Boolean)	Gets unresolved property value.
Public method	GetPropertyValue(FormFieldPropertyEnum, IMacroResolver, MacroSettings, Boolean)	Gets resolved property value.
Public method	GetResolveDefaultValue	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.
Public method	GetTypedDefaultValue	Returns typed resolved default value based on resolver type and field's setting (GetResolveDefaultValue(Boolean)).
Public method	GetValue	Gets the object value. (Inherited from AbstractSimpleDataContainer<TObject>.)
Public method	GetVisibilityXml	Returns the XML node representing the FormFieldInfo object only with limited properties. XML node contains only: field name, field visibility
Public method	GetXmlNode(XmlDocument)	Returns the XML node representing the FormFieldInfo object. (Overrides FieldBase<FieldType>.GetXmlNode(XmlDocument).)
Public method	GetXmlNode(XmlDocument, IList<String>, Boolean)	Returns the XML node representing the FormFieldInfo object.
Public method	GetXPathExpression	Gets XPath expression to select this node in generated XML.
Public method	IsMacro	Returns true if property is macro.
Public method	LoadFromXmlNode	Loads the field info from XML node (Overrides FieldBase<FieldType>.LoadFromXmlNode(XmlNode).)
Protected method	RegisterColumn(String, Func<TObject, Object>)	Registers the given Column to the object (Inherited from AbstractSimpleDataContainer<TObject>.)
Protected method	RegisterColumn(String, Func<TObject, Object>, Func<TObject, Object, Object>)	Registers the given Column to the object (Inherited from AbstractSimpleDataContainer<TObject>.)
Protected method	RegisterColumns	Registers the Columns of this object for resolving data macros. (Overrides FieldBase<FieldType>.RegisterColumns().)
Public method	SetPropertyValue	Sets property value.
Public method	SetResolveDefaultValue	Sets the ability to resolve macros in field's default value.
Public method	SettingIsMacro	Returns true if setting is macro.
Public method	SetValue	Sets the object value. (Inherited from AbstractSimpleDataContainer<TObject>.)
Public method	ToString	Returns field name value. (Inherited from FieldBase<FieldType>.)
Public method	TryGetValue	Returns value of column. (Inherited from AbstractSimpleDataContainer<TObject>.)

Extension Methods

	Name	Description
Public Extension Method	AsValue	Converts object to a query value which can be used as a query parameter (Defined by QueryExtensions.)
Public Extension Method	GetAPIString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	ToBoolean	Returns the boolean representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDateTime	Returns the DateTime representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDouble	Returns the double representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToGuid	Returns the Guid representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToInteger	Returns the integer representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToString	Returns the string representation of an object or default value if not. (Defined by CoreExtensions.)

Properties

	Name	Description
Public property	AllowEmpty	Indicates whether field allow empty values. (Inherited from FieldBase<FieldType>.)
Public property	AllowUserToChangeVisibility	Indicates whether user can change field visibility.
Public property	Caption	Column caption. (Inherited from FieldBase<FieldType>.)
Public property	ColumnNames	Available column names. (Inherited from AbstractDataContainer<ParentObjectType>.)
Public property	DataType	Data type. (Inherited from FieldBase<FieldType>.)
Public property	DefaultValue	Field default value. (Inherited from FieldBase<FieldType>.)
Public property	DependsOnAnotherField	Gets or sets value indicating if field is depending on some other field.
Public property	DisplayIn	Adjust the context in which the attribute can be displayed.
Public property	DisplayInSimpleMode	Indicates whether to display field in simple mode of basicform or not.
Public property	Enabled	Indicates whether field is Enabled.
Public property	External	Indicates if field is external, if so it represents column from another table which is included in CMS_Tree_View_Joined (CMS_Document, CMS_Node, ...). (Inherited from FieldBase<FieldType>.)
Public property	FieldMacroRules	List of field validation macro rules.
Public property	FieldType	Type of the field.
Public property	Guid	Field unique identifier. (Inherited from FieldBase<FieldType>.)
Public property	HasDependingFields	Gets or sets value indicating if other fields are depending on this field.
Public property	Inheritable	Indicates whether field is inheritable (value is set as default value of parent FormFieldInfo, field is disabled if possible) or not.
Public property	IsDummyField	Indicates if field has no representation in database. (Inherited from FieldBase<FieldType>.)
Public property	IsDummyFieldFromMainForm	Indicates if dummy field is in main or alternative form (Inherited from FieldBase<FieldType>.)
Public property	IsExtraField	Indicates if field is extra field (field is not in orignal form definition). (Inherited from FieldBase<FieldType>.)
Public property	IsInherited	If true, the field is inherited from parent class. (Inherited from FieldBase<FieldType>.)
Public property	IsUnique	Indicates whether field is unique. (Inherited from FieldBase<FieldType>.)
Public property	Item	Gets or sets the value of the column. (Inherited from AbstractSimpleDataContainer<TObject>.)
Public property	MappedToField	Indicates field to which this one is mapped.
Public property	MaxDateTimeValue	Maximal datetime value.
Public property	MaxStringLength	Maximal string length.
Public property	MaxValue	Maximal value.
Public property	MinDateTimeValue	Minimal datetime value.
Public property	MinStringLength	Minimal string length.
Public property	MinValue	Minimal value.
Public property	Name	Column name. (Inherited from FieldBase<FieldType>.)
Public property	Precision	Precision of the field (Inherited from FieldBase<FieldType>.)
Public property	PrimaryKey	Indicates whether field is a primary key. (Inherited from FieldBase<FieldType>.)
Public property	Properties	Properties of the field (Inherited from FieldBase<FieldType>.)
Public property	PropertiesMacroTable	Macro table for the field properties. (Inherited from FieldBase<FieldType>.)
Public property	PublicField	Indicates whether field is public.
Public property	ReferenceToObjectType	ObjectType to which the given field refers (for example as a foreign key). (Inherited from FieldBase<FieldType>.)
Public property	ReferenceType	Type of the reference (used only when ReferenceToObjectType is set). (Inherited from FieldBase<FieldType>.)
Protected property	RegisteredColumns	Registered Columns (Inherited from AbstractSimpleDataContainer<TObject>.)
Protected property	RegisteredColumnsObject	Registered Columns object (Inherited from AbstractSimpleDataContainer<TObject>.)
Public property	RegularExpression	Regular expression.
Public property	Settings	Setting of the field form control [name] -> [value]
Public property	SettingsMacroTable	Macro table for the settings of the field form control
Public property	Size	Size of the field. (Inherited from FieldBase<FieldType>.)
Public property	SpellCheck	Indicates whether field should be spell-checked.
Public property	System	Indicates if field is a system field. (Inherited from FieldBase<FieldType>.)
Public property	TranslateField	Indicates whether the field will be included into translation service document while exporting to XLIFF.
Protected property	UseLocalColumns	If true, the object uses local columns (Inherited from AbstractSimpleDataContainer<TObject>.)
Public property	Visibility	Indicates who the field should be visible to.
Public property	VisibilityControl	Indicates type of visibility form control.
Public property	Visible	Indicates whether field is visible.