Click or drag to resize
FormFieldInfo Class
Represents form field definition.
Inheritance Hierarchy

Namespace: CMS.FormEngine
Assembly: CMS.FormEngine (in CMS.FormEngine.dll) Version: 10.0.0
public class FormFieldInfo : FieldBase<FormFieldInfo>

The FormFieldInfo type exposes the following members.

Public methodFormFieldInfo
Public propertyAllowEmpty
Indicates whether field allow empty values.
(Inherited from FieldBaseFieldType.)
Public propertyAllowUserToChangeVisibility
Indicates whether user can change field visibility.
Public propertyCaption
Column caption.
(Inherited from FieldBaseFieldType.)
Public propertyColumnNames
Available column names.
(Inherited from AbstractDataContainerParentObjectType.)
Public propertyDataType
Data type.
(Inherited from FieldBaseFieldType.)
Public propertyDefaultValue
Field default value.
(Inherited from FieldBaseFieldType.)
Public propertyDependsOnAnotherField
Gets or sets value indicating if field is depending on some other field.
Public propertyDisplayIn
Adjust the context in which the attribute can be displayed.
Public propertyDisplayInSimpleMode
Indicates whether to display field in simple mode of basicform or not.
Public propertyEnabled
Indicates whether field is Enabled.
Public propertyExternal
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 FieldBaseFieldType.)
Public propertyFieldMacroRules
List of field validation macro rules.
Public propertyFieldType
Type of the field.
Public propertyGuid
Field unique identifier.
(Inherited from FieldBaseFieldType.)
Public propertyHasDependingFields
Gets or sets value indicating if other fields are depending on this field.
Public propertyInheritable
Indicates whether field is inheritable (value is set as default value of parent FormFieldInfo, field is disabled if possible) or not.
Public propertyIsDummyField
Indicates that field has no representation in database.
(Inherited from FieldBaseFieldType.)
Public propertyIsDummyFieldFromMainForm
If true the field was added into the main form else it was added into the alt.form (expects IsDummyField property to be true).
(Inherited from FieldBaseFieldType.)
Public propertyIsExtraField
Indicates that field is extra field (field is not in original form definition).
(Inherited from FieldBaseFieldType.)
Public propertyIsInherited
If true, the field is inherited from parent class.
(Inherited from FieldBaseFieldType.)
Public propertyIsUnique
Indicates whether field is unique.
(Inherited from FieldBaseFieldType.)
Public propertyItem
Gets or sets the value of the column.
(Inherited from AbstractSimpleDataContainerTObject.)
Public propertyMappedToField
Indicates field to which this one is mapped.
Public propertyMaxDateTimeValue
Maximal datetime value.
Public propertyMaxStringLength
Maximal string length.
Public propertyMaxValue
Maximal value.
Public propertyMinDateTimeValue
Minimal datetime value.
Public propertyMinStringLength
Minimal string length.
Public propertyMinValue
Minimal value.
Public propertyName
Column name.
(Inherited from FieldBaseFieldType.)
Public propertyPrecision
Precision of the field
(Inherited from FieldBaseFieldType.)
Public propertyPrimaryKey
Indicates whether field is a primary key.
(Inherited from FieldBaseFieldType.)
Public propertyProperties
Properties of the field
(Inherited from FieldBaseFieldType.)
Public propertyPropertiesMacroTable
Macro table for the field properties.
(Inherited from FieldBaseFieldType.)
Public propertyPublicField
Indicates whether field is public.
Public propertyReferenceToObjectType
ObjectType to which the given field refers (for example as a foreign key).
(Inherited from FieldBaseFieldType.)
Public propertyReferenceType
Type of the reference (used only when ReferenceToObjectType is set).
(Inherited from FieldBaseFieldType.)
Protected propertyRegisteredColumns
Registered Columns
(Inherited from AbstractSimpleDataContainerTObject.)
Protected propertyRegisteredColumnsObject
Registered Columns object
(Inherited from AbstractSimpleDataContainerTObject.)
Public propertyRegularExpression
Regular expression.
Public propertySettings
Setting of the field form control [name] -> [value]
Public propertySettingsMacroTable
Macro table for the settings of the field form control
Public propertySize
Size of the field.
(Inherited from FieldBaseFieldType.)
Public propertySpellCheck
Indicates whether field should be spell-checked.
Public propertySystem
Indicates if field is a system field.
(Inherited from FieldBaseFieldType.)
Public propertyTranslateField
Indicates whether the field will be included into translation service document while exporting to XLIFF.
Protected propertyUseLocalColumns
If true, the object uses local columns
(Inherited from AbstractSimpleDataContainerTObject.)
Public propertyVisibility
Indicates who the field should be visible to.
Public propertyVisibilityControl
Indicates type of visibility form control.
Public propertyVisible
Indicates whether field is visible.
Public methodClone
Clones the object.
(Overrides FieldBaseFieldTypeClone.)
Public methodContainsColumn
Returns true if specified column is available in current structure.
(Inherited from AbstractDataContainerParentObjectType.)
Public methodGetDefaultValue
Returns resolved default value based on resolver type and field's setting (GetResolveDefaultValue(Boolean)).
Public methodGetDisplayName
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 methodGetHiddenNode
Returns the XML node with visibility attribute set to false.
Public methodGetMaxInputLength
Gets the maximum input length for a given field
Public methodGetPropertyValue(FormFieldPropertyEnum)
Gets unresolved property value.
Public methodGetPropertyValue(FormFieldPropertyEnum, Boolean)
Gets unresolved property value.
Public methodGetPropertyValue(FormFieldPropertyEnum, IMacroResolver, MacroSettings, Boolean)
Gets resolved property value.
Public methodGetResolveDefaultValue
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 methodGetTypedDefaultValue
Returns typed resolved default value based on resolver type and field's setting (GetResolveDefaultValue(Boolean)).
Public methodGetValue
Gets the object value.
(Inherited from AbstractSimpleDataContainerTObject.)
Public methodGetVisibilityXml
Returns the XML node representing the FormFieldInfo object only with limited properties. XML node contains only: field name, field visibility
Public methodGetXmlNode
Returns the XML node representing the FormFieldInfo object.
(Overrides FieldBaseFieldTypeGetXmlNode(XmlDocument).)
Public methodGetXPathExpression
Gets XPath expression to select this node in generated XML.
Public methodIsMacro
Returns true if property is macro.
Public methodLoadFromTableData
Loads the field info from plain database structure data.
(Overrides FieldBaseFieldTypeLoadFromTableData(DataRow, Boolean, Boolean).)
Public methodLoadFromXmlNode
Loads the field info from XML node
(Overrides FieldBaseFieldTypeLoadFromXmlNode(XmlNode).)
Protected methodRegisterColumn(String, FuncTObject, Object)
Registers the given Column to the object
(Inherited from AbstractSimpleDataContainerTObject.)
Protected methodRegisterColumn(String, FuncTObject, Object, FuncTObject, Object, Object)
Registers the given Column to the object
(Inherited from AbstractSimpleDataContainerTObject.)
Protected methodRegisterColumns
Registers the Columns of this object for resolving data macros.
(Overrides FieldBaseFieldTypeRegisterColumns.)
Public methodSetPropertyValue
Sets property value.
Public methodSetResolveDefaultValue
Sets the ability to resolve macros in field's default value.
Public methodSettingIsMacro
Returns true if setting is macro.
Public methodSetValue
Sets the object value.
(Inherited from AbstractSimpleDataContainerTObject.)
Public methodToString
Returns field name value.
(Inherited from FieldBaseFieldType.)
Public methodTryGetValue
Returns value of column.
(Inherited from AbstractSimpleDataContainerTObject.)
Extension Methods
Public Extension MethodIsNodeNameSourceCandidate
Checks if form field can be used as source for document node name.
(Defined by DocumentFormFieldInfoExtensions.)
See Also