FieldBase<FieldType> Class

Form field base class

Inheritance Hierarchy

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

Namespace: CMS.DataEngine
Assembly: CMS.DataEngine (in CMS.DataEngine.dll) Version: 12.0.0

Syntax

public abstract class FieldBase<FieldType> : AbstractDataContainer<FieldType>, 
	IField, IDataDefinitionItem
where FieldType : FieldBase<FieldType>

Type Parameters

FieldType

The FieldBase<FieldType> type exposes the following members.

Constructors

	Name	Description
Protected method	FieldBase<FieldType>	Constructor.

Properties

	Name	Description
Public property	AllowEmpty	Indicates whether field allows null values.
Public property	Caption	Column caption.
Public property	ColumnNames	Available column names. (Inherited from AbstractDataContainer<ParentObjectType>.)
Public property	DataType	Data type.
Public property	DefaultValue	Field default value.
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, ...).
Public property	Guid	Field unique identifier.
Public property	IsDummyField	Indicates that field has no representation in database.
Public property	IsDummyFieldFromMainForm	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 property	IsExtraField	Indicates that field is extra field (field is not in original form definition).
Public property	IsInherited	If true, the field is inherited from parent class.
Public property	IsUnique	Indicates whether field is unique.
Public property	Item	Gets or sets the value of the column. (Inherited from AbstractSimpleDataContainer<TObject>.)
Public property	Name	Column name.
Public property	Precision	Precision of the field
Public property	PrimaryKey	Indicates whether field is a primary key.
Public property	Properties	Properties of the field
Public property	PropertiesMacroTable	Macro table for the field properties.
Public property	ReferenceToObjectType	ObjectType to which the given field refers (for example as a foreign key).
Public property	ReferenceType	Type of the reference (used only when ReferenceToObjectType is set).
Protected property	RegisteredColumns	Registered Columns (Inherited from AbstractSimpleDataContainer<TObject>.)
Protected property	RegisteredColumnsObject	Registered Columns object (Inherited from AbstractSimpleDataContainer<TObject>.)
Public property	Size	Size of the field.
Public property	System	Indicates if field is a system field.
Protected property	UseLocalColumns	If true, the object uses local columns (Inherited from AbstractSimpleDataContainer<TObject>.)

Methods

	Name	Description
Public method	Clone	Clones the object.
Public method	ContainsColumn	Returns true if specified column is available in current structure. (Inherited from AbstractDataContainer<ParentObjectType>.)
Public method	GetValue	Gets the object value. (Inherited from AbstractSimpleDataContainer<TObject>.)
Public method	GetXmlNode	Returns the XML node representing the FormFieldInfo object.
Public method	LoadFromTableData	Loads the field info from plain database structure data.
Public method	LoadFromXmlNode	Loads the field info from XML node
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 AbstractSimpleDataContainer<TObject>.RegisterColumns().)
Public method	SetValue	Sets the object value. (Inherited from AbstractSimpleDataContainer<TObject>.)
Public method	ToString	Returns field name value. (Overrides Object.ToString().)
Public method	TryGetValue	Returns value of column. (Inherited from AbstractSimpleDataContainer<TObject>.)