FieldInfo Class

Basic field definition

Inheritance Hierarchy

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

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

Syntax

public class FieldInfo : FieldBase<FieldInfo>

The FieldInfo type exposes the following members.

Constructors

	Name	Description
Public method	FieldInfo

Properties

	Name	Description
Public property	AllowEmpty	Indicates whether field allows null values. (Inherited from FieldBase<FieldType>.)
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	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	Guid	Field unique identifier. (Inherited from FieldBase<FieldType>.)
Public property	IsDummyField	Indicates that field has no representation in database. (Inherited from FieldBase<FieldType>.)
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). (Inherited from FieldBase<FieldType>.)
Public property	IsExtraField	Indicates that field is extra field (field is not in original 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	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	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	Size	Size of the field. (Inherited from FieldBase<FieldType>.)
Public property	System	Indicates if field is a system field. (Inherited from FieldBase<FieldType>.)
Protected property	UseLocalColumns	If true, the object uses local columns (Inherited from AbstractSimpleDataContainer<TObject>.)

Methods

	Name	Description
Public method	Clone	Clones the object. (Inherited from FieldBase<FieldType>.)
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. (Inherited from FieldBase<FieldType>.)
Public method	LoadFromTableData	Loads the field info from plain database structure data. (Inherited from FieldBase<FieldType>.)
Public method	LoadFromXmlNode	Loads the field info from XML node (Inherited from FieldBase<FieldType>.)
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. (Inherited from FieldBase<FieldType>.)
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>.)