Class ExtraColumn

Namespace

CMS.DataEngine

Assembly

CMS.DataEngine.dll

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 cascading deleting when a referenced object is deleted.

public class ExtraColumn : AbstractDataContainer<ExtraColumn>, IDataContainer, ISimpleDataContainer

Inheritance

object

AbstractSimpleDataContainer<ExtraColumn>

AbstractDataContainer<ExtraColumn>

ExtraColumn

Implements

IDataContainer

ISimpleDataContainer

Inherited Members

AbstractDataContainer<ExtraColumn>.ColumnNames

AbstractDataContainer<ExtraColumn>.ContainsColumn(string)

AbstractSimpleDataContainer<ExtraColumn>.UseLocalColumns

AbstractSimpleDataContainer<ExtraColumn>.this[string]

AbstractSimpleDataContainer<ExtraColumn>.RegisteredColumnsObject

AbstractSimpleDataContainer<ExtraColumn>.RegisteredColumns

AbstractSimpleDataContainer<ExtraColumn>.RegisterColumn(string, Func<ExtraColumn, object>)

AbstractSimpleDataContainer<ExtraColumn>.RegisterColumn<ColumnType>(string, Func<ExtraColumn, object>)

AbstractSimpleDataContainer<ExtraColumn>.RegisterColumn(string, Func<ExtraColumn, object>, Func<ExtraColumn, object, object>)

AbstractSimpleDataContainer<ExtraColumn>.RegisterColumn<TColumn>(string, Func<ExtraColumn, object>, Func<ExtraColumn, object, object>)

AbstractSimpleDataContainer<ExtraColumn>.RegisterColumns()

AbstractSimpleDataContainer<ExtraColumn>.TryGetValue(string, out object)

AbstractSimpleDataContainer<ExtraColumn>.GetValue(string)

AbstractSimpleDataContainer<ExtraColumn>.SetValue(string, object)

Extension Methods

DataExtensions.With<T>(T, Action<T>)

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

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.

Constructors

ExtraColumn(string, string, ObjectDependencyEnum)

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

public ExtraColumn(string extendedObjectType, string columnName, ObjectDependencyEnum required = ObjectDependencyEnum.NotRequired)

Parameters

extendedObjectType string

The object type that is the source of the reference

columnName string

The name of the foreign key column of the source object type that stores the IDs of the referenced objects

required ObjectDependencyEnum

Determines how the system handles referential integrity and automatic removal of objects when a referenced object is deleted (Not required reference by default)

Properties

ColumnName

Gets or sets the name of the foreign key column in the object type that is the source of the reference.

[RegisterColumn]
public string ColumnName { get; set; }

Property Value

string

DependencyType

Determines how the system handles referential integrity and automatic removal of objects when a referenced object is deleted.

[RegisterColumn]
public ObjectDependencyEnum DependencyType { get; set; }

Property Value

ObjectDependencyEnum

ExtendedObjectType

Gets or sets the object type that is the source of the reference.

[RegisterColumn]
public string ExtendedObjectType { get; set; }

Property Value

string