Click or drag to resize
FieldBaseFieldType Class
Form field base class
Inheritance Hierarchy
SystemObject
  CMS.BaseAbstractSimpleDataContainerFieldType
    CMS.BaseAbstractDataContainerFieldType
      CMS.DataEngineFieldBaseFieldType
        CMS.DataEngineFieldInfo
        CMS.FormEngineFormFieldInfo

Namespace: CMS.DataEngine
Assembly: CMS.DataEngine (in CMS.DataEngine.dll) Version: 12.0.0
Syntax
C#
public abstract class FieldBase<FieldType> : AbstractDataContainer<FieldType>, 
	IField, IDataDefinitionItem
where FieldType : FieldBase<FieldType>

Type Parameters

FieldType

The FieldBaseFieldType type exposes the following members.

Constructors
Properties
  NameDescription
Public propertyAllowEmpty
Indicates whether field allows null values.
Public propertyCaption
Column caption.
Public propertyColumnNames
Available column names.
(Inherited from AbstractDataContainerParentObjectType.)
Public propertyDataType
Data type.
Public propertyDefaultValue
Field default value.
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, ...).
Public propertyGuid
Field unique identifier.
Public propertyIsDummyField
Indicates that field has no representation in database.
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).
Public propertyIsExtraField
Indicates that field is extra field (field is not in original form definition).
Public propertyIsInherited
If true, the field is inherited from parent class.
Public propertyIsUnique
Indicates whether field is unique.
Public propertyItem
Gets or sets the value of the column.
(Inherited from AbstractSimpleDataContainerTObject.)
Public propertyName
Column name.
Public propertyPrecision
Precision of the field
Public propertyPrimaryKey
Indicates whether field is a primary key.
Public propertyProperties
Properties of the field
Public propertyPropertiesMacroTable
Macro table for the field properties.
Public propertyReferenceToObjectType
ObjectType to which the given field refers (for example as a foreign key).
Public propertyReferenceType
Type of the reference (used only when ReferenceToObjectType is set).
Protected propertyRegisteredColumns
Registered Columns
(Inherited from AbstractSimpleDataContainerTObject.)
Protected propertyRegisteredColumnsObject
Registered Columns object
(Inherited from AbstractSimpleDataContainerTObject.)
Public propertySize
Size of the field.
Public propertySystem
Indicates if field is a system field.
Protected propertyUseLocalColumns
If true, the object uses local columns
(Inherited from AbstractSimpleDataContainerTObject.)
Top
Methods
  NameDescription
Public methodClone
Clones the object.
Public methodContainsColumn
Returns true if specified column is available in current structure.
(Inherited from AbstractDataContainerParentObjectType.)
Public methodGetValue
Gets the object value.
(Inherited from AbstractSimpleDataContainerTObject.)
Public methodGetXmlNode
Returns the XML node representing the FormFieldInfo object.
Public methodLoadFromTableData
Loads the field info from plain database structure data.
Public methodLoadFromXmlNode
Loads the field info from XML node
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 AbstractSimpleDataContainerTObjectRegisterColumns.)
Public methodSetValue
Sets the object value.
(Inherited from AbstractSimpleDataContainerTObject.)
Public methodToString
Returns field name value.
(Overrides ObjectToString.)
Public methodTryGetValue
Returns value of column.
(Inherited from AbstractSimpleDataContainerTObject.)
Top
See Also