Click or drag to resize
FieldInfo Class
Basic field definition
Inheritance Hierarchy
SystemObject
  CMS.BaseAbstractSimpleDataContainerFieldInfo
    CMS.BaseAbstractDataContainerFieldInfo
      CMS.DataEngineFieldBaseFieldInfo
        CMS.DataEngineFieldInfo

Namespace: CMS.DataEngine
Assembly: CMS.DataEngine (in CMS.DataEngine.dll) Version: 12.0.0
Syntax
C#
public class FieldInfo : FieldBase<FieldInfo>

The FieldInfo type exposes the following members.

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