Class DtRequest

Representation of a DataTables or Editor request. This can be any form of request from the two libraries, including a standard DataTables get, a server-side processing request, or an Editor create, edit or delete command.

Inheritance

System.Object

DtRequest

Namespace: DataTables

Assembly: DataTables-Editor-Server.dll

Syntax

public class DtRequest : object

Constructors

| Improve this Doc View Source

DtRequest(IEnumerable<KeyValuePair<String, StringValues>>, String)

Declaration

public DtRequest(IEnumerable<KeyValuePair<String, StringValues>> rawHttp, string culture = null)

Parameters

Type	Name	Description
IEnumerable<KeyValuePair<String, StringValues>>	rawHttp
System.String	culture

| Improve this Doc View Source

DtRequest(IEnumerable<KeyValuePair<String, String>>, String)

Convert an HTTP request submitted by the client-side into a DtRequest object

Declaration

public DtRequest(IEnumerable<KeyValuePair<string, string>> rawHttp, string culture = null)

Parameters

Type	Name	Description
IEnumerable<KeyValuePair<System.String, System.String>>	rawHttp	Data from the client-side
System.String	culture

Fields

| Improve this Doc View Source

Action

Editor action request

Declaration

public string Action

Field Value

Type	Description
System.String

| Improve this Doc View Source

Columns

Column information for server-side processing

Declaration

public List<DtRequest.ColumnT> Columns

Field Value

Type	Description
List<DtRequest.ColumnT>

| Improve this Doc View Source

Data

Dictionary of data sent by Editor (may contain nested data)

Declaration

public Dictionary<string, object> Data

Field Value

Type	Description
Dictionary<System.String, System.Object>

| Improve this Doc View Source

Draw

DataTables draw counter for server-side processing

Declaration

public int Draw

Field Value

Type	Description
System.Int32

| Improve this Doc View Source

Ids

List of ids for Editor to operate on

Declaration

public List<string> Ids

Field Value

Type	Description
List<System.String>

| Improve this Doc View Source

Length

DataTables page length parameter for server-side processing

Declaration

public int Length

Field Value

Type	Description
System.Int32

| Improve this Doc View Source

Order

Column ordering information for server-side processing

Declaration

public List<DtRequest.OrderT> Order

Field Value

Type	Description
List<DtRequest.OrderT>

| Improve this Doc View Source

RequestType

Type of request this instance contains the data for

Declaration

public DtRequest.RequestTypes RequestType

Field Value

Type	Description
DtRequest.RequestTypes

| Improve this Doc View Source

Search

Search information for server-side processing

Declaration

public DtRequest.SearchT Search

Field Value

Type	Description
DtRequest.SearchT

| Improve this Doc View Source

searchBuilder

Information for searchBuilder

Declaration

public SearchBuilderDetails searchBuilder

Field Value

Type	Description
SearchBuilderDetails

| Improve this Doc View Source

searchPanes

Information for searchPanes

Declaration

public Dictionary<string, string[]> searchPanes

Field Value

Type	Description
Dictionary<System.String, System.String[]>

| Improve this Doc View Source

searchPanes_null

Information for searchPanes_null

Declaration

public Dictionary<string, bool[]> searchPanes_null

Field Value

Type	Description
Dictionary<System.String, System.Boolean[]>

| Improve this Doc View Source

searchPanesLast

The last searchpane when dealing with cascade or viewTotal

Declaration

public String searchPanesLast

Field Value

Type	Description
String

| Improve this Doc View Source

searchPanesOptions

Information for searchPanes_null

Declaration

public DtRequest.SearchPanesOptions searchPanesOptions

Field Value

Type	Description
DtRequest.SearchPanesOptions

| Improve this Doc View Source

Start

DataTables record start pointer for server-side processing

Declaration

public int Start

Field Value

Type	Description
System.Int32

| Improve this Doc View Source

UploadField

Upload field name

Declaration

public string UploadField

Field Value

Type	Description
System.String

Methods

| Improve this Doc View Source

HttpData(IEnumerable<KeyValuePair<String, String>>, String)

Convert HTTP request data, in the standard HTTP parameter form submitted by jQuery into a generic dictionary of string / object pairs so the data can easily be accessed in .NET.

This static method is generic and not specific to the DtRequest. It may be used for other data formats as well.

Note that currently this does not support nested arrays or objects in arrays

Declaration

public static Dictionary<string, object> HttpData(IEnumerable<KeyValuePair<string, string>> dataIn, string cultureStr = null)

Parameters

Type	Name	Description
IEnumerable<KeyValuePair<System.String, System.String>>	dataIn	Collection of HTTP parameters sent by the client-side
System.String	cultureStr	Culture for locale specific conversions

Returns

Type	Description
Dictionary<System.String, System.Object>	Dictionary with the data and values contained. These may contain nested lists and dictionaries.