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

System.Object
  CMS.Base.AbstractSimpleDataContainer<ExtraColumn>
    CMS.Base.AbstractDataContainer<ExtraColumn>
      CMS.DataEngine.ExtraColumn

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

Syntax

public class ExtraColumn : AbstractDataContainer<ExtraColumn>

The ExtraColumn type exposes the following members.

Constructors

	Name	Description
Public method	ExtraColumn	Creates a new ExtraColumn instance, defining a reference (foreign key relationship) from another object type to the current object type.

Properties

	Name	Description
Public property	ColumnName	Gets or sets the name of the foreign key column in the object type that is the source of the reference.
Public property	ColumnNames	Available column names. (Inherited from AbstractDataContainer<ParentObjectType>.)
Public property	DependencyType	Determines how the system handles referential integrity and automatic removal of objects when a referenced object is deleted.
Public property	ExtendedObjectType	Gets or sets the object type that is the source of the reference.
Public property	Item	Gets or sets the value of the column. (Inherited from AbstractSimpleDataContainer<TObject>.)
Protected property	RegisteredColumns	Registered Columns (Inherited from AbstractSimpleDataContainer<TObject>.)
Protected property	RegisteredColumnsObject	Registered Columns object (Inherited from AbstractSimpleDataContainer<TObject>.)
Protected property	UseLocalColumns	If true, the object uses local columns (Inherited from AbstractSimpleDataContainer<TObject>.)

Methods

	Name	Description
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>.)
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 (Inherited from AbstractSimpleDataContainer<TObject>.)
Public method	SetValue	Sets the object value. (Inherited from AbstractSimpleDataContainer<TObject>.)
Public method	TryGetValue	Returns value of column. (Inherited from AbstractSimpleDataContainer<TObject>.)

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.