Class JqGridColumnModel

jqGrid column parameters description.

Inheritance

System.Object

JqGridColumnModel

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

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

Syntax

public class JqGridColumnModel : object

Constructors

JqGridColumnModel(String)

Initializes a new instance of the JqGridColumnModel class.

Declaration

public JqGridColumnModel(string name)

Parameters

Type	Name	Description
System.String	name	The unique name for the column.

Properties

Alignment

Gets or sets the alignment of the cell in the grid body layer.

Declaration

public JqGridAlignments Alignment { get; set; }

Property Value

Type	Description
JqGridAlignments

CellAttributes

Gets or sets the function which can add attributes to the cell during the creation of the data (dynamically).

Declaration

public string CellAttributes { get; set; }

Property Value

Type	Description
System.String

Classes

Gets or sets additional CSS classes for the column (separated by space).

Declaration

public string Classes { get; set; }

Property Value

Type	Description
System.String

DateFormat

Gets or sets the expected date format for this column in case of date validation (default ISO date).

Declaration

public string DateFormat { get; set; }

Property Value

Type	Description
System.String

Editable

Gets or set the value defining if this column can be edited.

Declaration

public bool Editable { get; set; }

Property Value

Type	Description
System.Boolean

EditOptions

Gets or sets the options for editable column.

Declaration

public JqGridColumnEditOptions EditOptions { get; set; }

Property Value

Type	Description
JqGridColumnEditOptions

EditRules

Gets or sets the rules for editable column.

Declaration

public JqGridColumnRules EditRules { get; set; }

Property Value

Type	Description
JqGridColumnRules

EditType

Gets or sets the type for editable column.

Declaration

public JqGridColumnEditTypes EditType { get; set; }

Property Value

Type	Description
JqGridColumnEditTypes

Fixed

Gets or sets the value which defines if internal recalculation of the width of the column is disabled (default false).

Declaration

public bool Fixed { get; set; }

Property Value

Type	Description
System.Boolean

Formatter

Gets or sets the predefined formatter type ('' delimited string) or custom JavaScript formatting function name.

Declaration

public string Formatter { get; set; }

Property Value

Type	Description
System.String

FormatterOptions

Gets or sets the options for predefined formatter (every predefined formatter uses only a subset of all options), which are overwriting the defaults from the language file.

Declaration

public JqGridColumnFormatterOptions FormatterOptions { get; set; }

Property Value

Type	Description
JqGridColumnFormatterOptions

FormOptions

Get or sets additional, used in form editing, options for editable column.

Declaration

public JqGridColumnFormOptions FormOptions { get; set; }

Property Value

Type	Description
JqGridColumnFormOptions

Frozen

Gets or sets the value indicating if column shouldn't scroll out of view when user is moving horizontally across the grid.

Declaration

public bool Frozen { get; set; }

Property Value

Type	Description
System.Boolean

Hidden

Gets or sets the value which defines if this column is hidden at initialization.

Declaration

public bool Hidden { get; set; }

Property Value

Type	Description
System.Boolean

HideInDialog

Gets or sets the value which defines if column will appear in the modal dialog where users can choose which columns to show or hide.

Declaration

public bool HideInDialog { get; set; }

Property Value

Type	Description
System.Boolean

Index

Gets or sets the index name for sorting and searching (default String.Empty)

Declaration

public string Index { get; set; }

Property Value

Type	Description
System.String

InitialSortingOrder

Gets or sets the sorting order for first column sorting.

Declaration

public JqGridSortingOrders InitialSortingOrder { get; set; }

Property Value

Type	Description
JqGridSortingOrders

JsonMapping

Gets or sets the JSON mapping for the column in the incoming JSON string.

Declaration

public string JsonMapping { get; set; }

Property Value

Type	Description
System.String

Key

Defines if this column value should be used as unique row id (in case there is no id from the server).

Declaration

public bool Key { get; set; }

Property Value

Type	Description
System.Boolean

Name

Gets the unique name for the column.

Declaration

public string Name { get; }

Property Value

Type	Description
System.String

Resizable

Gets or sets the value which defines if column can be resized (default true).

Declaration

public bool Resizable { get; set; }

Property Value

Type	Description
System.Boolean

Searchable

Gets or sets the value defining if this column can be searched.

Declaration

public bool Searchable { get; set; }

Property Value

Type	Description
System.Boolean

SearchOptions

Gets or sets the options for searchable column.

Declaration

public JqGridColumnSearchOptions SearchOptions { get; set; }

Property Value

Type	Description
JqGridColumnSearchOptions

SearchRules

Gets or sets the additional conditions for validating user input in search field.

Declaration

public JqGridColumnRules SearchRules { get; set; }

Property Value

Type	Description
JqGridColumnRules

SearchType

Gets or sets the type of the search field for the column.

Declaration

public JqGridColumnSearchTypes SearchType { get; set; }

Property Value

Type	Description
JqGridColumnSearchTypes

Sortable

Gets or sets the value defining if this column can be sorted.

Declaration

public bool Sortable { get; set; }

Property Value

Type	Description
System.Boolean

SortFunction

Gets or sets the custom sorting function when the SortType is set to JqGridColumnSortTypes.Function.

Declaration

public string SortFunction { get; set; }

Property Value

Type	Description
System.String

SortType

Gets or sets the type of the column for appropriate sorting when datatype is local.

Declaration

public JqGridSortTypes SortType { get; set; }

Property Value

Type	Description
JqGridSortTypes

SummaryFunction

Gets or sets the grouping summary function for custom type.

Declaration

public string SummaryFunction { get; set; }

Property Value

Type	Description
System.String

SummaryTemplate

Gets or sets the grouping summary template.

Declaration

public string SummaryTemplate { get; set; }

Property Value

Type	Description
System.String

SummaryType

Gets or sets the grouping summary type.

Declaration

public JqGridColumnSummaryTypes? SummaryType { get; set; }

Property Value

Type	Description
System.Nullable<JqGridColumnSummaryTypes>

Title

Gets or sets the value which defines if the title should be displayed in the column when user hovers a cell with the mouse.

Declaration

public bool Title { get; set; }

Property Value

Type	Description
System.Boolean

UnFormatter

Gets or sets the custom function to "unformat" a value of the cell when used in editing or client-side sorting

Declaration

public string UnFormatter { get; set; }

Property Value

Type	Description
System.String

Viewable

Gets or sets the value which defines if the column should appear in view form.

Declaration

public bool Viewable { get; set; }

Property Value

Type	Description
System.Boolean

Width

Gets or sets the initial width in pixels of the column (default 150).

Declaration

public int Width { get; set; }

Property Value

Type	Description
System.Int32

XmlMapping

Gets or sets the XML mapping for the column in the incomming XML file.

Declaration

public string XmlMapping { get; set; }

Property Value

Type	Description
System.String