The FormFieldInfo type exposes the following members.
Back to Top
Back to Top
Back to Top
Back to Top
Constructors
| Name | Description | |
|---|---|---|
 | FormFieldInfo |
Methods
| Name | Description | |
|---|---|---|
| Clone |
Clones the object.
(Overrides FieldBase FieldType Clone .) |
| ContainsColumn |
Returns true if specified column is available in current structure.
(Inherited from AbstractDataContainer ParentObjectType .) |
|  Equals | (Inherited from Object.) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetDefaultValue |
Returns resolved default value based on resolver type.
|
| 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.
|
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetHiddenNode |
Returns the XML node with visibility attribute set to false.
|
| GetMaxInputLength |
Gets the maximum input length for a given field
|
| GetPropertyValue(FormFieldPropertyEnum) |
Gets unresolved property value.
|
| GetPropertyValue(FormFieldPropertyEnum, Boolean ) |
Gets unresolved property value.
|
| GetPropertyValue(FormFieldPropertyEnum, IMacroResolver, MacroSettings, Boolean) |
Gets resolved property value.
|
| 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.
|
| GetType | Gets the (Inherited from Type of the current instance.Object.) |
| GetValue |
Gets the object value.
(Inherited from AbstractSimpleDataContainer ParentObjectType .) |
| GetVisibilityXml |
Returns the XML node representing the FormFieldInfo object only with limited properties.
XML node contains only: field name, field visibility
|
| GetXmlNode(XmlDocument) |
Returns the XML node representing the FormFieldInfo object.
(Overrides FieldBase FieldType GetXmlNode(XmlDocument).) |
| GetXmlNode(XmlDocument, IList String , Boolean) |
Returns the XML node representing the FormFieldInfo object.
|
| GetXPathExpression |
Gets XPath expression to select this node in generated XML.
|
| IsMacro |
Returns true if property is macro.
|
| LoadFromXmlNode |
Loads the field info from XML node
(Overrides FieldBase FieldType LoadFromXmlNode(XmlNode).) |
| MemberwiseClone | Creates a shallow copy of the current (Inherited from Object.Object.) |
| RegisterColumn(String, Func ParentObjectType, Object ) |
Registers the given Column to the object
(Inherited from AbstractSimpleDataContainer ParentObjectType .) |
| RegisterColumn(String, Func ParentObjectType, Object , Func ParentObjectType, Object, Object ) |
Registers the given Column to the object
(Inherited from AbstractSimpleDataContainer ParentObjectType .) |
| RegisterColumns |
Registers the Columns of this object for resolving data macros.
(Overrides FieldBase FieldType RegisterColumns .) |
| SetPropertyValue |
Sets property value.
|
| SetResolveDefaultValue |
Sets the ability to resolve macros in field's default value.
|
| SettingIsMacro |
Returns true if setting is macro.
|
| SetValue |
Sets the object value.
(Inherited from AbstractSimpleDataContainer ParentObjectType .) |
| ToString |
Returns field name value.
(Inherited from FieldBase FieldType .) |
| TryGetValue |
Returns value of column.
(Inherited from AbstractSimpleDataContainer ParentObjectType .) |
Extension Methods
| Name | Description | |
|---|---|---|
 | GetAPIString |
Gets the string by the specified resource key
(Defined by CoreExtensions.) |
| GetString |
Gets the string by the specified resource key
(Defined by CoreExtensions.) |
| ToBoolean |
Returns the boolean representation of an object or default value if not.
(Defined by CoreExtensions.) |
| ToDateTime |
Returns the DateTime representation of an object or default value if not.
(Defined by CoreExtensions.) |
| ToDouble |
Returns the double representation of an object or default value if not.
(Defined by CoreExtensions.) |
| ToGuid |
Returns the Guid representation of an object or default value if not.
(Defined by CoreExtensions.) |
| ToInteger |
Returns the integer representation of an object or default value if not.
(Defined by CoreExtensions.) |
| ToString |
Returns the string representation of an object or default value if not.
(Defined by CoreExtensions.) |
Properties
| Name | Description | |
|---|---|---|
 | AllowEmpty |
Indicates whether field allow empty values.
(Inherited from FieldBase FieldType .) |
| AllowUserToChangeVisibility |
Indicates whether user can change field visibility.
|
| Caption |
Column caption.
(Inherited from FieldBase FieldType .) |
| ColumnNames |
Available column names.
(Inherited from AbstractDataContainer ParentObjectType .) |
| DataType |
Data type.
(Inherited from FieldBase FieldType .) |
| DefaultValue |
Field default value.
(Inherited from FieldBase FieldType .) |
| DependsOnAnotherField |
Gets or sets value indicating if field is depending on some other field.
|
| DisplayIn |
Adjust the context in which the attribute can be displayed.
|
| DisplayInSimpleMode |
Indicates whether to display field in simple mode of basicform or not.
|
| Enabled |
Indicates whether field is Enabled.
|
| 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 .) |
| FieldMacroRules |
List of field validation macro rules.
|
| FieldType |
Type of the field.
|
| Guid |
Field unique identifier.
(Inherited from FieldBase FieldType .) |
| HasDependingFields |
Gets or sets value indicating if other fields are depending on this field.
|
| Inheritable |
Indicates whether field is inheritable (value is set as default value of parent FormFieldInfo, field is disabled if possible) or not.
|
| IsDummyField |
Indicates if field has no representation in database.
(Inherited from FieldBase FieldType .) |
| IsDummyFieldFromMainForm |
Indicates if dummy field is in main or alternative form
(Inherited from FieldBase FieldType .) |
| IsExtraField |
Indicates if field is extra field (field is not in orignal form definition).
(Inherited from FieldBase FieldType .) |
| IsInherited |
If true, the field is inherited from parent class.
(Inherited from FieldBase FieldType .) |
| IsUnique |
Indicates whether field is unique.
(Inherited from FieldBase FieldType .) |
| Item |
Gets or sets the value of the column.
(Inherited from AbstractSimpleDataContainer ParentObjectType .) |
| MappedToField |
Indicates field to which this one is mapped.
|
| MaxDateTimeValue |
Maximal datetime value.
|
| MaxStringLength |
Maximal string length.
|
| MaxValue |
Maximal value.
|
| MinDateTimeValue |
Minimal datetime value.
|
| MinStringLength |
Minimal string length.
|
| MinValue |
Minimal value.
|
| Name |
Column name.
(Inherited from FieldBase FieldType .) |
| Precision |
Precision of the field
(Inherited from FieldBase FieldType .) |
| PrimaryKey |
Indicates whether field is a primary key.
(Inherited from FieldBase FieldType .) |
| Properties |
Properties.
(Inherited from FieldBase FieldType .) |
| PropertiesMacroTable |
Properties macro table.
(Inherited from FieldBase FieldType .) |
| PublicField |
Indicates whether field is public.
|
| ReferenceToObjectType |
ObjectType to which the given field refers (for example as a foreign key).
(Inherited from FieldBase FieldType .) |
| ReferenceType |
Type of the reference (used only when ReferenceToObjectType is set).
(Inherited from FieldBase FieldType .) |
 | RegisteredColumns |
Registered Columns
(Inherited from AbstractSimpleDataContainer ParentObjectType .) |
| RegisteredColumnsObject |
Registered Columns object
(Inherited from AbstractSimpleDataContainer ParentObjectType .) |
| RegularExpression |
Regular expression.
|
| Settings |
Setting pairs (hastable).
|
| SettingsMacroTable |
Setting macro table (hastable).
|
| Size |
Size of the field.
(Inherited from FieldBase FieldType .) |
| SpellCheck |
Indicates whether field should be spell-checked.
|
| System |
Indicates if field is a system field.
(Inherited from FieldBase FieldType .) |
| TranslateField |
Indicates whether the field will be included into translation service document while exporting to XLIFF.
|
| UseLocalColumns |
If true, the object uses local columns
(Inherited from AbstractSimpleDataContainer ParentObjectType .) |
| Visibility |
Indicates who the field should be visible to.
|
| VisibilityControl |
Indicates type of visibility form control.
|
| Visible |
Indicates whether field is visible.
|
See Also