Table of Contents

Class ObjectDataEventHandler

Namespace
CMS.DataEngine
Assembly
CMS.DataEngine.dll

Object data handler enables manipulation with object data.

public class ObjectDataEventHandler : AdvancedHandler<ObjectDataEventHandler, ObjectDataEventArgs>
Inheritance
object
ObjectDataEventHandler
Inherited Members
Extension Methods

Constructors

ObjectDataEventHandler()

Constructor

public ObjectDataEventHandler()

ObjectDataEventHandler(ObjectDataEventHandler)

Constructor

public ObjectDataEventHandler(ObjectDataEventHandler parentHandler)

Parameters

parentHandler ObjectDataEventHandler

Parent handler

Methods

Start(DataSet, IObjectQuery, int)

Commences the event by invoking the registered Before event handlers. Returns a handle for completing the event.

public IAdvancedEventHandle<ObjectDataEventArgs> Start(DataSet result, IObjectQuery query, int totalRecords)

Parameters

result DataSet

Data set with object data.

query IObjectQuery

Default object query used to select data in case data set is not returned by event.

totalRecords int

Number of records which should by used for paging. If not set, number of rows in dataset is calculated.

Returns

IAdvancedEventHandle<ObjectDataEventArgs>

Returns a handle for completing the event.

StartEvent(DataSet, IObjectQuery, int)

Initiates the event handling.

[Obsolete("Use Start(DataSet, IObjectQuery, int) instead.")]
public ObjectDataEventHandler StartEvent(DataSet result, IObjectQuery query, int totalRecords)

Parameters

result DataSet

Data set with object data.

query IObjectQuery

Default object query used to select data in case data set is not returned by event.

totalRecords int

Number of records which should by used for paging. If not set, number of rows in dataset is calculated.

Returns

ObjectDataEventHandler