Class JqGridColumnEditableAttribute

Specifies the editing options for column

Inheritance
System.Object
JqGridColumnElementAttribute
JqGridColumnEditableAttribute
Inherited Members
Namespace: Lib.AspNetCore.Mvc.JqGrid.DataAnnotations
Assembly: Lib.AspNetCore.Mvc.JqGrid.DataAnnotations.dll
Syntax
public class JqGridColumnEditableAttribute : JqGridColumnElementAttribute

Constructors

JqGridColumnEditableAttribute()

Initializes a new instance of the JqGridColumnEditableAttribute class.

Declaration
public JqGridColumnEditableAttribute()

JqGridColumnEditableAttribute(Boolean)

Initializes a new instance of the JqGridColumnEditableAttribute class.

Declaration
public JqGridColumnEditableAttribute(bool editable)
Parameters
Type Name Description
System.Boolean editable

If this column can be edited

JqGridColumnEditableAttribute(String)

Initializes a new instance of the JqGridColumnEditableAttribute class.

Declaration
public JqGridColumnEditableAttribute(string route)
Parameters
Type Name Description
System.String route

The name of the route to be used to generate URL to get the AJAX data for the select element (if type is JqGridColumnEditTypes.Select) or jQuery UI Autocomplete widget (if type is JqGridColumnEditTypes.Autocomplete).

JqGridColumnEditableAttribute(String, String)

Initializes a new instance of the JqGridColumnEditableAttribute class.

Declaration
public JqGridColumnEditableAttribute(string action, string controller)
Parameters
Type Name Description
System.String action

The name of the action method to get the AJAX data for the select element (if type is JqGridColumnEditTypes.Select) or jQuery UI Autocomplete widget (if type is JqGridColumnEditTypes.Autocomplete).
System.String controller

The name of the controller to get the AJAX data for the select element (if type is JqGridColumnEditTypes.Select) or jQuery UI Autocomplete widget (if type is JqGridColumnEditTypes.Autocomplete).

JqGridColumnEditableAttribute(Type, String)

Initializes a new instance of the JqGridColumnEditableAttribute class.

Declaration
public JqGridColumnEditableAttribute(Type valueProviderType, string valueProviderMethodName)
Parameters
Type Name Description
Type valueProviderType

The type of class which contains a method which will provide data for select element (if type is JqGridColumnEditTypes.Select). This class must have public parameterless constructor.
System.String valueProviderMethodName

The name of method which will provide data for select element (if type is JqGridColumnEditTypes.Select). This method must return an object which implements IDictionary<string, string>.

Properties

CustomElementFunction

Gets or sets the name of function which is used to create custom edit element

Declaration
public string CustomElementFunction { get; set; }
Property Value
Type Description
System.String

CustomElementValueFunction

Gets or sets the name of function which should return the value from the custom element after the editing.

Declaration
public string CustomElementValueFunction { 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 the value defining if this column can be edited.

Declaration
public bool Editable { get; }
Property Value
Type Description
System.Boolean

EditHidden

Gets or sets the value which defines if hidden column can be edited in form editing.

Declaration
public bool EditHidden { get; set; }
Property Value
Type Description
System.Boolean

EditOptions

Gets options for jqGrid editable column.

Declaration
public JqGridColumnEditOptions EditOptions { get; }
Property Value
Type Description
JqGridColumnEditOptions

EditType

Gets or sets the type of the editable field (default JqGridColumnEditTypes.Text).

Declaration
public JqGridColumnEditTypes EditType { get; set; }
Property Value
Type Description
JqGridColumnEditTypes

ElementOptions

Gets the options for jqGrid editable or searchable column element.

Declaration
protected override JqGridColumnElementOptions ElementOptions { get; }
Property Value
Type Description
JqGridColumnElementOptions
Overrides

FormColumnPosition

Gets or sets the column position of the element (with the label) in form editing (one-based).

Declaration
public int FormColumnPosition { get; set; }
Property Value
Type Description
System.Int32

FormElementPrefix

Gets or sets the text or HTML content to appear before the input element in form editing.

Declaration
public string FormElementPrefix { get; set; }
Property Value
Type Description
System.String

FormElementSuffix

Gets or sets the text or HTML content to appear after the input element in form editing.

Declaration
public string FormElementSuffix { get; set; }
Property Value
Type Description
System.String

FormLabel

Gets or sets the text which will replace the name from ColumnNames as label in form editing.

Declaration
public string FormLabel { get; set; }
Property Value
Type Description
System.String

FormOptions

Gets additional options, used in form editing, for jqGrid editable column.

Declaration
public JqGridColumnFormOptions FormOptions { get; }
Property Value
Type Description
JqGridColumnFormOptions

FormRowPosition

Gets or sets the row position of the element (with the label) in form editing (one-based).

Declaration
public int FormRowPosition { get; set; }
Property Value
Type Description
System.Int32

NullIfEmpty

Gets or sets the value which defines if null value should be send to server if the field is empty.

Declaration
public bool NullIfEmpty { get; set; }
Property Value
Type Description
System.Boolean

PostData

When overriden in delivered class, provides additional data which will be added to the AJAX request to get the data for the select element (if EditType is JqGridColumnEditTypes.Select).

Declaration
public virtual object PostData { get; }
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 AJAX request to get the data for the select element (if EditType is JqGridColumnEditTypes.Select). This property takes precedence over PostData.

Declaration
public string PostDataScript { get; set; }
Property Value
Type Description
System.String