Create the best Web experiences in browsers and devices with our user interface controls designed expressly for jQuery, ASP.NET MVC, HTML 5 and CSS 3. You’ll be building on a solid and proven foundation without any plug-ins or extensions, just real world best practices and the most forward-thinking, robust Web technology.

Infragistics NetAdvantage jQuery API Reference

ui.igGridUpdating

The API below details the options, methods, events, and classes of the igGrid's updating feature. This feature is currently a CTP and subject to change. For more igGrid API details, see the igGrid API document.

Dependencies

jquery-1.4.4.js
jquery.ui.core.js
jquery.ui.widget.js
ig.ui.grid.framework.js
ig.ui.editors.js
ig.ui.validator.js
ig.ui.shared.js
ig.datasource.js
ig.util.js

  • autoCommit

    Type:
    enumeration
    Default:
    true

    Sets gets automatic commit on any change like add-new-row, delete row and end edit.

    Members

    • true
    • Type:bool
    • Auto commit is enabled.
    • false
    • Type:bool
    • No auto commint.

  • columnSettings

    Type:
    array
    Default:
    []
    Elements Type:
    object

    Sets gets array of settings for each column.

    • columnKey

      Type:
      string
      Default:
      null

      Sets gets identifier for column. That value should correspond to the "key" of a column in the "columns" of igGrid.

    • defaultValue

      Type:
      object
      Default:
      null

      Sets gets default value in cell for add-new-row. That can be string, number, Date or boolean.

    • editorOptions

      Type:
      object
      Default:
      null

      Sets gets options supported by igEditor.

    • editorType

      Type:
      enumeration
      Default:
      null

      Sets type of editor. Note: if that option is set to 'datepicker', then application should ensure that css and js files used by jquery.ui.datepicker are available.

      Members

      • text
      • Type:string
      • Text editor is created.
      • 0
      • Type:number
      • Text editor is created (same as 'text').
      • mask
      • Type:string
      • Mask editor is created.
      • 1
      • Type:number
      • Mask editor is created (same as 'mask').
      • 2
      • Type:number
      • Date-time editor is created (same as 'date').
      • datepicker
      • Type:string
      • Date-picker is created.
      • 3
      • Type:number
      • Date-picker is created (same as 'datepicker').
      • numeric
      • Type:string
      • Numeric editor is created.
      • 4
      • Type:number
      • Numeric editor is created (same as 'numeric').
      • currency
      • Type:string
      • Currency editor is created.
      • 5
      • Type:number
      • Currency editor is created (same as 'currency').
      • percent
      • Type:string
      • Percent editor is created.
      • 6
      • Type:number
      • Percent editor is created (same as 'percent').
      • date
      • Type="string" date-time editor is created.

    • readOnly

      Type:
      enumeration
      Default:
      null

      Sets gets read only.

      Members

      • true
      • Type:bool
      • Exclude cells in column from editing.
      • false
      • Type:bool
      • Allow editing cells in column.

    • required

      Type:
      enumeration
      Default:
      null

      Sets gets validation for required entry.

      Members

      • true
      • Type:bool
      • Validate for required entry.
      • false
      • Type:bool
      • Do not validate for required entry.

    • validation

      Type:
      enumeration
      Default:
      null

      Sets gets validation of cell.

      Members

      • true
      • Type:bool
      • Enable validation according to rules of igEditor, such as min/maxValue in numeric/date editors, etc.
      • false
      • Type:bool
      • Do not enable validation.

  • editMode

    Type:
    enumeration
    Default:
    row

    Sets gets edit mode.

    Members

    • row
    • Type:string
    • cell
    • Type:string
    • none
    • Type:string
    • null
    • Type:object

  • enableAddRow

    Type:
    enumeration
    Default:
    true

    Sets gets add-new-row functionality.

    Members

    • true
    • Type:bool
    • The "Add Row" button is displayed on header, click on that button shows editors in all columns and new row inserted at the end of editing.
    • false
    • Type:bool
    • Add-row is disabled.

  • enableDeleteRow

    Type:
    enumeration
    Default:
    true

    Sets gets delete-row functionality.

    Members

    • true
    • Type:bool
    • The "Delete" button is displayed on mouse-over a row and all selected rows are deleted by Delete-key.
    • false
    • Type:bool
    • Delete-row is disabled.

  • locale

    Type:
    enumeration
    Default:
    null

    Sets gets strings for titles and buttons used by igGridUpdating. Note: any suboption of locale can appear within the main option of igEditor. In this case those values within main options will have highest priority and override corresponding value in locale.

    Members

      • string
      • Values can be such as "bg", "fr", etc., the editor will attempt to find and use $.ui.igGridUpdating.locale[valueOfOption] object.
      • object
      • Should contain pairs or key:value members.

  • showAddRowIcon

    Type:
    enumeration
    Default:
    true

    Sets gets visibility of the icon on the add-new-row button.

    Members

    • true
    • Type:bool
    • Icon is displayed.
    • false
    • Type:bool
    • No icon.

  • showAddRowText

    Type:
    enumeration
    Default:
    true

    Sets gets visibility of the text on the add-new-row button.

    Members

    • true
    • Type:bool
    • Text is displayed.
    • false
    • Type:bool
    • No text.

  • showCancelIcon

    Type:
    enumeration
    Default:
    true

    Sets gets visibility of the icon on the Cancel editing button.

    Members

    • true
    • Type:bool
    • Icon is displayed.
    • false
    • Type:bool
    • No icon.

  • showDeleteIcon

    Type:
    enumeration
    Default:
    true

    Sets gets visibility of the icon on the Delete-row button.

    Members

    • true
    • Type:bool
    • Icon is displayed.
    • false
    • Type:bool
    • No icon.

  • showDeleteText

    Type:
    enumeration
    Default:
    true

    Sets gets visibility of the text on the Delete-row button. Note: text is defined by the locale.deleteText option.

    Members

    • true
    • Type:bool
    • Text is displayed.
    • false
    • Type:bool
    • No text.

  • showDoneCancelButtons

    Type:
    enumeration
    Default:
    true

    Sets gets visibility of the end-edit pop-up dialog with Done/Cancel buttons.

    Members

    • true
    • Type:bool
    • End-edit pop-up is used.
    • false
    • Type:bool
    • No confirm pop-up.

  • showDoneIcon

    Type:
    enumeration
    Default:
    true

    Sets gets visibility of the icon on the Done editing button.

    Members

    • true
    • Type:bool
    • Icon is displayed.
    • false
    • Type:bool
    • No icon.

  • startEditTriggers

    Type:
    string
    Default:
    click,f2,enter

    Sets gets triggers for start edit mode.
    Possible values: "click", "dblclick", "F2", "enter" and their combinations separated by coma.

  • validation

    Type:
    enumeration
    Default:
    false

    Sets gets validation for all columns.

    Members

    • true
    • Type:bool
    • The validation for all columns is enabled.
    • false
    • Type:bool
    • Validation is disabled.

  • editCellEnded

    Cancellable:
    false

    Event which is raised after end cell editing.
    Function takes arguments evt and ui.
    Use ui.row to get key or index of row.
    Use ui.column to get index of column.
    Use ui.key to get key of column.
    Use ui.editor to get reference to igEditor.
    Use ui.value to get value of cell.
    Use ui.update to check if cell was modified and data source will be updated.
    Use ui.rowAdding to check if that event is raised while new-row-adding.

  • editCellEnding

    Cancellable:
    true

    Event which is raised before end cell editing.
    Return false in order to cancel update of data source.
    Function takes arguments evt and ui.
    Use ui.row to get key or index of row.
    Use ui.column to get index of column.
    Use ui.key to get key of column.
    Use ui.editor to get reference to igEditor.
    Use ui.value to get value of cell/editor. That value can be modified and it will be used to update data source.
    Use ui.update to check if value was modified and data source will be updated.
    Use ui.rowAdding to check if that event is raised while new-row-adding.

  • editCellStarted

    Cancellable:
    false

    Event which is raised after start cell editing.
    Function takes arguments evt and ui.
    Use ui.row to get key or index of row.
    Use ui.column to get index of column.
    Use ui.key to get key of column.
    Use ui.editor to get reference to igEditor.
    Use ui.value to get value of editor.
    Use ui.rowAdding to check if that event is raised while new-row-adding.

  • editCellStarting

    Cancellable:
    true

    Event which is raised before start cell editing.
    Return false in order to cancel start editing and do not show editors.
    Function takes arguments evt and ui.
    Use ui.row to get key or index of row.
    Use ui.column to get index of column.
    Use ui.key to get key of column.
    Use ui.editor to get reference to igEditor.
    Use ui.value to get or set value of editor.
    Use ui.rowAdding to check if that event is raised while new-row-adding.

  • editRowEnded

    Cancellable:
    false

    Event which is raised after end row editing.
    Function takes arguments evt and ui.
    Use ui.row to get key or index of row.
    Use ui.update to check if value of any cell was modified and data source will be updated.
    Use ui.rowAdding to check if that event is raised while new-row-adding.

  • editRowEnding

    Cancellable:
    true

    Event which is raised before end row editing.
    Return false in order to cancel update of data source.
    Function takes arguments evt and ui.
    Use ui.row to get key or index of row.
    Use ui.keepEditing=true in order to keep editing.
    Use ui.update to check if value of any cell was modified and data source will be updated.
    Use ui.rowAdding to check if that event is raised while new-row-adding.

  • editRowStarted

    Cancellable:
    false

    Event which is raised after start row editing.
    Function takes arguments evt and ui.
    Use ui.row to get key or index of row.
    Use ui.rowAdding to check if that event is raised while new-row-adding.

  • editRowStarting

    Cancellable:
    true

    Event which is raised before start row editing.
    Return false in order to cancel editing and do not show editors in row.
    Function takes arguments evt and ui.
    Use ui.row to get key or index of row.
    Use ui.rowAdding to check if that event is raised while new-row-adding.

  • rowAdded

    Cancellable:
    false

    Event which is raised after adding new row.
    Function takes arguments evt and ui.
    Use ui[keyOfColumn] to get value of cell in column with the key equals to keyOfColumn.

  • rowAdding

    Cancellable:
    true

    Event which is raised before adding new row.
    Return false in order to cancel adding new row to data source.
    Function takes arguments evt and ui.
    Use ui[keyOfColumn] to get or set value of cell in column with the key equals to keyOfColumn. These cell values can be modified and they will be used to update data source.

  • rowDeleted

    Cancellable:
    false

    Event which is raised after row deleting.
    Function takes arguments evt and ui.
    Use ui.element to get reference to jquery object which represents TR of row to delete.
    Use ui.row to get key or index of row to delete.

  • rowDeleting

    Cancellable:
    true

    Event which is raised before row deleting.
    Return false in order to cancel.
    Function takes arguments evt and ui.
    Use ui.element to get reference to jquery object which represents TR of row to delete.
    Use ui.row to get key or index of row to delete.

  • destroy

    .igGridUpdating( "destroy" );
    Return Type:
    object

    Destroys igGridUpdating.

  • editorForCell

    .igGridUpdating( "editorForCell", td:jquery, [add:bool] );
    Return Type:
    object

    Find or create editor which is used for a jquery TD object.

    • td
    • Type:jquery
    • Reference to jquery TD object.
    • add
    • Type:bool
    • Optional
    • Value true should be used if first parameter TD belongs to add-new-row.

  • editorForKey

    .igGridUpdating( "editorForKey", key:object );
    Return Type:
    object

    Find editor for a column with key.

    • key
    • Type:object
    • Key of column. That can be string or number.

  • endEdit

    .igGridUpdating( "endEdit", [update:bool], [e:object] );
    Return Type:
    bool

    End row editing.

    • update
    • Type:bool
    • Optional
    • Request to update grid with new values.
    • e
    • Type:object
    • Optional
    • Browser event. If it is defined, then events are raised.

  • findInvalid

    .igGridUpdating( "findInvalid" );

    Find column-key which editor has invalid value. It has effect only while row-editing in on.
    returnType="string|number" Return key of column which editor has invalid value and validation of column is enabled.

  • isEditing

    .igGridUpdating( "isEditing" );
    Return Type:
    bool

    Check if editing is on.

  • numberOfRows

    .igGridUpdating( "numberOfRows" );
    Return Type:
    number

    Get number of rows in grid.

  • startAddRowEdit

    .igGridUpdating( "startAddRowEdit", [e:object] );
    Return Type:
    bool

    Start row editing.

    • e
    • Type:object
    • Optional
    • Browser event. If it is defined, then events are raised.

  • startEdit

    .igGridUpdating( "startEdit", row:number, col:number, [e:object] );
    Return Type:
    bool

    Start editing.

    • row
    • Type:number
    • Index of row.
    • col
    • Type:number
    • Index of column.
    • e
    • Type:object
    • Optional
    • Browser event. If it is defined, then events are raised.

  • ui-iggrid-addrow ui-widget-header

    Classes applied to the add-new-row button. Default value is 'ui-iggrid-addrow ui-widget-header.

  • ui-iggrid-addrowactive ui-state-active

    Classes applied to the add-new-row button in active/focus state. Default value is 'ui-iggrid-addrowactive ui-state-active.

  • ui-iggrid-addrowhover ui-state-hover

    Classes applied to the add-new-row button in mouse-over state. Default value is 'ui-iggrid-addrowhover ui-state-hover.

  • ui-iggrid-addrowicon ui-icon ui-icon-circle-plus

    Classes applied to the icon on add-new-row button. Default value is 'ui-iggrid-addrowicon ui-icon ui-icon-circle-plus.

  • ui-iggrid-button ui-state-default

    Classes applied to the buttons. Default value is 'ui-iggrid-button ui-state-default.

  • ui-iggrid-buttonactive ui-state-active

    Classes applied to buttons in active/focus state. Default value is 'ui-iggrid-buttonactive ui-state-active.

  • ui-iggrid-buttoncontainer ui-widget-content

    Classes applied to the container of Done and Cancel editing buttons. Default value is 'ui-iggrid-buttoncontainer ui-widget-content.

  • ui-iggrid-buttondisabled ui-state-disabled

    Classes applied to buttons in disabled state. Default value is 'ui-iggrid-buttondisabled ui-state-disabled.

  • ui-iggrid-buttonhover ui-state-hover

    Classes applied to buttons in mouse-over state. Default value is 'ui-iggrid-buttonhover ui-state-hover.

  • ui-iggrid-cancelbutton

    Class applied to the Cancel button. Default value is 'ui-iggrid-cancelbutton.

  • ui-iggrid-cancelicon ui-icon ui-icon-cancel

    Classes applied to the icon on Done button. Default value is 'ui-iggrid-cancelicon ui-icon ui-icon-cancel.

  • ui-iggrid-deletebutton ui-state-default

    Classes applied to the Delete button. Default value is 'ui-iggrid-deletebutton ui-state-default.

  • ui-iggrid-deleteicon ui-icon ui-icon-circle-close

    Classes applied to the icon on Delete button. Default value is 'ui-iggrid-deleteicon ui-icon ui-icon-circle-close.

  • ui-iggrid-donebutton ui-priority-primary

    Classes applied to the Done button. Default value is 'ui-iggrid-donebutton ui-priority-primary.

  • ui-iggrid-doneicon ui-icon ui-icon-check

    Classes applied to the icon on Done button. Default value is 'ui-iggrid-doneicon ui-icon ui-icon-check.

  • ui-iggrid-editingcell

    Classes applied to the editing cells. Default value is 'ui-iggrid-editingcell.

  • ui-iggrid-editor

    Class applied to editors. Default value is 'ui-iggrid-editor.