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.igDatePicker

The igDatePicker extends the functionality of the igDateEditor and requires the jQuery UI Datepicker script to be included in the page (jquery.ui.datepicker.js). Code examples for options defined or extended on the igDatePicker are found below. For more igDatePicker API details, refer to the igDateEditor and igEditor API documentation. For more information on customizing the jQuery UI Datepicker, see the online documentation: http://jqueryui.com/demos/datepicker/

Dependencies

  • &nbspborderBetweenFieldAndButtons

    Type:
    bool
    Default:
    false

    Sets gets ability to keep left and/or right borders of input-field unchanged if buttons are enabled. Default is false. Value false will remove borders.

  • button

    Type:
    string
    Default:
    dropdown

    Sets gets visibility of spin and drop-down button.
    Default is "dropdown".
    That option can be set only on initialization.
    Possible values:
    "dropdown": button to open list is located on the right side of input-field (or left side if base html element has direction:rtl);
    "clear": button to clear value is located on the right side of input-field (or left side if base html element has direction:rtl);
    "spin": spin buttons are located on the right side of input-field (or left side if base html element has direction:rtl);.

    Code Sample

     
            //Initialize
            $('.selector').igDatePicker({
                button : 'none'
            });
          
  • &nbspbuttonHidden

    Type:
    bool
    Default:
    false

    Sets gets visibility of dropdown button. Default is false. That option has effect only when dropdown or clear button is enabled.

  • &nbspcenturyThreshold

    Type:
    number
    Default:
    29

    Sets gets year for auto detection of 20th and 21st centuries.
    That value is used to fill century of entered year when user entered only 1 or 2 digits into the year field or when date pattern includes on 1 or 2 positions for year: "yy" or "y".
    If user entered value larger than value of this option, then 20th century is used, otherwise the 21st. Default is 29.

  • &nbspdataMode

    Type:
    enumeration
    Default:
    date

    Members

    • string
    • Type:unknown
    • number
    • Type:unknown
  • &nbspdateDisplayFormat

    Type:
    string
    Default:
    null

    Sets gets format of date while editor has no focus.
    Value of that option can be set to explicit date pattern or to a flag defined by regional settings.
    If value is not set, then the dateInputFormat is used automatically.
    If value is set to explicit date pattern and pattern besides date-flags has explicit characters which match with date-flags or mask-flags, then the "escape" character should be used in front of them.
    Default is null and $.ig.regional.defaults is used.
    List of predefined regional flags:
    "date": the datePattern member of regional option is used
    "dateLong": the dateLongPattern member of regional option is used
    "time": the timePattern member of regional option is used
    "timeLong": the timeLongPattern member of regional option is used
    "dateTime": the dateTimePattern member of regional option is used
    List of explicit characters, which should have escape \\ character in front of them:
    C, &, a, A, ?, L, 9, 0, #, >, <, y, M, d, h, H, m, s, t, f.
    List of date-flags when explicit date pattern is used:
    "y": year field without century and without leading zero
    "yy": year field without century and with leading zero
    "yyyy": year field with leading zeros
    "M": month field as digit without leading zero
    "MM": month field as digit with leading zero
    "MMM": month field as short month name
    "MMMM": month field as long month name
    "d": day of month field without leading zero
    "dd": day of month field with leading zero
    "ddd": day of the week as short name
    "dddd": day of the week as long name
    "t": first character of string which represents AM/PM field
    "tt": 2 characters of string which represents AM/PM field
    "h": hours field in 12-hours format without leading zero
    "hh": hours field in 12-hours format with leading zero
    "H": hours field in 24-hours format without leading zero
    "HH": hours field in 24-hours format with leading zero
    "m": minutes field without leading zero
    "mm": minutes field with leading zero
    "s": seconds field without leading zero
    "ss": seconds field with leading zero
    "f": milliseconds field in thousands
    "ff": milliseconds field in hundreds
    "fff": milliseconds field.

  • &nbspdateInputFormat

    Type:
    string
    Default:
    null

    Sets gets format of date while editor has focus.
    Value of that option can be set to explicit date pattern or to a flag defined by regional settings.
    If value is set to explicit date pattern and pattern besides date-flags has explicit characters which match with date-flags or mask-flags, then the "escape" character should be used in front of them.
    If option is not set, then the "date" is used automatically.
    Default is null.
    List of predefined regional flags:
    "date": the datePattern member of regional option is used
    "dateLong": the dateLongPattern member of regional option is used
    "time": the timePattern member of regional option is used
    "timeLong": the timeLongPattern member of regional option is used
    "dateTime": the dateTimePattern member of regional option is used
    List of explicit characters, which should have escape \\ character in front of them: C, &, a, A, ?, L, 9, 0, #, >, <, y, M, d, h, H, m, s, t, f.
    List of date-flags when explicit date pattern is used:
    "y": year field without century and without leading zero
    "yy": year field without century and with leading zero
    "yyyy": year field with leading zeros
    "M": month field as digit without leading zero
    "MM": month field as digit with leading zero
    "MMM": month field as short month name
    "MMMM": month field as long month name
    "d": day of month field without leading zero
    "dd": day of month field with leading zero
    "ddd": day of the week as short name
    "dddd": day of the week as long name
    "t": first character of string which represents AM/PM field
    "tt": 2 characters of string which represents AM/PM field
    "h": hours field in 12-hours format without leading zero
    "hh": hours field in 12-hours format with leading zero
    "H": hours field in 24-hours format without leading zero
    "HH": hours field in 24-hours format with leading zero
    "m": minutes field without leading zero
    "mm": minutes field with leading zero
    "s": seconds field without leading zero
    "ss": seconds field with leading zero
    "f": milliseconds field in thousands
    "ff": milliseconds field in hundreds
    "fff": milliseconds field.

  • datepickerOptions

    Type:
    object
    Default:
    null

    Sets gets options supported by the jquery.ui.datepicker. Default is null.

  • &nbspdisplay

    Type:
    string
    Default:
    inline-block

    Sets gets style.display for outer html element.
    Default is "inline-block".
    The value of "" will disable changing style.display.
    If base html element is not INPUT, TEXTAREA, SPAN or DIV, then it is recommended to set value of that option to empty string.
    Because, some browsers may fail to handle display other than default value of browser.
    For example, if base element for editor is TD, then behavior of Chrome can be problematic.

  • &nbspdropDownOnReadOnly

    Type:
    bool
    Default:
    false

    Default is false. Sets gets ability to override the "readOnly" option and allow to show drop-down list and change "value" of editor from list. Value false does not allow drop-down when "readOnly" is true.

  • &nbspdropDownTriggers

    Type:
    string
    Default:
    button,ctrl+arrow,alt+arrow

    Sets gets list of actions which trigger display of drop-down list or calendar.
    Default is "button,ctrl+arrow,alt+arrow".
    The list should include flags separated by the "," character. Flags may include optional "ctrl+", "shift+" or "alt+" prefix.
    If prefix is defined, then action is triggered for combination of flag-action with Ctrl, Shift or Alt key.
    Empty string disables drop-down functionality.
    Possible values of flags:
    "arrow" - down-arrow shows drop-down and up-arrow hides drop-down;
    "button" - shows and hides drop-down;
    "focus" - shows drop-down on focus.
    Any upper case character (including space): shows drop-down.

  • &nbspexcludeKeys

    Type:
    string
    Default:
    null

    Sets gets ability to prevent entering specific characters in input-field from keyboard and on paste.
    Default is null.
    Notes:
    If "includeKeys" option contains same characters as this option, then "excludeKeys" has priority. Letters should be set in upper case.
    Different filtering upper and lower cases is not supported.

  • &nbspfocusOnSpin

    Type:
    bool
    Default:
    false

    Sets gets ability to automatically set focus to input-field when spin button is clicked by mouse (true), or keep focus at its original element (false).
    Default is false.
    If that option is disabled and focus element is not editor, then mouse click on spin button will keep text in editor in display (not focus) format and perform spin actions.

  • &nbspheight

    Type:
    number
    Default:
    null

    Sets gets height of editor in pixels.
    Default is null. Only positive values have effect.
    If that option is not set, then value of style.height of base html element will be used automatically. However, that value should be in the px units.

  • &nbsphideEnterKey

    Type:
    bool
    Default:
    true

    Sets gets ability to hide the Enter key from browser. False: default browser action on the Enter key. Default is true.

  • &nbsphideMaskOnFocus

    Type:
    bool
    Default:
    false

    Sets gets ability to hide mask in focus state.
    Value of true allows show or hide all input mask with prompt characters regardless if available mask positions are filled or not.
    Value of true will show only part of mask located on the left side from caret when available mask positions on the right side from caret are empty. Default is false.

  • &nbspincludeKeys

    Type:
    string
    Default:
    null

    Sets gets ability to enter only specific characters in input-field from keyboard and on paste.
    Default is null.
    Notes:
    If "excludeKeys" option contains same characters as this option, then "excludeKeys" has priority.
    Letters should be set in upper case.
    Different filtering upper and lower cases is not supported.

  • &nbsplistAnimationHide

    Type:
    number
    Default:
    450

    Sets gets duration of animation in milliseconds when drop-down list is hidden. Default is 450. If value is less than 5, then animation is disabled.

  • &nbsplistAnimationShow

    Type:
    number
    Default:
    400

    Sets gets duration of animation in milliseconds when drop-down list is displayed. Default is 400. If value is less than 5, then animation is disabled.

  • &nbsplistAutoComplete

    Type:
    bool
    Default:
    false

    Sets gets autocomplete.
    Default is false.
    Value true enables and false disables auto-complete functionality to fill value of editor by a partially matching item from the listOfItems.
    If that option is enabled and entered text does not match with a part of any item in list, then original value is preserved.
    Notes:
    That option is supported only when the "type" of editor is "text" and it has effect only when listOfItems is set.
    Partial match can be validated from the beginning of an item or anywhere within an item. That is defined by the "listMatchContains" option.
    Validation can be case sensitive or not and that is defined by the "listMatchIgnoreCase" option.

  • &nbsplistColumns

    Type:
    number
    Default:
    1

    Sets gets number of columns in drop-down list. Default is 1.

  • &nbsplistDropDownAsChild

    Type:
    bool
    Default:
    false

    Sets gets location of drop-down list.
    Default is false.
    Value true will create html element for list as a child of main html element.
    Value false creates list as a child of body.
    Notes:
    That option has effect only for drop-down defined by listOfItems.
    The value of true is supported only when main (outer) html element of editor is container such as SPAN or DIV, or buttons are enabled, or renderInContainer is enabled, the theme is set.
    The value of true allows a better positioning and can be useful when editor is located in complex layout and containers with "position:fixed".

  • &nbsplistItems

    Type:
    array
    Default:
    null
    Elements Type:

    Sets gets list of items which are used for drop-down list, spin, validation and auto-complete functionality.
    Default is null.
    Items in list can be strings, numbers, dates or objects in any combination.
    If type of editor is date or datepicker and item is string, then igEditor will try to convert it to Date object and show item in display format.
    If type of editor is numeric, currency or percent and item is string, then igEditor will try to convert it to number and show item in display format.
    If item is object and it has member "text", then that member is used.
    If item is object and besides "text" has function getHtml(), then that function is used to render item in list.
    The item or item.text is used to set "value" of particular editor when list-item is selected.

  • &nbsplistMatchContains

    Type:
    bool
    Default:
    false

    Sets gets list match contains.
    Default is false.
    Value true enables and false disables validation for partial match of entered text anywhere within an item in the listOfItems or only from the beginning of an item.
    That option has effect only when "listMatchOnly" or "listAutoComplete" options are enabled.

  • &nbsplistMatchIgnoreCase

    Type:
    bool
    Default:
    true

    Sets gets case validation. Value of false enables and true disables validation for case of entries to match with items in listOfItems.
    Default is true.
    That option has effect only when "listMatchOnly" or "listAutoComplete" options are enabled.

  • &nbsplistMatchOnly

    Type:
    bool
    Default:
    false

    Set gets list match.
    Default is false.
    Value true enables and false disables validation of keyboard entries to match with items in listOfItems.
    If that option is enabled and entered text does not match with a part of any item in list, then entry is canceled.
    Notes:
    That option is supported only when the "type" of editor is "text" and it has effect only when listOfItems is set.
    Partial match can be validated from the beginning of an item or anywhere within an item. That is defined by the "listMatchContains" option.
    Validation can be case sensitive or not and that is defined by the "listMatchIgnoreCase" option.

  • &nbsplistMaxHeight

    Type:
    number
    Default:
    300

    Sets gets maximum height of drop-down list in pixels. Default is 300. If value is equal to 0 or negative, then the height of list is defined by number of items in list.

  • &nbsplistWidth

    Type:
    number
    Default:
    0

    Sets gets custom width of drop-down list in pixels. Default is 0. If value is equal to 0 or negative, then the width of editor is used.

  • &nbsplocale

    Type:
    enumeration
    Default:
    null

    Sets gets strings used for title of buttons.

    Members

    • string
    • Type:unknown
    • Sets gets strings used for title of buttons.
    • object
    • Type:unknown
    • Sets gets strings used for title of buttons.
  • &nbspmaxLength

    Type:
    number
    Default:
    0

    Sets gets maximum length of text which can be entered by user.
    Default is 0.
    Negative values or 0 disables that behavior.
    Note: that property has no effect if "type" of editor is "mask", "date" or "datepicker".

  • &nbspmaxValue

    Type:
    date
    Default:
    null

    Sets gets the maximum value which can be entered in editor by user. Default is null.

  • &nbspminNumberOfDateFields

    Type:
    number
    Default:
    3

    Sets gets the minimum number of date fields, which makes entered date-string valid.
    All missing fields are automatically filled up from the previous valid date or by zeros or the values from the today date.
    Default is 3.
    For example, if "dateInputPattern" is set to "yyyy/MM/dd hh:mm" and user entered only first 3 fields (year, month, day), then values for hours and minutes are filled by zeros.

  • &nbspminValue

    Type:
    date
    Default:
    null

    Sets gets the minimum value which can be entered in editor by user. Default is null.

  • &nbspnullable

    Type:
    bool
    Default:
    true

    Sets gets ability of numeric and date editors to prevent null value.
    Default is true.
    If that option is disabled, and editor has no value, then value of numeric editor is set to 0 (or minValue/maxValue) and value of date editor is set to today date (or minValue/maxValue).

  • &nbspnullText

    Type:
    string
    Default:
    null

    Sets gets text which appears in editor when editor has no focus and "value" in editor is null or empty string. Default is null.

  • &nbsppromptChar

    Type:
    string
    Default:
    _

    Sets gets character which is used as prompt in edit mode for available entry position. Default is "_.

  • &nbspreadOnly

    Type:
    bool
    Default:
    false

    Set gets ability to modify editor from keyboard (false) or disables keyboard (true).
    Default is false.
    Notes:
    If the "spinOnReadOnly" is enabled, then value will be modified on spin regardless of the "readOnly".
    If the "listItems" has items and "dropDownTriggers" is defined, then value will be modified from drop-down list regardless of the "readOnly".

  • &nbspreduceDayOfInvalidDate

    Type:
    bool
    Default:
    true

    Sets gets abitlity to reduce day of month.
    Value of true allows reduce day of month, when editor loses focus and user entered day of month which is larger maximum for that particular month.
    Value of false will automatically increment month and reduce day of month.
    Default is true.
    Examples.
    If that option is true and user entered "09/31/2010", then on lost focus that string will be converted to "09/30/2010".
    If that option is false, then in similar situation the string will be converted to "10/01/2010".

  • &nbspregional

    Type:
    enumeration
    Default:
    null

    Sets gets custom regional settings for editor. Default is null. If it is string, then $.ig.regional[stringValue] is assumed.

    Members

    • string
    • Type:unknown
    • Sets gets custom regional settings for editor. Default is null. If it is string, then $.ig.regional[stringValue] is assumed.
    • object
    • Type:unknown
    • Sets gets custom regional settings for editor. Default is null. If it is string, then $.ig.regional[stringValue] is assumed.
  • &nbsprenderInContainer

    Type:
    bool
    Default:
    false

    Sets gets option to wrap input field into SPAN.
    Default is false.
    That option can be set only on initialization and it is available only when base element is INPUT or TEXTAREA.
    If drop-down button or spin-buttons are enabled or the theme is set, then that option has no effect.
    The reason for that property is to allow vertical alignment of several igEditor controls when they are located in html inline and some of them have enabled buttons.
    If all editors are created within SPAN wrapper, then they will appear on the same line. Otherwise, editors in SPANs will be shifted 3-6 pixels above INPUT editors.

  • &nbsprequired

    Type:
    bool
    Default:
    false

    Set gets validation for empty value in editor. Default is false.

  • &nbspselectionOnFocus

    Type:
    enumeration
    Default:
    -1

    Sets gets behavior of selection/caret in input-field when editor gets focus.

    Members

    • string
    • Type:unknown
    • Sets gets behavior of selection/caret in input-field when editor gets focus.
    • number
    • Type:unknown
    • Sets gets behavior of selection/caret in input-field when editor gets focus.
  • &nbspspin1Field

    Type:
    bool
    Default:
    false

    Sets gets ability to spin 1 field only.
    Value false enables changes of other date fields when incremented or decremented date-field reaches its limits.
    Value true modifies only value of one field.
    Default is false.

  • &nbspspinDelta

    Type:
    number
    Default:
    1

    Sets gets delta-value which is used to increment or decrement value in editor on spin events.
    Default is 1.
    In case of numeric editors, the numeric value is modified.
    In case of date editors, the value of field where caret is located is modified.
    In case of all other editors spin is applied to the items in the "listItems" and value of editor is set to an item in list.

  • &nbspspinOnReadOnly

    Type:
    bool
    Default:
    false

    Sets gets ability to override the "readOnly" option and allow changes "value" of editor on spin events. Default is false. Value false does not allow spin when "readOnly" is true.

  • &nbspspinWrapAround

    Type:
    bool
    Default:
    false

    Sets gets ability to automatically set value in editor to opposite limit, when spin action reached minimum or maximum limit (true), or stop spin when value reached minimum or maximum limit (false).
    Default is false.
    In case of listOfItems, the first and the last items in list are used as minimum and maximum values.

  • &nbsptabIndex

    Type:
    number
    Default:
    null

    Gets sets value in tabIndex for editor. Default is null.

  • &nbsptextAlign

    Type:
    string
    Default:
    null

    Sets gets horizontal alignment of text in editor.
    Default is null.
    Possible values: null, "left", "right", "center".
    Note: If that option is not set, then "right" is used for "numeric", "currency" and "percent" editors and the "left" is used for all other types of editor.

  • &nbsptextMode

    Type:
    string
    Default:
    null

    Sets gets text mode of editor such as: single-line text editor, password editor or multiline editor.
    That option has effect only on initialization and only if base element is not INPUT or TEXTAREA.
    Default is null.
    If based element (selector) is TEXTAREA, then it is used as input-field.
    If based element is INPUT, then it is used as input-field.
    Possible values:
    "text": single line text editor based on INPUT element is created;
    "password": editor based on INPUT element is created;
    "multiline" or "textarea": multiline editor based on TEXTAREA element is created.

  • &nbsptheme

    Type:
    string
    Default:
    null

    Sets gets selector for css classes used by editor.
    Default is null.
    That option allows replacing all default css styles of editor by custom values.
    Application should provide css classes for all members defined in the css options with "theme" selector.
    For example, if that property is set to "mytheme", then application should provide following css classes:
    .mytheme .ui-igedit-field{...};
    .mytheme .ui-igedit-focus{...};
    etc.
    Note: changing theme is not supported when base element is INPUT or TEXTAREA and fieldInContainer or button are not enabled.

  • &nbsptoLower

    Type:
    bool
    Default:
    false

    Sets gets ability to convert input characters to lower case (true) or keeps characters as they are (false). Default is false. That option has effect only while keyboard entries and paste.

  • &nbsptoUpper

    Type:
    bool
    Default:
    false

    Sets gets ability to convert input characters to upper case (true) or keeps characters as they are (false). Default is false. That option has effect only while keyboard entries and paste.

  • &nbsptype

    Type:
    enumeration
    Default:
    null

    Sets type of editor.

    Members

    • string
    • Type:unknown
    • Sets type of editor.
    • number
    • Type:unknown
    • Sets type of editor.
  • &nbspuseLastGoodDate

    Type:
    bool
    Default:
    false

    Set gets ability to use last valid date when user entered invalid value.
    Value of true allows automatically use last valid date, when editor loses focus and user failed to enter a valid date.
    In case of value false, the entered date is considered invalid and null is used.
    Default is false.

  • &nbspvalidatorOptions

    Type:
    object
    Default:
    null

    Sets gets options supported by igValidator.
    Default is null.
    In order to enable validation and use defaults, an empty object can be used.
    Note: validation rules of igValidator, such as min, max, minLength, required are not supported, but similar properties of igEditor should be used.

  • &nbspvalue

    Type:
    enumeration
    Default:
    null

    Gets sets value in editor.

    Members

    • string
    • Type:unknown
    • Gets sets value in editor.
    • date
    • Type:unknown
    • Gets sets value in editor.
    • number
    • Type:unknown
    • Gets sets value in editor.
  • &nbspwidth

    Type:
    number
    Default:
    null

    Sets gets width of editor in pixels.
    Default is null.
    Only positive values have effect. If that option is not set, then value of style.width of base html element will be used automatically. However, that value should be in the px units.

  • &nbspyearShift

    Type:
    number
    Default:
    0

    Sets gets difference between year in Gregorian calendar and displayed year. Default is 0.

  • &nbspblur

    Cancellable:
    false

    Event which is raised when input field of editor loses focus.
    Function takes argument evt.
    Use evt.originalEvent to obtain reference to event of browser.

  • &nbspbuttonClick

    Cancellable:
    false

    Event which is raised when button was clicked by mouse.
    Function takes argument evt.
    Use evt.originalEvent to obtain reference to event of browser.

  • &nbspfocus

    Cancellable:
    false

    Event which is raised when input field of editor gets focus.
    Function takes argument evt.
    Use evt.originalEvent to obtain reference to event of browser.

  • &nbsphideDropDown

    Cancellable:
    true

    Event which is raised before drop-down list or calendar is opened.
    Function takes argument evt and ui.
    Use evt.originalEvent to obtain reference to event of browser.
    Use ui.value to obtain reference to the selected item in list or Date in calendar.
    If ui.value is not null and not undefined, that it means that drop-down was closed due to selection from drop-down list or from calendar.
    Otherwise, drop-down was closed due to lost focus or Esc key press.
    Return false in order to cancel hide action and keep drop-down visible.
    It is not recommended to cancel that action on blur event.
    Note: In case of calendar of datepicker, the evt or evt.originalEvent can be null. That happens if calendar was closed on blur or by Esc key.
    Returning the false in this situation will not prevent closing drop-down calendar.

  • &nbspinvalidValue

    Cancellable:
    false

    Event which is raised on lost focus when editor contains invalid value. That event is available for all editors besides default "text" type editor.
    Function takes arguments evt and ui.
    Use ui.value to obtain suggested value.
    Set ui.value to change suggested value.
    If type of editor is numeric, currency, percent, date or datepicker, then ui.text contains actual text entered by user.
    If type of editor is numeric, currency or percent, then the ui.reason may have following flags: "null", "format" or "limit".
    If type of editor is date or datepicker, then ui contains following additional members:
    ui.reason may have following flags: "null", "dayOfMonth", "numberOfFields", "limit" or "invalid";
    ui.year - year of entered date;
    ui.month - month of entered date;
    ui.day - day of entered date;
    ui.hours - hours of entered date;
    ui.minutes - minutes of entered date;
    ui.seconds - seconds of entered date;
    ui.milliseconds - milliseconds of entered date.

  • &nbspkeydown

    Cancellable:
    true

    Event which is raised on keydown event.
    Return false in order to cancel key action.
    Function takes arguments evt and ui.
    Use ui.key to obtain value of keyCode.

  • &nbspkeypress

    Cancellable:
    true

    Event which is raised on keypress event.
    Return false in order to cancel key action.
    Function takes arguments evt and ui.
    Use ui.key to obtain value of keyCode.
    Set ui.key to another character which will replace original entry.

  • &nbspkeyup

    Cancellable:
    false

    Event which is raised on keyup event.
    Function takes arguments evt and ui.
    Use ui.key to obtain value of keyCode.

  • &nbsplistSelected

    Cancellable:
    false

    Event which is raised after list item was selected.
    Function takes arguments evt and ui.
    Use evt.originalEvent to obtain reference to event of browser.
    Use ui.index to get new selected index.
    Use ui.oldIndex to get old selected index.
    Use ui.item to get reference to new selected item.

  • &nbsplistSelecting

    Cancellable:
    true

    Event which is raised before list item is selected.
    Return false in order to cancel select action.
    Function takes arguments evt and ui.
    Use evt.originalEvent to obtain reference to event of browser.
    Use ui.index to get new selected index.
    Use ui.oldIndex to get old selected index.
    Use ui.item to get reference to new selected item.

  • &nbspmousedown

    Cancellable:
    false

    Event which is raised on mousedown at any part of editor including drop-down list.
    Function takes arguments evt and ui.
    Use ui.elementType to obtain type of html element under mouse, such as field, button, spinUpper, spinLower or item#.
    Use ui.id and ui.elementType to obtain flag which represents html element under mouse.

  • &nbspmouseleave

    Cancellable:
    false

    Event which is raised on mouseleave at any part of editor including drop-down list.
    Function takes arguments evt and ui.
    Use ui.elementType to obtain type of html element under mouse, such as field, button, spinUpper, spinLower or item#.
    Use ui.id and ui.elementType to obtain flag which represents html element under mouse.

  • &nbspmousemove

    Cancellable:
    false

    Event which is raised on mousemove at any part of editor including drop-down list.
    Function takes arguments evt and ui.
    Use ui.elementType to obtain type of html element under mouse, such as field, button, spinUpper, spinLower or item#.
    Use ui.id and ui.elementType to obtain flag which represents html element under mouse.

  • &nbspmouseover

    Cancellable:
    false

    Event which is raised on mouseover at any part of editor including drop-down list.
    Function takes arguments evt and ui.
    Use ui.elementType to obtain type of html element under mouse, such as field, button, spinUpper, spinLower or item#.
    Use ui.id and ui.elementType to obtain flag which represents html element under mouse.

  • &nbspmouseup

    Cancellable:
    false

    Event which is raised on mouseup at any part of editor including drop-down list.
    Function takes arguments evt and ui.
    Use ui.elementType to obtain type of html element under mouse, such as field, button, spinUpper, spinLower or item#.
    Use ui.id and ui.elementType to obtain flag which represents html element under mouse.

  • &nbspshowDropDown

    Cancellable:
    true

    Event which is raised before drop-down list or calendar is opened.
    Return false in order to cancel drop-down action.
    Function takes argument evt.
    Use evt.originalEvent to obtain reference to event of browser.

  • &nbspspin

    Cancellable:
    true

    Event which is raised on spin event.
    Return false in order to cancel spin.
    Function takes arguments evt and ui.
    Use ui.delta to obtain delta for increment or decrement.
    Use ui.value to obtain the "value" of editor before spin action.

  • &nbsptextChanged

    Cancellable:
    false

    Event which is raised after text in editor was changed.
    Function takes arguments evt and ui.
    Use ui.value to obtain new value and ui.oldValue to obtain old value.

  • &nbspvalueChanged

    Cancellable:
    false

    Event which is raised after value in editor was changed. It can be raised on lost focus or on spin events.
    Function takes arguments evt and ui.
    Use ui.value to obtain new value and ui.oldValue to obtain old value.

  • &nbspvalueChanging

    Cancellable:
    true

    Event which is raised before value in editor was changed.
    Return false in order to cancel change.
    It can be raised on lost focus or on spin events.
    Function takes arguments evt and ui.
    Use ui.value to obtain new value and ui.oldValue to obtain old value.

  • &nbspaddListItem

    .igDatePicker( "addListItem", item:unknown, [index:number] );
    Return Type:
    object

    Adds item to list.

    • item
    • Type:unknown
    • Item for list.
    • index
    • Type:number
    • Optional
    • Index within current list where item is inserted. If parameter is missing or too large or negative, then item is appended to list.
  • &nbspaddListItems

    .igDatePicker( "addListItems", items:object, [index:number] );
    Return Type:
    object

    Adds several items to list.

    • items
    • Type:object
    • Array of items.
    • index
    • Type:number
    • Optional
    • Index within current list where items are inserted. If parameter is missing or too large or negative, then items are appended to list.
  • &nbspclearListItems

    .igDatePicker( "clearListItems" );
    Return Type:
    object

    Removes all items from list.

  • &nbspdestroy

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

    Destroys editor and return base element back to its pre-init state.

  • &nbspdropDownElement

    .igDatePicker( "dropDownElement" );

    Gets reference to jquery object which is used as container of drop-down.
    returnType="$" Returns reference to jquery object or null. That can be container of list items or in case of igDatePicker it can be calendar of jquery.datepicker.

  • &nbspdropDownVisible

    .igDatePicker( "dropDownVisible", [showHide:bool] );

    Shows editor (if it was hidden).
    returnType="bool|object" Returns reference to this igEditor if parameter is defined. If parameter is undefined, then Otherwise, that returns true is drop down is visible and false if drop down is hidden.

    • showHide
    • Type:bool
    • Optional
    • Value true will show dropdown, false - hide dropdown.
  • &nbspfield

    .igDatePicker( "field" );

    Gets reference to jquery object which is used as edit field.
    returnType="$" Returns reference to jquery object. That can be INPUT or TEXTAREA.

  • &nbspfindListItemIndex

    .igDatePicker( "findListItemIndex", text:string, [ignoreCase:bool], [partial:bool], [contains:bool] );
    Return Type:
    number

    Finds index of list item by text.

    • text
    • Type:string
    • Text to search.
    • ignoreCase
    • Type:bool
    • Optional
    • Value true sets request to ignore case.
    • partial
    • Type:bool
    • Optional
    • Value true will perform partial search rather than full match.
    • contains
    • Type:bool
    • Optional
    • Value true will perform search anywhere within text of item, otherwise starts-with search is used.
  • &nbspgetRegionalOption

    .igDatePicker( "getRegionalOption", name:string );
    Return Type:
    string

    Gets calculated value of regional option used by numeric and date editors.

    • name
    • Type:string
    • Name of regional option, such as "monthNames", "dateLongPattern", "currencySymbol", etc.
  • &nbspgetSelectedListItem

    .igDatePicker( "getSelectedListItem" );

    Gets reference to selected item in list.
    returnType="string|number|date|object" Returns reference to selected item or null.

  • &nbspgetSelectedText

    .igDatePicker( "getSelectedText" );
    Return Type:
    string

    Gets selected text in editor.

  • &nbspgetSelection

    .igDatePicker( "getSelection", [start:bool] );
    Return Type:
    number

    Gets left or right edge of selection. That method can be used only when editor has focus.

    • start
    • Type:bool
    • Optional
    • If true then left edge of selection is returned. Otherwise, right edge selection is returned.
  • &nbspgetValueByMode

    .igDatePicker( "getValueByMode", mode:unknown, v:unknown, getVal:unknown );

    Get value in editor by dataMode.
    For example, in case of numeric editors that can be a number in range from -1 to 11, or string such as "text", "double", "byte", etc.
    returnType="string|number|date|object" Returns value in editor or null.

    • mode
    • Type:unknown
    • The value of dataMode option supported by editor.
    • v
    • Type:unknown
    • getVal
    • Type:unknown
  • &nbsphasFocus

    .igDatePicker( "hasFocus" );
    Return Type:
    bool

    Checks if editor has focus.

  • &nbsphasInvalidMessage

    .igDatePicker( "hasInvalidMessage" );
    Return Type:
    bool

    Checks if invalid message is displayed.

  • &nbsphide

    .igDatePicker( "hide" );
    Return Type:
    object

    Hides editor.

  • &nbspisValid

    .igDatePicker( "isValid" );
    Return Type:
    bool

    Checks if value in editor is value. Note: that method may fail if editor has focus (in edit mode).

  • &nbspmainElement

    .igDatePicker( "mainElement" );

    Gets reference to jquery object which is used as top/outer element of igEditor.
    returnType="$" Returns reference to jquery object.

  • &nbsppaste

    .igDatePicker( "paste", txt:string, bad:unknown );
    Return Type:
    object

    Paste text at location of caret. Note: method raises the "textChanged" event.

    • txt
    • Type:string
    • New text to paste.
    • bad
    • Type:unknown
  • &nbspremove

    .igDatePicker( "remove" );
    Return Type:
    object

    Removes editor from its parent element, but keeps the rest of functionality.

  • &nbspremoveListItem

    .igDatePicker( "removeListItem", item:unknown );
    Return Type:
    object

    Removes item from list.

    • item
    • Type:unknown
    • Current item in list.
  • &nbspremoveListItemAt

    .igDatePicker( "removeListItemAt", index:number );
    Return Type:
    object

    Removes item from list at index.

    • index
    • Type:number
    • Index of item. If it is negative number, then last item in list is removed.
  • &nbspselect

    .igDatePicker( "select", [sel0:number], [sel1:number], [val:string] );
    Return Type:
    object

    Selects text in editor. If parameters are equal, then than method sets location of caret. That method has effect only when editor has focus.

    • sel0
    • Type:number
    • Optional
    • Left edge of selection. If parameter is missing, then all text is selected.
    • sel1
    • Type:number
    • Optional
    • Right edge of selection. If parameter is missing, then value of first parameter is used.
    • val
    • Type:string
    • Optional
    • Internal use only (new text).
  • &nbspselectedListIndex

    .igDatePicker( "selectedListIndex", [index:number] );
    Return Type:
    number

    Gets sets selected index of list item.

    • index
    • Type:number
    • Optional
    • Index of item.
  • &nbspsetFocus

    .igDatePicker( "setFocus", [delay:number] );
    Return Type:
    object

    Set focus to editor with delay.

    • delay
    • Type:number
    • Optional
    • Delay in milliseconds. If parameter is missing, then 0 is used. If parameter is -1, then focus is set without delay.
  • &nbspshow

    .igDatePicker( "show" );
    Return Type:
    object

    Shows editor (if it was hidden).

  • &nbspspin

    .igDatePicker( "spin", delta:number );
    Return Type:
    object

    Increments of decrements value in editor according to the parameter.
    If editor has listItems, then that method increments or decrements selected index in list and sets value in editor to new selected item.
    In this case if delta is positive, then list selected index in incremented by 1 and if delta is negative then selected index is decremented by 1.

    • delta
    • Type:number
    • Value to increment or decrement current value in editor.
  • &nbsptext

    .igDatePicker( "text", [val:string], s:unknown );

    Gets sets text in editor.
    returnType="string|object" Returns text in editor if parameter is undefined. Otherwise, it returns reference to this igEditor.

    • val
    • Type:string
    • Optional
    • New text for editor.
    • s
    • Type:unknown
  • &nbspvalidate

    .igDatePicker( "validate", [noLabel:bool] );
    Return Type:
    bool

    Triggers validation of editor and show error message. That method has effect only when validation is enabled.

    • noLabel
    • Type:bool
    • Optional
    • Value of true will allow to skip error message if validation failed.
  • &nbspvalidator

    .igDatePicker( "validator" );
    Return Type:
    object

    Gets reference to igValidator used by igEditor.

  • &nbspvalue

    .igDatePicker( "value", [val:unknown] );

    Gets sets value in editor.
    returnType="string|number|date|object" Returns value in editor if parameter is undefined. Otherwise, it returns reference to this igEditor.

    • val
    • Type:unknown
    • Optional
    • New value for editor.
  • 'ui-igedit-bordercolor'

    Class applied to the editing element and buttons in normal state (not disabled and not focused). Default value is 'ui-igedit-bordercolor.
  • 'ui-igedit-button'

    Class applied to the SPAN element which represents button. Default value is 'ui-igedit-button.
  • 'ui-icon-circle-close'

    Class applied to the SPAN element which represents image on clear button. Default value is 'ui-icon-circle-close.
  • 'ui-igedit-buttondefault ui-state-default'

    Classes applied to the the SPAN element of button in default state (no focus, no mouse, no press). Default value is 'ui-igedit-buttondefault ui-state-default.
  • 'ui-igedit-buttondisabled ui-state-disabled'

    Classes applied to the SPAN element of button in disabled state. Default value is 'ui-igedit-buttondisabled ui-state-disabled.
  • 'ui-igedit-buttonfocus ui-state-focus'

    Classes applied to the SPAN element of button when editor has focus. Default value is 'ui-igedit-buttonfocus ui-state-focus.
  • 'ui-igedit-buttonhover ui-state-hover'

    Classes applied to the SPAN element of button in mouse-over state. Default value is 'ui-igedit-buttonhover ui-state-hover.
  • 'ui-igedit-buttonimage ui-icon-triangle-1-s ui-icon'

    Classes applied to the SPAN element which represents image on dropdown/clear button. Default value is 'ui-igedit-buttonimage ui-icon-triangle-1-s ui-icon.
  • 'ui-igedit-buttonimagedisabled'

    Class applied to the SPAN element which represents image on button in disabled state. Default value is 'ui-igedit-buttonimagedisabled.
  • 'ui-igedit-buttonimagehover'

    Class applied to the SPAN element which represents image on button in mouse-over state. Default value is 'ui-igedit-buttonimagehover.
  • 'ui-igedit-buttonimagepressed'

    Class applied to the SPAN element which represents image on button in pressed state. Default value is 'ui-igedit-buttonimagepressed.
  • 'ui-igedit-buttonpressed ui-state-highlight'

    Classes applied to the SPAN element of button in pressed state. Default value is 'ui-igedit-buttonpressed ui-state-highlight.
  • 'ui-igedit-buttonsimagestateoverride'

    Class applied to the images of buttons when editor has focus or mouse-over, but mouse-over does not belong to a particular button. Default value is 'ui-igedit-buttonsimagestateoverride.
  • 'ui-igedit-disabled ui-state-disabled'

    Classes applied to the editing element in disabled state. Default value is 'ui-igedit-disabled ui-state-disabled.
  • 'ui-igedit-dropdown'

    Class applied to the drop-down element which contains list of items or datepicker-calendar. Default value is 'ui-igedit-dropdown.
  • 'ui-igedit'

    Class applied to the main/top element. Default value is 'ui-igedit.
  • 'ui-igedit-field'

    Class applied to the editing element. Default value is 'ui-igedit-field.
  • 'ui-igedit-fieldincontainer'

    Class applied to the editing element when it is located in (SPAN) container. That happens when buttons are enabled, or base element is not INPUT, or renderInContainer option is enabled. Default value is 'ui-igedit-fieldincontainer.
  • 'ui-igedit-focus'

    Class applied to the editing element in focus state. Default value is 'ui-igedit-focus.
  • 'ui-igedit-hover'

    Class applied to the editing element in mouse-over state. Default value is 'ui-igedit-hover.
  • 'ui-igedit-list ui-widget ui-widget-content'

    Class applied to the DIV element which is used as container for dropdown list. Default value is 'ui-igedit-list ui-widget ui-widget-content.
  • 'ui-igedit-listitem ui-state-default'

    Class applied to the SPAN element which represents item in dropdown list. Default value is 'ui-igedit-listitem ui-state-default.
  • 'ui-igedit-listitemcolumnborder'

    Class applied to the SPAN elements located in columns on the right in dropdown list. That has effect only when multiple columns in list are enabled. Default value is 'ui-igedit-listitemcolumnborder.
  • 'ui-igedit-listitemhover ui-state-hover'

    Class applied to the Class applied to the SPAN element which represents item in dropdown list with mouse-over state. Default value is 'ui-igedit-listitemhover ui-state-hover.
  • 'ui-igedit-listitemselected ui-state-highlight'

    Class applied to the Class applied to the SPAN element which represents selected item in dropdown list. Default value is 'ui-igedit-listitemselected ui-state-highlight.
  • 'ui-igedit-negative'

    Class applied to the editing element of numeric editor when value is negative. Default value is 'ui-igedit-negative.
  • 'ui-igedit-nullvalue'

    Class applied to the editing element when it has no value. Default value is 'ui-igedit-nullvalue.
  • 'ui-igedit-spinbutton'

    Class applied to the SPAN element which represents spin button. Default value is 'ui-igedit-spinbutton.
  • 'ui-igedit-spinbuttonimage'

    Class applied to the SPAN element which represents image on spin button. Default value is 'ui-igedit-spinbuttonimage.
  • 'ui-igedit-spinholder'

    Class applied to the SPAN element which contains spin buttons. Default value is 'ui-igedit-spinholder.
  • 'ui-igedit-spinlowerimage ui-icon-triangle-1-s ui-icon'

    Class applied to the SPAN element which represents image on lower spin button. Default value is 'ui-igedit-spinlowerimage ui-icon-triangle-1-s ui-icon.
  • 'ui-igedit-spinlowerimagedisabled'

    Class applied to the SPAN element which represents image on lower spin button in disabled state. Default value is 'ui-igedit-spinlowerimagedisabled.
  • 'ui-igedit-spinlowerimagehover'

    Class applied to the SPAN element which represents image on lower spin button in mouse-over state. Default value is 'ui-igedit-spinlowerimagehover.
  • 'ui-igedit-spinlowerimagepressed'

    Class applied to the SPAN element which represents image on lower spin button in pressed state. Default value is 'ui-igedit-spinlowerimagepressed.
  • 'ui-igedit-spinupperimage ui-icon-triangle-1-n ui-icon'

    Class applied to the SPAN element which represents image on upper spin button. Default value is 'ui-igedit-spinupperimage ui-icon-triangle-1-n ui-icon.
  • 'ui-igedit-spinupperimagedisabled'

    Class applied to the SPAN element which represents image on upper spin button in disabled state. Default value is 'ui-igedit-spinupperimagedisabled.
  • 'ui-igedit-spinupperimagehover'

    Class applied to the SPAN element which represents image on upper spin button in mouse-over state. Default value is 'ui-igedit-spinupperimagehover.
  • 'ui-igedit-spinupperimagepressed'

    Class applied to the SPAN element which represents image on upper spin button in pressed state. Default value is 'ui-igedit-spinupperimagepressed.
  • 'ui-igedit-textarea'

    Class applied to the TEXTAREA element. Default value is 'ui-igedit-textarea.