Class JqGridOptions

jqGrid options

Inheritance

System.Object

JqGridOptions

JqGridOptions<TModel>

Namespace: Lib.AspNetCore.Mvc.JqGrid.Infrastructure.Options

Assembly: Lib.AspNetCore.Mvc.JqGrid.Infrastructure.dll

Syntax

public class JqGridOptions : object

Constructors

JqGridOptions(String)

Initializes a new instance of the JqGridOptions class.

Declaration

public JqGridOptions(string id)

Parameters

Type	Name	Description
System.String	id	Identifier, which will be used for table (id='{0}'), pager div (id='{0}Pager'), filter grid div (id='{0}Search') and in JavaScript.

Properties

Caption

Gets or sets the caption for the grid.

Declaration

public string Caption { get; set; }

Property Value

Type	Description
System.String

CellEditingEnabled

Gets or sets the value indicating if cell editing is enabled

Declaration

public bool CellEditingEnabled { get; set; }

Property Value

Type	Description
System.Boolean

CellEditingSubmitMode

Gets or sets the cell editing submit mode

Declaration

public JqGridCellEditingSubmitModes CellEditingSubmitMode { get; set; }

Property Value

Type	Description
JqGridCellEditingSubmitModes

CellEditingUrl

Gets or set the URL for cell editing submit

Declaration

public string CellEditingUrl { get; set; }

Property Value

Type	Description
System.String

ColumnsModels

Gets the list of columns parameters descriptions.

Declaration

public IReadOnlyList<JqGridColumnModel> ColumnsModels { get; }

Property Value

Type	Description
IReadOnlyList<JqGridColumnModel>

ColumnsNames

Gets the list of columns names.

Declaration

public IReadOnlyList<string> ColumnsNames { get; }

Property Value

Type	Description
IReadOnlyList<System.String>

CompatibilityMode

Gets or sets the jqGrid compatibility mode.

Declaration

public JqGridCompatibilityModes CompatibilityMode { get; set; }

Property Value

Type	Description
JqGridCompatibilityModes

DataString

Gets or sets the string of data which will be used when DataType is set to JqGridDataTypes.XmlString or JqGridDataTypes.JsonString (default null).

Declaration

public string DataString { get; set; }

Property Value

Type	Description
System.String

DataType

Gets or sets the type of information to expect to represent data in the grid (default JqGridDataTypes.Xml).

Declaration

public JqGridDataTypes DataType { get; set; }

Property Value

Type	Description
JqGridDataTypes

DynamicScrollingMode

Gets or sets the value which defines if dynamic scrolling is enabled.

Declaration

public JqGridDynamicScrollingModes DynamicScrollingMode { get; set; }

Property Value

Type	Description
JqGridDynamicScrollingModes

DynamicScrollingTimeout

Gets or sets the timeout (in miliseconds) if DynamicScrollingMode is set to JqGridDynamicScrollingModes.HoldVisibleRows

Declaration

public int DynamicScrollingTimeout { get; set; }

Property Value

Type	Description
System.Int32

EditingUrl

Gets or sets the url for inline and form editing.

Declaration

public string EditingUrl { get; set; }

Property Value

Type	Description
System.String

ExpandColumn

Gets or sets the name of column which should be used to expand the tree grid.

Declaration

public string ExpandColumn { get; set; }

Property Value

Type	Description
System.String

ExpandColumnClick

Gets or sets the value which defines whether the tree is expanded and/or collapsed when user clicks on the text of the expanded column, not only on the image.

Declaration

public bool ExpandColumnClick { get; set; }

Property Value

Type	Description
System.Boolean

FilterToolbar

Gets or sets the filter toolbar options.

Declaration

public JqGridFilterToolbarOptions FilterToolbar { get; set; }

Property Value

Type	Description
JqGridFilterToolbarOptions

FooterData

Gets or sets the values for the footer.

Declaration

public IEnumerable<KeyValuePair<string, string>> FooterData { get; set; }

Property Value

Type	Description
IEnumerable<KeyValuePair<System.String, System.String>>

FooterEnabled

Gets or sets the value indicating if the footer table (with one row) will be placed below the grid records and above the pager. The number of columns equal of these from ColumnsModels.

Declaration

public bool FooterEnabled { get; set; }

Property Value

Type	Description
System.Boolean

GridComplete

Gets or sets the function for event which is raised after all the data is loaded into the grid and all other processes are complete.

Declaration

public string GridComplete { get; set; }

Property Value

Type	Description
System.String

GroupHeaders

Gets or sets the grouping headers.

Declaration

public IEnumerable<JqGridGroupHeader> GroupHeaders { get; set; }

Property Value

Type	Description
IEnumerable<JqGridGroupHeader>

GroupHeadersUseColSpanStyle

Gets or sets the value which determines if the non grouping header cell should have cell above it (false), or the column should be treated as one combining boot (true).

Declaration

public bool GroupHeadersUseColSpanStyle { get; set; }

Property Value

Type	Description
System.Boolean

GroupingEnabled

Gets or sets the value indicating if the grouping is enabled.

Declaration

public bool GroupingEnabled { get; set; }

Property Value

Type	Description
System.Boolean

GroupingView

Gets or sets the grouping view options.

Declaration

public JqGridGroupingView GroupingView { get; set; }

Property Value

Type	Description
JqGridGroupingView

Height

Gets or sets the height of the grid in pixels (default '100%').

Declaration

public int? Height { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

IconSet

Gets or sets the icon set of the grid.

Declaration

public JqGridIconSets IconSet { get; set; }

Property Value

Type	Description
JqGridIconSets

Id

Gets the grid identifier which will be used for table (id='{0}'), pager div (id='{0}Pager') and in JavaScript.

Declaration

public string Id { get; }

Property Value

Type	Description
System.String

InlineNavigator

Gets or sets the inline navigator options.

Declaration

public JqGridInlineNavigatorOptions InlineNavigator { get; set; }

Property Value

Type	Description
JqGridInlineNavigatorOptions

JsonReader

Gets or sets the JSON reader for the grid.

Declaration

public JqGridJsonReader JsonReader { get; set; }

Property Value

Type	Description
JqGridJsonReader

LoadComplete

Gets or sets the function for event which is raised immediately after every server request.

Declaration

public string LoadComplete { get; set; }

Property Value

Type	Description
System.String

MethodType

Gets or sets the type of request to make (default JqGridMethodTypes.Get).

Declaration

public JqGridMethodTypes MethodType { get; set; }

Property Value

Type	Description
JqGridMethodTypes

Navigator

Gets or sets the navigator options.

Declaration

public JqGridNavigatorOptions Navigator { get; set; }

Property Value

Type	Description
JqGridNavigatorOptions

OnSelectRow

Gets or sets the function for event which is raised immediately after row was clicked.

Declaration

public string OnSelectRow { get; set; }

Property Value

Type	Description
System.String

Pager

Gets or sets if grid should use a pager bar to navigate through the records (default: false).

Declaration

public bool Pager { get; set; }

Property Value

Type	Description
System.Boolean

ParametersNames

Gets or sets customized names for jqGrid request parameters.

Declaration

public JqGridParametersNames ParametersNames { get; set; }

Property Value

Type	Description
JqGridParametersNames

PostData

Gets or sets the additional data which will be added to the request.

Declaration

public object PostData { get; set; }

Property Value

Type	Description
System.Object

PostDataScript

Gets or sets the JavaScript which will dynamically generate the additional data which will be added to the request (this property takes precedence over PostData).

Declaration

public string PostDataScript { get; set; }

Property Value

Type	Description
System.String

RequestInitialServerSearching

Gets or sets the value indicating if the first request to the server should perform search.

Declaration

public bool RequestInitialServerSearching { get; set; }

Property Value

Type	Description
System.Boolean

RowsList

Gets or sets an array to construct a select box element in the pager in which user can change the number of the visible rows.

Declaration

public IList<int> RowsList { get; set; }

Property Value

Type	Description
IList<System.Int32>

RowsNumber

Gets or sets how many records should be displayed in the grid (default 20).

Declaration

public int RowsNumber { get; set; }

Property Value

Type	Description
System.Int32

SortingName

Gets or sets the initial sorting column index, when using data returned from server

Declaration

public string SortingName { get; set; }

Property Value

Type	Description
System.String

SortingOrder

Gets or sets the initial sorting order, when using data returned from server (default JqGridSortingOrders.Asc)

Declaration

public JqGridSortingOrders SortingOrder { get; set; }

Property Value

Type	Description
JqGridSortingOrders

Styling

Get or sets the styling of the grid.

Declaration

public JqGridStylings Styling { get; set; }

Property Value

Type	Description
JqGridStylings

SubGridBeforeExpand

Gets or sets the function for event which is raised just before expanding the subgrid.

Declaration

public string SubGridBeforeExpand { get; set; }

Property Value

Type	Description
System.String

SubgridColumnWidth

Gets or sets the width of subgrid expand/colapse column.

Declaration

public int SubgridColumnWidth { get; set; }

Property Value

Type	Description
System.Int32

SubgridEnabled

Gets or sets the value which defines if subgrid is enabled.

Declaration

public bool SubgridEnabled { get; set; }

Property Value

Type	Description
System.Boolean

SubgridModel

Gets or sets the subgrid model.

Declaration

public JqGridSubgridModel SubgridModel { get; set; }

Property Value

Type	Description
JqGridSubgridModel

SubgridOptions

Gets or sets the subgrid options for "Subgrid as Grid" scenario.

Declaration

public JqGridOptions SubgridOptions { get; set; }

Property Value

Type	Description
JqGridOptions

SubGridRowColapsed

Gets or sets the function for event which is raised when the user clicks on the minus icon of the grid.

Declaration

public string SubGridRowColapsed { get; set; }

Property Value

Type	Description
System.String

SubGridRowExpanded

Gets or sets the function for event which is raised when the user clicks on the plus icon of the grid.

Declaration

public string SubGridRowExpanded { get; set; }

Property Value

Type	Description
System.String

SubgridUrl

Gets or sets the url for subgrid data requests.

Declaration

public string SubgridUrl { get; set; }

Property Value

Type	Description
System.String

TopPager

Gets or sets the value indicating if jqGrid should place a pager element at top of the grid below the caption (if available).

Declaration

public bool TopPager { get; set; }

Property Value

Type	Description
System.Boolean

TreeGridEnabled

Gets or sets the value which defines if TreeGrid is enabled.

Declaration

public bool TreeGridEnabled { get; set; }

Property Value

Type	Description
System.Boolean

TreeGridModel

Gets or sets the model for TreeGrid.

Declaration

public JqGridTreeGridModels TreeGridModel { get; set; }

Property Value

Type	Description
JqGridTreeGridModels

Url

Gets or sets the url for data requests

Declaration

public string Url { get; set; }

Property Value

Type	Description
System.String

UseFormattersForFooterData

Gets or sets the value indicating if formatters should be used in case of providing values for footer through FooterData.

Declaration

public bool UseFormattersForFooterData { get; set; }

Property Value

Type	Description
System.Boolean

UserDataOnFooter

Gets or sets the value indicating if the values from user data should be placed on footer.

Declaration

public bool UserDataOnFooter { get; set; }

Property Value

Type	Description
System.Boolean

ViewRecords

Gets or sets if grid should display the beginning and ending record number out of the total number of records in the query (default: false)

Declaration

public bool ViewRecords { get; set; }

Property Value

Type	Description
System.Boolean

Methods

AddColumn(String, JqGridColumnModel)

Adds column to options.

Declaration

public void AddColumn(string columnName, JqGridColumnModel columnModel)

Parameters

Type	Name	Description
System.String	columnName	The column name.
JqGridColumnModel	columnModel	The column model.

InsertColumn(Int32, String, JqGridColumnModel)

Inserts column to options.

Declaration

public void InsertColumn(int position, string columnName, JqGridColumnModel columnModel)

Parameters

Type	Name	Description
System.Int32	position	The column position.
System.String	columnName	The column name.
JqGridColumnModel	columnModel	The column model.