Click or drag to resize
ExtraColumn Class
Defines a column of another object type as a reference (foreign key relationship) pointing to the current object type. Determines how the system handles dependencies for the reference. For example data integrity during import and staging, or cascading deleting when a referenced object is deleted.
Inheritance Hierarchy
SystemObject
  CMS.BaseAbstractSimpleDataContainerExtraColumn
    CMS.BaseAbstractDataContainerExtraColumn
      CMS.DataEngineExtraColumn

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

The ExtraColumn type exposes the following members.

Constructors
  NameDescription
Public methodExtraColumn
Creates a new ExtraColumn instance, defining a reference (foreign key relationship) from another object type to the current object type.
Top
Properties
  NameDescription
Public propertyColumnName
Gets or sets the name of the foreign key column in the object type that is the source of the reference.
Public propertyColumnNames
Available column names.
(Inherited from AbstractDataContainerParentObjectType.)
Public propertyDependencyType
Determines how the system handles referential integrity and automatic removal of objects when a referenced object is deleted.
Public propertyExtendedObjectType
Gets or sets the object type that is the source of the reference.
Public propertyItem
Gets or sets the value of the column.
(Inherited from AbstractSimpleDataContainerTObject.)
Protected propertyRegisteredColumns
Registered Columns
(Inherited from AbstractSimpleDataContainerTObject.)
Protected propertyRegisteredColumnsObject
Registered Columns object
(Inherited from AbstractSimpleDataContainerTObject.)
Protected propertyUseLocalColumns
If true, the object uses local columns
(Inherited from AbstractSimpleDataContainerTObject.)
Top
Methods
  NameDescription
Public methodContainsColumn
Returns true if specified column is available in current structure.
(Inherited from AbstractDataContainerParentObjectType.)
Public methodGetValue
Gets the object value.
(Inherited from AbstractSimpleDataContainerTObject.)
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
(Inherited from AbstractSimpleDataContainerTObject.)
Public methodSetValue
Sets the object value.
(Inherited from AbstractSimpleDataContainerTObject.)
Public methodTryGetValue
Returns value of column.
(Inherited from AbstractSimpleDataContainerTObject.)
Top
Remarks
Use List collections of ExtraColumn instances to set the Extends property of ObjectTypeInfo. Each ExtraColumn in the collection registers a foreign key column of another object type as a reference pointing to the current object type.
See Also