IField Interface

Interface for field items.

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

Syntax

public interface IField : IDataDefinitionItem

The IField type exposes the following members.

Properties

	Name	Description
Public property	AllowEmpty	Indicates whether field allow empty values.
Public property	Caption	Column caption.
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	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).
Public property	Size	Size of the field.
Public property	System	Indicates if field is a system field.

Methods

	Name	Description
Public method	Clone	Clones current object and returns copy of it. (Inherited from IDataDefinitionItem.)
Public method	GetXmlNode	Returns XML representation of current object. (Inherited from IDataDefinitionItem.)
Public method	LoadFromTableData	Loads the field info from plain database structure data. (Inherited from IDataDefinitionItem.)
Public method	LoadFromXmlNode	Loads the field info from XML node. (Inherited from IDataDefinitionItem.)