Table of Contents

Interface IDataClass

Namespace
CMS.DataEngine
Assembly
CMS.DataEngine.dll

DataClass interface.

public interface IDataClass : IAdvancedDataContainer, IDataContainer, ISimpleDataContainer
Inherited Members
Extension Methods

Properties

AllowPartialUpdate

If true, the object allows partial updates.

bool AllowPartialUpdate { get; set; }

Property Value

bool

ClassName

Name of the data class

string ClassName { get; }

Property Value

string

ColumnsCount

Number of the object columns.

int ColumnsCount { get; }

Property Value

int

ID

Object ID.

int ID { get; }

Property Value

int

IDColumn

ID column(s).

string IDColumn { get; }

Property Value

string

Remarks

Primary key can be identified by more than one column. In this case columns are separated by ';' character.

IsReadOnly

Indicates whether class is in read-only mode.

bool IsReadOnly { get; }

Property Value

bool
See Also

StructureInfo

Class structure information.

ClassStructureInfo StructureInfo { get; }

Property Value

ClassStructureInfo

UseOriginalData

If true, original data is used instead of the actual data.

bool UseOriginalData { get; set; }

Property Value

bool

Methods

CopyDataTo(IDataClass)

Copies the class data to other data class

void CopyDataTo(IDataClass target)

Parameters

target IDataClass

CopyOriginalDataTo(IDataClass)

Copies the original class data to other data class

void CopyOriginalDataTo(IDataClass target)

Parameters

target IDataClass

GetDataSet()

Gets the DataSet from the object data.

[Obsolete("Method was not intended for public use and will be removed.")]
[ObsoleteSince(29, 2)]
DataSet GetDataSet()

Returns

DataSet

Init(ClassStructureInfo)

Initializes an instance of data class after created by empty constructor

void Init(ClassStructureInfo structureInfo)

Parameters

structureInfo ClassStructureInfo

Class structure info

IsEmpty()

Returns true if the object is empty.

[Obsolete("Method was not intended for public use and will be removed.")]
[ObsoleteSince(29, 2)]
bool IsEmpty()

Returns

bool

LoadData(IDataContainer, bool)

Loads the object data from given data container.

void LoadData(IDataContainer data, bool loadNullValues = true)

Parameters

data IDataContainer

Source data

loadNullValues bool

If true, null values are loaded to the object

LoadData(int)

Loads the object data by the given primary key value

void LoadData(int primaryKeyValue)

Parameters

primaryKeyValue int

Primary key value

SetReadOnly()

Locks the data class as a read-only

void SetReadOnly()