Class DtResponse

DataTables and Editor response object. This object can be used to construct and contain the data in response to a DataTables or Editor request before JSON encoding it and sending to the client-side.

Note that this object uses lowercase property names as this it output directly to JSON, so the format and parameter names that DataTables and Editor expect must be used.

Inheritance
System.Object
DtResponse
Namespace: DataTables
Assembly: DataTables-Editor-Server.dll
Syntax
public class DtResponse : object

Fields

| Improve this Doc View Source

cancelled

List of ids for row that have had their processing cancelled by the pre* events

Declaration
public List<object> cancelled
Field Value
Type Description
List<System.Object>
| Improve this Doc View Source

data

Data to draw the table with, for both client-side and server-side processing

Declaration
public List<Dictionary<string, object>> data
Field Value
Type Description
List<Dictionary<System.String, System.Object>>
| Improve this Doc View Source

debug

If debug mode is enabled, this property will be populated with information about the SQL statements Editor has run.

Declaration
public List<object> debug
Field Value
Type Description
List<System.Object>
| Improve this Doc View Source

draw

Draw counter for server-side processing requests

Declaration
public int? draw
Field Value
Type Description
System.Nullable<System.Int32>
| Improve this Doc View Source

error

General error message if there is one

Declaration
public string error
Field Value
Type Description
System.String
| Improve this Doc View Source

fieldErrors

List of field errors if one or more fields are in an error state when validated

Declaration
public List<DtResponse.FieldError> fieldErrors
Field Value
Type Description
List<DtResponse.FieldError>
| Improve this Doc View Source

files

File information for the upload input types

Declaration
public Dictionary<string, Dictionary<string, Dictionary<string, object>>> files
Field Value
Type Description
Dictionary<System.String, Dictionary<System.String, Dictionary<System.String, System.Object>>>
| Improve this Doc View Source

id

Id of the newly created row for the create action

Declaration
public int? id
Field Value
Type Description
System.Nullable<System.Int32>
| Improve this Doc View Source

meta

Information that can be processes in the Ajax callback handlers can be added here. It is not actively used by the libraries.

Declaration
public Dictionary<string, object> meta
Field Value
Type Description
Dictionary<System.String, System.Object>
| Improve this Doc View Source

options

List of options for Editor select, radio and checkbox field types

Declaration
public Dictionary<string, object> options
Field Value
Type Description
Dictionary<System.String, System.Object>
| Improve this Doc View Source

recordsFiltered

Record count in the filtered data set for server-side processing requests

Declaration
public int? recordsFiltered
Field Value
Type Description
System.Nullable<System.Int32>
| Improve this Doc View Source

recordsTotal

Total record count for server-side processing requests

Declaration
public int? recordsTotal
Field Value
Type Description
System.Nullable<System.Int32>
| Improve this Doc View Source

searchBuilder

Object containing a list of options from SearchPanes

Declaration
public SearchBuilderReturn searchBuilder
Field Value
Type Description
SearchBuilderReturn
| Improve this Doc View Source

searchPanes

Object containing a list of options from SearchPanes

Declaration
public SearchPanesReturn searchPanes
Field Value
Type Description
SearchPanesReturn
| Improve this Doc View Source

upload

Row data on update action

Declaration
public DtResponse.ResponseUpload upload
Field Value
Type Description
DtResponse.ResponseUpload

Methods

| Improve this Doc View Source

Merge(DtResponse)

Merge a response object into this one to create a single combined object. Generally parameters that are defined in the object passed in as a parameter will overwrite the parameters in this object if the are defined.

Declaration
public DtResponse Merge(DtResponse b)
Parameters
Type Name Description
DtResponse b

Response object to merge in
Returns
Type Description
DtResponse

Self for chaining