Table of Contents

Interface IField

Namespace
CMS.DataEngine
Assembly
CMS.DataEngine.dll

Interface for field items.

public interface IField : IDataDefinitionItem
Inherited Members
Extension Methods

Properties

AllowEmpty

Indicates whether field allow empty values.

bool AllowEmpty { get; set; }

Property Value

bool

Caption

Column caption.

string Caption { get; set; }

Property Value

string

DataType

Data type.

string DataType { get; set; }

Property Value

string

DefaultValue

Field default value.

string DefaultValue { get; set; }

Property Value

string

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, ...).

[Obsolete("Property is deprecated and will be removed in the next version.")]
[ObsoleteSince(28, 0)]
bool External { get; set; }

Property Value

bool

Guid

Field unique identifier.

Guid Guid { get; set; }

Property Value

Guid

IsDummyField

Indicates that field has no representation in database.

bool IsDummyField { get; set; }

Property Value

bool

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).

bool IsDummyFieldFromMainForm { get; set; }

Property Value

bool

IsInherited

If true, the field is inherited from parent class.

[Obsolete("Property is deprecated and will be removed in the next version.")]
[ObsoleteSince(28, 0)]
bool IsInherited { get; set; }

Property Value

bool

IsUnique

Indicates whether field is unique.

bool IsUnique { get; set; }

Property Value

bool

Name

Column name.

string Name { get; set; }

Property Value

string

Precision

Precision of the field

int Precision { get; set; }

Property Value

int

PrimaryKey

Indicates whether field is a primary key.

bool PrimaryKey { get; set; }

Property Value

bool

Properties

Properties of the field

Hashtable Properties { get; set; }

Property Value

Hashtable

PropertiesMacroTable

Macro table for the field properties.

Hashtable PropertiesMacroTable { get; set; }

Property Value

Hashtable

ReferenceToObjectType

ObjectType to which the given field refers (for example as a foreign key).

string ReferenceToObjectType { get; set; }

Property Value

string

ReferenceType

Type of the reference (used only when ReferenceToObjectType is set).

ObjectDependencyEnum ReferenceType { get; set; }

Property Value

ObjectDependencyEnum

Size

Size of the field.

int Size { get; set; }

Property Value

int

System

Indicates if field is a system field.

bool System { get; set; }

Property Value

bool