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

ui.igMaskEditor_image

The igMaskEditor control gives you the control to format and constrain user input text using configurable mask rules. Further information regarding the classes, options, events, methods and themes of this API are available under the associated tabs above.

The igMaskEditor control extends the functionality of the igEditor control. For more details on the igMaskEditor control’s API, refer to the igEditor control’s API documentation.

The following code snippet demonstrates how to initialize the igMaskEditor control.

Click here for more information on how to get started using this API. For details on how to reference the required scripts and themes for the igMaskEditor control read, Using JavaScript Resouces in NetAdvantage for jQuery and Styling and Theming NetAdvantage for jQuery.

Code Sample

      <!doctype html>
      <html>
      <head>
          <!-- Infragistics Combined CSS -->
          <link href="themes/infragistics/infragistics.theme.css" rel="stylesheet" type="text/css" />
          <link href="css/structure/infragistics.css" rel="stylesheet" type="text/css" />
          <!-- jQuery Core -->
          <script src="js/jquery.js" type="text/javascript"></script>
          <!-- jQuery UI -->
          <script src="js/jquery-ui.js" type="text/javascript"></script>
          <!-- jQuery Templates: http://api.jquery.com/category/plugins/templates/ -->
          <script src="js/jquery.tmpl.js" type="text/javascript"></script>
          <!-- Infragistics Combined Scripts -->
          <script src="js/infragistics.js" type="text/javascript"></script>
          <script type="text/javascript">
            $(function () {
                $("#maskEditor").igMaskEditor({
                    width: 160,
                    inputMask: "CCCCC",
                    nullText: "Enter Value"
                });
            });
          </script>
      </head>
      <body>
         <input id="maskEditor" />
      </body>
      </html>
      

Related Samples

Related Topics

Dependencies

jquery-1.4.4.js
jquery.ui.core.js
jquery.ui.widget.js
jquery.ui.datepicker.js
ig.util.js
  • &nbspanimationHideDuration

    Type:
    number
    Default:
    200

    Sets gets duration of animation in milliseconds when drop-down list is hidden. That option is not supported when "type" is set to "datepicker", because the jquery.ui.datepicker does not have similar feature. Default is 200. If value is less than 5, then animation is disabled.

    Code Sample

          //Initialize
          $(".selector").igMaskEditor({
              animationHideDuration: 200
          });
     
          //Get
          var animationHideDuration= $(".selector").igMaskEditor("option", "animationHideDuration");
     
          //Set
          $(".selector").igMaskEditor("option", "animationHideDuration", 200);
          
  • &nbspanimationShowDuration

    Type:
    number
    Default:
    200

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

    Code Sample

          //Initialize
          $(".selector").igMaskEditor({
              animationShowDuration: 200
          });
     
          //Get
          var animationShowDuration= $(".selector").igMaskEditor("option", "animationShowDuration");
     
          //Set
          $(".selector").igMaskEditor("option", "animationShowDuration", 200);
          
  • &nbspbutton

    Type:
    enumeration
    Default:
    none

    Sets gets visibility of spin and drop-down button. That option can be set only on initialization. Combinations like 'dropdown,spin' or 'spinclear' are supported too.

    Members

    • dropdown
    • Type:string
    • button to open list is located on the right side of input-field (or left side if base html element has direction:rtl);.
    • clear
    • Type:string
    • button to clear value is located on the right side of input-field (or left side if base html element has direction:rtl);.
    • spin
    • Type:string
    • 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").igMaskEditor({
                button : "dropdown"
            });
    
            //Get
            var button = $(".selector").igMaskEditor("option", "button");
    
            //Set
            $(".selector").igMaskEditor("option", "button", "spin");
            
  • &nbspbuttonHidden

    Type:
    bool
    Default:
    false

    Sets gets visibility of dropdown button. That option has effect only when dropdown button is enabled.

    Code Sample

     
            //Initialize
            $(".selector").igMaskEditor({
                button : "dropdown",
                buttonHidden : true
            });
            
            //Get
            var isHidden = $(".selector").igMaskEditor("option", "buttonHidden");
            
            //Set
            $(".selector").igMaskEditor("option"), "buttonHidden", true);
          
  • dataMode

    Type:
    enumeration
    Default:
    alltext

    Sets gets type of value returned by the get of value() method. That also affects functionality of the set value(val) method and the copy/paste operations of browser.

    Members

    • rawText
    • Type:string
    • only entered text. All unfilled prompts (positions) and literals are ignored (removed). Note: that is used as default.
    • 0
    • Type:number
    • only entered text. All unfilled prompts (positions) and literals are ignored (removed). Note: that is used as default.
    • rawTextWithRequiredPrompts
    • Type:string
    • only entered text and required prompts (positions). All optional unfilled prompts and literals are ignored (removed).
    • 1
    • Type:number
    • only entered text and required prompts (positions). All optional unfilled prompts and literals are ignored (removed).
    • rawTextWithAllPrompts
    • Type:string
    • only entered text and prompts (positions). All literals are ignored (removed).
    • 2
    • Type:number
    • only entered text and prompts (positions). All literals are ignored (removed).
    • rawTextWithLiterals
    • Type:string
    • only entered text and literals. All unfilled prompts are ignored (removed).
    • 3
    • Type:number
    • only entered text and literals. All unfilled prompts are ignored (removed).
    • rawTextWithRequiredPromptsAndLiterals
    • Type:string
    • only entered text, required prompts (positions) and literals. All optional unfilled prompts are ignored (removed).
    • 4
    • Type:number
    • only entered text, required prompts (positions) and literals. All optional unfilled prompts are ignored (removed).
    • allText
    • Type:string
    • entered text, all prompts (positions) and literals.
    • 5
    • Type:number
    • entered text, all prompts (positions) and literals.

    Code Sample

     
            //Initialize
            $(".selector").igNumericEditor({
                dataMode : 0
            });
            
            //Get
            var dataMode = $(".selector").igNumericEditor("option", "dataMode");
            
            //Set
            $(".selector").igNumericEditor("option", "dataMode", "rawText");
          
  • &nbspdisplay

    Type:
    string
    Default:
    inline-block

    Sets gets style.display for outer html element.
    The value of "" will disable changing style.display.
    If the base html element is not INPUT, TEXTAREA, SPAN or DIV, then it is recommended to set this option to an 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 in Chrome can be problematic.

    Code Sample

     
            //Initialize
            $(".selector").igMaskEditor({
                display : "block"
            });
    
            //Get
            var display = $(".selector").igMaskEditor("option", "display");
    
            //Set
            $(".selector").igMaskEditor("option", "display", "block");
  • &nbspdropDownOnReadOnly

    Type:
    bool
    Default:
    false

    Sets gets ability to override the "readOnly" option and allow showing the drop-down list and changing the value in the editor from a list. Value false does not allow drop-down when "readOnly" is true.

    Code Sample

     
            //Initialize
            $(".selector").igMaskEditor({
                dropDownOnReadOnly : true
            });
    
            //Get
            var readOnly = $(".selector").igMaskEditor("option", "dropDownOnReadOnly");
    
            //Set
            $(".selector").igMaskEditor("option", "dropDownOnReadOnly", true);      
          
  • &nbspdropDownTriggers

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

    Sets gets list of actions which trigger display of drop-down list or calendar.

    Members

    • arrow
    • Type:string
    • down-arrow shows drop-down and up-arrow hides drop-down;.
    • button
    • Type:string
    • shows and hides drop-down;.
    • focus
    • Type:string
    • shows drop-down on focus.
    • A-Z
    • Type:string
    • Any upper case characters show drop-down.

    Code Sample

     
            //Initialize
            $(".selector").igMaskEditor({
                dropDownTriggers : "button,0,1,2,3,4,5,6,7,8,9"
            });
    
            //Get
            var triggers = $(".selector").igMaskEditor("option", "dropDownTriggers");
    
            //Set
            $(".selector").igMaskEditor("option", "dropDownTriggers", "button,0,1,2,3,4,5,6,7,8,9");      
          
  • emptyChar

    Type:
    string
    Default:
    ""

    Sets gets character which is used as replacement of not-filled required position in mask when application calls get for the "value" or for the "text" methods.

    Code Sample

            //Initialize
            $(".selector").igMaskEditor({
                   emptyChar: "*"
            });
     
            //Get
            var emptyChar= $(".selector").igMaskEditor("option", "emptyChar");
     
            //Set
            $(".selector").igMaskEditor("option", "emptyChar", "*");
            
  • &nbspexcludeKeys

    Type:
    string
    Default:
    null

    Sets gets ability to prevent entering specific characters from keyboard or on paste.
    Notes:
    If a character is specified in "includeKeys" option also, then "excludeKeys" has priority.
    Letters should be set in upper case.
    Making difference between upper and lower case is not supported.

    Code Sample

            //Initialize
            $(".selector").igMaskEditor({
                   excludeKeys: "ABC"
            });
     
            //Get
            var excludedKeys= $(".selector").igMaskEditor("option", "excludeKeys");
     
            //Set
            $(".selector").igMaskEditor("option", "excludeKeys", "ABC");
            
  • &nbspfocusOnSpin

    Type:
    bool
    Default:
    false

    If that option is disabled and the editor is not focused, then a mouse click on the spin button will keep the text in the editor in display (not focus) format and perform spin actions.

    Code Sample

     
            //Initialize
            $(".selector").igMaskEditor({
                focusOnSpin : true
            });
    
            //Get
            var spinFocus = $(".selector").igMaskEditor("option", "focusOnSpin");
    
            //Set
            $(".selector").igMaskEditor("option", "focusOnSpin", true);
            
  • &nbspheight

    Type:
    number
    Default:
    null

    Sets gets height of editor in pixels.
    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.

    Code Sample

     
            //Initialize
            $(".selector").igMaskEditor({
                height : 25
            });
    
            //Get
            var height = $(".selector").igMaskEditor("option", "height");
    
            //Set
            $(".selector").igMaskEditor("option", "height", 25);
            
  • &nbsphideEnterKey

    Type:
    bool
    Default:
    true

    Sets gets ability to hide the Enter key from browser.

    Code Sample

     
            //Initialize
            $(".selector").igMaskEditor({
                hideEnterKey : false
            });
    
            //Get
            var hideKey = $(".selector").igMaskEditor("option", "hideEnterKey");
    
            //Set
            $(".selector").igMaskEditor("option", "hideEnterKey", false);
            
  • hideMaskOnFocus

    Type:
    bool
    Default:
    false

    Set gets ability to hide mask in focus state.
    Value of false allows to show 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.

    Code Sample

     
            //Initialize
            $(".selector").igMaskEditor({
                hideMaskOnFocus : true
            });
            
            //Get
            var hideMask =  $(".selector").igMaskEditor("option", "hideMaskOnFocus");
            
            //Set
            $(".selector").igMaskEditor("option", "hideMaskOnFocus", true);
          
  • &nbspincludeKeys

    Type:
    string
    Default:
    null

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

    Code Sample

            //Initialize
            $(".selector").igMaskEditor({
                 includeKeys: "ABC"
            });
     
            //Get
            var includedKeys= $(".selector").igMaskEditor("option", "includeKeys");
     
            //Set
            $(".selector").igMaskEditor("option", "includeKeys", "ABC");
           
  • inputMask

    Type:
    string
    Default:
    cccccccccc

    Sets gets input mask. Mask may include filter-flags and literal characters.
    Literal characters are part of mask which cannot be modified by end user. In order to use a filter-flag as a literal character, the escape "\\" character should be used.
    Default is "CCCCCCCCCC"
    Note: optional flags/entries affect the value returned by get of the "value" and "text" methods.
    List of filter-flags:
    C: any keyboard character. Entry is optional.
    &: any keyboard character. Entry is required.
    a: letter or digit character. Entry is optional.
    A: letter or digit character. Entry is required.
    ?: letter character. Entry is optional.
    L: letter character. Entry is required.
    9: digit character. Entry is optional.
    0: digit character. Entry is required.
    #: digit character or "+" or "_". Entry is optional with replacement by "emptyPositionChar" or by "padChar".
    >: all letters to the right are converted to the upper case. In order to disable conversion, the ">" flag should be used again.
    <: all letters to the right are converted to the lower case. In order to disable conversion, the "<" flag should be used again.

    Code Sample

     
            //Initialize
            $(".selector").igMaskEditor({
                inputMask : "cccccccccc"
            });
    
            //Get
            var inputMask = $(".selector").igMaskEditor("option", "inputMask");
    
            //Set
            $(".selector").igMaskEditor("option", "inputMask", true);
            
  • &nbspinputName

    Type:
    string
    Default:
    null

    Gets sets name of (hidden) INPUT element, which value will be set to current value of editor on any change.

    Code Sample

          //Initialize 
          $(".selector").igMaskEditor({     
              inputName : "textField"
          });  
     
          //Get 
          var inputName = $(".selector").igMaskEditor("option", "inputName");  
     
          //Set 
          $(".selector").igMaskEditor("option", "inputName", "textField");
          
  • &nbsplistAutoComplete

    Type:
    bool
    Default:
    false

    Sets gets autocomplete.
    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.

    Code Sample

     
            //Initialize
            $(".selector").igMaskEditor({
                listAutoComplete : true
            });
    
            //Get
            var autocomplete = $(".selector").igMaskEditor("option", "listAutoComplete");
    
            //Set
            $(".selector").igMaskEditor("option", "listAutoComplete", true);
            
  • &nbsplistColumns

    Type:
    number
    Default:
    1

    Sets gets number of columns in drop-down list.

    Code Sample

     
            //Initialize
            $(".selector").igMaskEditor({
                listColumns : 2
            });
    
            //Get
            var listCols = $(".selector").igMaskEditor("option", "listColumns");
    
            //Set
            $(".selector").igMaskEditor("option", "listColumns", 2);
            
  • &nbsplistDropDownAsChild

    Type:
    bool
    Default:
    false

    Sets gets location of drop-down list.
    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".

    Code Sample

     
            //Initialize
            $(".selector").igMaskEditor({
                listDropDownAsChild : true
            });
    
            //Get
            var listChild = $(".selector").igMaskEditor("option", "listDropDownAsChild");
    
            //Set
            $(".selector").igMaskEditor("option", "listDropDownAsChild", true);      
  • &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.
    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.

    Code Sample

     
            //Initialize
            $(".selector").igMaskEditor({
                listItems : [
                    "red",
                    "blue",
                    "yellow"
                ]
            });
    
            //Get
            var items = $(".selector").igMaskEditor("option", "listItems");
    
            //Set
            $(".selector").igMaskEditor("option", "listItems", ["red", "blue", "yellow"]);
            
  • &nbsplistMatchContains

    Type:
    bool
    Default:
    false

    Sets gets list match contains.
    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.

    Code Sample

     
            //Initialize
            $(".selector").igMaskEditor({
                listMatchContains : true
            });
    
            //Get
            var listContains = $(".selector").igMaskEditor("option", "listMatchContains");
    
            //Set
            $(".selector").igMaskEditor("option", "listMatchContains", true);
            
  • &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.
    That option has effect only when "listMatchOnly" or "listAutoComplete" options are enabled.

    Code Sample

     
            //Initialize
            $(".selector").igMaskEditor({
                listMatchIgnoreCase : false
            });
    
            //Get
            var ignoreCase = $(".selector").igMaskEditor("option", "listMatchIgnoreCase");
    
            //Set
            $(".selector").igMaskEditor("option", "listMatchIgnoreCase", false);      
  • &nbsplistMatchOnly

    Type:
    bool
    Default:
    false

    Set gets list match.
    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.

    Code Sample

     
            //Initialize
            $(".selector").igMaskEditor({
                listMatchOnly : true
            });
    
            //Get
            var matchOnly = $(".selector").igMaskEditor("option", "listMatchOnly");
    
            //Set
            $(".selector").igMaskEditor("option", "listMatchOnly", true);
            
  • &nbsplistMaxHeight

    Type:
    number
    Default:
    300

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

    Code Sample

     
            //Initialize
            $(".selector").igMaskEditor({
                listMaxHeight : 400
            });
    
            //Get
            var height = $(".selector").igMaskEditor("option", "listMaxHeight");
    
            //Set
            $(".selector").igMaskEditor("option", "listMaxHeight", 400);
            
  • &nbsplistWidth

    Type:
    number
    Default:
    0

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

    Code Sample

     
            //Initialize
            $(".selector").igMaskEditor({
                listWidth : 200
            });
    
            //Get
            var width = $(".selector").igMaskEditor("option", "listWidth");
    
            //Set
            $(".selector").igMaskEditor("option", "listWidth", 200);
            
  • &nbsplocale

    Type:
    object
    Default:
    null

    Sets gets strings used for title of buttons. Value of object should contain pairs or key:value members. Note: any sub-option 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.

    Code Sample

     
            //Initialize
            $(".selector").igMaskEditor({
                locale : "th"
            });
    
            //Get
            var regional = $(".selector").igMaskEditor("option", "locale");
    
            //Set
            $(".selector").igMaskEditor("option", "locale", "th");
            
  • &nbspmaxLength

    Type:
    number
    Default:
    0

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

    Code Sample

     
            //Initialize
            $(".selector").igMaskEditor({
                maxLength : 25
            });
    
            //Get
            var textLength = $(".selector").igMaskEditor("option", "maxLength");
    
            //Set
            $(".selector").igMaskEditor("option", "maxLength", 25);
            
  • &nbspnullable

    Type:
    bool
    Default:
    true

    Sets gets ability of numeric and date editors to prevent null value.
    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).

    Code Sample

     
            //Initialize
            $(".selector").igMaskEditor({
                nullable : false
            });
    
            //Get
            var nullable = $(".selector").igMaskEditor("option", "nullable");
    
            //Set
            $(".selector").igMaskEditor("option", "nullable", false);
            
  • &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.

    Code Sample

     
            //Initialize
            $(".selector").igMaskEditor({
                nullText : "Enter Value"
            });
    
            //Get
            var nullText = $(".selector").igMaskEditor("option", "nullText");
    
            //Set
            $(".selector").igMaskEditor("option", "nullText", "Enter Value");
            
  • padChar

    Type:
    string
    Default:
    ""

    Sets gets character which is used as replacement of not-filled required position in mask when editor is in display mode (not focused).

    Code Sample

            //Initialize
            $(".selector").igMaskEditor({
                   padChar: "*"
            });
     
            //Get
            var padChar= $(".selector").igMaskEditor("option", "padChar");
     
            //Set
            $(".selector").igMaskEditor("option", "padChar", "*");
            
  • promptChar

    Type:
    string
    Default:
    _

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

    Code Sample

     
            //Initialize
            $(".selector").igMaskEditor({
                promptChar : "*"
            });
            
            //Get
            var prompt = $(".selector").igMaskEditor("option", "promptChar");
            
            //Set
            $(".selector").igMaskEditor("option", "promptChar", "*");
          
  • &nbspreadOnly

    Type:
    bool
    Default:
    false

    Set gets ability to modify editor from keyboard (false) or disables keyboard (true).
    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".

    Code Sample

     
            //Initialize
            $(".selector").igMaskEditor({
                readOnly : true
            });
    
            //Get
            var readOnly = $(".selector").igMaskEditor("option", "readOnly");
    
            //Set
            $(".selector").igMaskEditor("option", "readOnly", true);
            
  • &nbspregional

    Type:
    object
    Default:
    null

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

    Code Sample

     
            //Initialize
            $(".selector").igMaskEditor({
                regional: "en-US"
            });
            
            //Get
            var region = $(".selector").igMaskEditor("option", "regional");
            
            //Set
            $(".selector").igMaskEditor("option", "regional", "en-US");
          
  • &nbsprenderInContainer

    Type:
    bool
    Default:
    false

    Sets gets option to wrap input field into SPAN..
    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.

    Code Sample

     
            //Initialize
            $(".selector").igMaskEditor({
                renderInContainer : true
            });
    
            //Get
            var inContainer = $(".selector").igMaskEditor("option", "renderInContainer");
    
            //Set
            $(".selector").igMaskEditor("option", "renderInContainer", true);
            
  • &nbsprequired

    Type:
    bool
    Default:
    false

    Set gets validation for empty value in editor.

    Code Sample

     
            //Initialize
            $(".selector").igMaskEditor({
                required : true
            });
    
            //Get
            var isRequired = $(".selector").igMaskEditor("option", "required");
    
            //Set
            $(".selector").igMaskEditor("option", "required", true);
            
  • &nbspselectionOnFocus

    Type:
    enumeration
    Default:
    -1

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

    Members

    • select
    • Type:string
    • select all text.
    • -1
    • Type:number
    • select all text.
    • start
    • Type:string
    • set caret at the beginning of text.
    • 0
    • Type:number
    • set caret at the beginning of text.
    • end
    • Type:string
    • set caret at the end of text.
    • 1
    • Type:number
    • set caret at the end of text.
    • default
    • Type:string
    • use default behavior of browser (in case of mask, numeric and date editors it may be unreliable).
    • 2
    • Type:number
    • use default behavior of browser (in case of mask, numeric and date editors it may be unreliable).

    Code Sample

     
             //Initialize
             $(".selector").igMaskEditor({
             selectionOnFocus: -1
              });
     
            //Get
            var selectionOnFocus= $(".selector").igMaskEditor("option", "selectionOnFocus");
     
            //Set
            $(".selector").igMaskEditor("option", "selectionOnFocus", -1);
          
  • &nbspspinDelta

    Type:
    number
    Default:
    1

    Sets gets delta-value which is used to increment or decrement value in editor on spin events.
    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.

    Code Sample

             //Initialize
             $(".selector").igMaskEditor({
             spinDelta: 1
             });
     
            //Get
            var spinDelta= $(".selector").igMaskEditor("option", "spinDelta");
     
            //Set
            $(".selector").igMaskEditor("option", "spinDelta", 1);
          
  • &nbspspinOnReadOnly

    Type:
    bool
    Default:
    false

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

    Code Sample

     
            //Initialize
            $(".selector").igMaskEditor({
                spinOnReadOnly : true
            });
    
            //Get
            var spin = $(".selector").igMaskEditor("option", "spinOnReadOnly");
    
            //Set
            $(".selector").igMaskEditor("option", "spinOnReadOnly", 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.
    In case of listOfItems, the first and the last items in list are used as minimum and maximum values.

    Code Sample

     
            //Initialize
            $(".selector").igMaskEditor({
                spinWrapAround : true
            });
    
            //Get
            var spinAround = $(".selector").igMaskEditor("option", "spinWrapAround");
    
            //Set
            $(".selector").igMaskEditor("option", "spinWrapAround", true);
            
  • &nbsptabIndex

    Type:
    number
    Default:
    null

    Gets sets value in tabIndex for editor.

    Code Sample

     
            //Initialize
            $(".selector").igMaskEditor({
                tabIndex : 3
            });
    
            //Get
            var tabIndex = $(".selector").igMaskEditor("option", "tabIndex");
    
            //Set
            $(".selector").igMaskEditor("option", "tabIndex", 3);
            
  • &nbsptextAlign

    Type:
    enumeration
    Default:
    null

    Sets gets horizontal alignment of text in editor. 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.

    Members

    • null
    • Type:object
    • left
    • Type:string
    • right
    • Type:string
    • center
    • Type:string

    Code Sample

     
            //Initialize
            $(".selector").igMaskEditor({
                textAlign : "center"
            });
    
            //Get
            var align = $(".selector").igMaskEditor("option", "textAlign");
    
            //Set
            $(".selector").igMaskEditor("option", "textAlign", "center");
            
  • &nbsptextMode

    Type:
    enumeration
    Default:
    null

    Sets gets text mode of editor such as: single-line text editor, password editor or multiline editor.

    Members

    • text
    • Type:string
    • single line text editor based on INPUT element is created.
    • password
    • Type:string
    • editor based on INPUT element is created.
    • multiline
    • Type:string
    • multiline editor based on TEXTAREA element is created. .
    • textarea
    • Type:string
    • multiline editor based on TEXTAREA element is created.

    Code Sample

     
            //Initialize
            $(".selector").igMaskEditor({
                textMode : "multiline"
            });
    
            //Get
            var mode = $(".selector").igMaskEditor("option", "textMode");
    
            //Set
            $(".selector").igMaskEditor("option", "textMode", "multiline");      
            
  • &nbsptheme

    Type:
    string
    Default:
    null

    Sets gets selector for css classes used by editor.
    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 renderInContainer or button are not enabled.

    Code Sample

     
            //Initialize
            $(".selector").igMaskEditor({
                theme : "redmond"
            });
    
            //Get
            var theme = $(".selector").igMaskEditor("option", "theme");
    
            //Set
            $(".selector").igMaskEditor("option", "theme", "redmond");
            
  • &nbsptoLower

    Type:
    bool
    Default:
    false

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

    Code Sample

     
            //Initialize
            $(".selector").igMaskEditor({
                toLower : true
            });
    
            //Get
            var toLower = $(".selector").igMaskEditor("option", "toLower");
    
            //Set
            $(".selector").igMaskEditor("option", "toLower", true);
            
  • &nbsptoUpper

    Type:
    bool
    Default:
    false

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

    Code Sample

     
            //Initialize
            $(".selector").igMaskEditor({
                toUpper : true
            });
    
            //Get
            var toUpper = $(".selector").igMaskEditor("option", "toUpper");
    
            //Set
            $(".selector").igMaskEditor("option", "toUpper", true);
            
  • &nbsptype

    Type:
    enumeration
    Default:
    null

    Sets type of editor. If that option is not set, but the 'value' option is defined, then if type of 'value' is Number, then the 'numeric' type is used, if type of 'value' is Date, then the 'date' type is used. For all other types of 'value' the 'text' type is used. 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').
    • date
    • Type:string
    • date-time editor is created.
    • 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').

    Code Sample

            //Initialize
            $(".selector").igMaskEditor({
             type: "text"
           });
     
          //Get
          var type= $(".selector").igMaskEditor("option", "type");
     
          //Set
          $(".selector").igMaskEditor("option", "type", 0);
          
  • &nbspvalidatorOptions

    Type:
    object
    Default:
    null

    Sets gets options supported by igValidator.
    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.

    Code Sample

     
            //Initialize
            $(".selector").igMaskEditor({
                validatorOptions : {
                    onblur: true,
    			    keepFocus: "once"
                }
            });
    
            //Get
            var validateOptions = $(".selector").igMaskEditor("option", "validatorOptions");
    
            //Set
            $(".selector").igMaskEditor("option", "validatorOptions", {onblur: true, keepFocus: "once"});
            
  • &nbspvalue

    Type:
    object
    Default:
    null

    Gets sets value in editor. The effect of setting/getting that option depends on type of editor and on dataMode options. That can be string, number or Date depending on type of editor. If it is used on initialization and the type option is missing, then if 'value' is Number, then 'numeric' editor is created automatically and if 'value' is Date, then the 'date' editor is created.

    Code Sample

     
            //Initialize
            $(".selector").igMaskEditor({
                value : 42
            });
    
            //Get
            var value = $(".selector").igMaskEditor("option", "value");
    
            //Set
            $(".selector").igMaskEditor("option", "value", 42);      
            
  • &nbspwidth

    Type:
    number
    Default:
    null

    Sets gets width of editor in pixels.
    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.

    Code Sample

     
            //Initialize
            $(".selector").igMaskEditor({
                width : 200
            });
    
            //Get
            var width = $(".selector").igMaskEditor("option", "width");
    
            //Set
            $(".selector").igMaskEditor("option", "width", 200);
            

For more information on how to interact with the NetAdvantage for jQuery controls events, refer to
Using Events in NetAdvantage for jQuery

Show Details
  • &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.

    Code Sample

              $(document).delegate(".selector", "igmaskeditorblur", function (evt) {
    
                  //return browser event
                  evt.originalEvent;
              });
    
              //Initialize
              $(".selector").igMaskEditor({
                  blur: function (evt) {
                  ...
                  }
              });
          
  • &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.

    Code Sample

               $(document).delegate(".selector", "igmaskeditorbuttonclick", function (evt) {
                    
                  //return browser event
                  evt.originalEvent;
              });
              
              //Initialize
              $(".selector").igMaskEditor({
                  buttonClick: function (evt) {
                  ...
                  }
              });
            
  • &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.

    Code Sample

                 $(document).delegate(".selector", "igmaskeditorfocus", function (evt) {
                      
                    //return browser event
                    evt.originalEvent;
                });
                
                //Initialize
                $(".selector").igMaskEditor({
                    focus: function (evt) {
                    ...
                    }
                });
              
  • &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.

    Code Sample

              $(document).delegate(".selector", "igmaskeditorhidedropdown", function (evt, ui) {
    
                  //return browser event
                  evt.originalEvent;
    
                  //return true if the drop down is closed due to selection and false if the drop down is closed due to losing focus or pressing Esc
                  ui.value;
              });
    
              //Initialize
              $(".selector").igMaskEditor({
                  hideDropDown: function (evt, ui) {...
                  }
              });
            
  • &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.

    Code Sample

            $(document).delegate(".selector", "igmaskeditorinvalidvalue", function (evt, ui) {
              //return browser event
              evt.originalEvent;
    
              //obtains the suggested value
              ui.value;
              //if type is numeric, currency, percent, date or datepicker contains actual text entered by user
              ui.text;
    
              //if editor is date or datepicker you have these additional members:
        
              //may have following flags: "null", "dayOfMonth", "numberOfFields", "limit", "invalid"
              ui.reason;
              //year of entered date
              ui.year;
              //month of entered date
              ui.month;
              //day of entered date
              ui.day;
              //hours of entered date
              ui.hours;
              //minutes of entered date
              ui.minutes;
              //seconds of entered date
              ui.seconds;
              //milliseconds of entered date
              ui.milliseconds;
          });
    
          //Initialize
          $(".selector").igMaskEditor({
              invalidValue: function (evt, ui) {
              ...
              }
          });
                
  • &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.

    Code Sample

            $(document).delegate(".selector", "igmaskeditorkeydown", function (evt, ui) {
    
              //use to obtain value of keyCode
              ui.key;
          });
    
          //Initialize
          $(".selector").igMaskEditor({
              keydown: function (evt, ui) {
              ...
              }
          });
          
  • &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.

    Code Sample

            $(document).delegate(".selector", "igmaskeditorkeypress", function (evt, ui) {
    
                //use to obtain value of keyCode
                ui.key;
                //set the ui.key to "A" -a cahracter which will replace the original entry
                ui.key = 65;
            });
    
            //Initialize
            $(".selector").igMaskEditor({
                keypress: function (evt, ui) {
                ...
                }
            });       
            
  • &nbspkeyup

    Cancellable:
    false

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

    Code Sample

            $(document).delegate(".selector", "igmaskeditorkeyup", function (evt, ui) {
    
                //use to obtain value of keyCode
                ui.key;
    
            });
    
            //Initialize
            $(".selector").igMaskEditor({
                keyup: function (evt, ui) {
                ...
                }
            });
            
  • &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.

    Code Sample

            $(document).delegate(".selector", "igmaskeditorlistselected", function (evt, ui) {
    
                //return browser event
                evt.originalEvent;
                //gets the new selected index
                ui.index;
                //gets the old selected index
                ui.oldIndex;
                //gets reference to the new selected item
                ui.item;
            });
    
            //Initialize
            $(".selector").igMaskEditor({
                listselected: function (evt, ui) {
                ...
                }
            });
            
  • &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.

    Code Sample

            $(document).delegate(".selector", "igmaskeditorlistselecting", function (evt, ui) {
    
                //return browser event
                evt.originalEvent;
                //gets the new selected index
                ui.index;
                //gets the old selected index
                ui.oldIndex;
                //gets reference to the new selected item
                ui.item;
            });
    
            //Initialize
            $(".selector").igMaskEditor({
                listselecting: function (evt, ui) {
                ...
                }
            });        
            
  • &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.

    Code Sample

            $(document).delegate(".selector", "igmaskeditormousedown", function (evt, ui) {
    
    
                //obtains type of html element under mouse, such as field, button, spinUpper, spinLower or item#.
                ui.elementType;
    
                //obtains id of html element under mouse, such as field, button, spinUpper, spinLower or item#.
                ui.id;
    
            });
    
            //Initialize
            $(".selector").igMaskEditor({
                mousedown: function (evt, ui) {
                ...
                }
            });
            
  • &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.

    Code Sample

            $(document).delegate(".selector", "igmaskeditormouseleave", function (evt, ui) {
    
    
                //obtains type of html element under mouse, such as field, button, spinUpper, spinLower or item#.
                ui.elementType;
    
                //obtains id of html element under mouse, such as field, button, spinUpper, spinLower or item#.
                ui.id;
            });
    
            //Initialize
            $(".selector").igMaskEditor({
                mouseleave: function (evt, ui) {
                ...
                }
            });
            
  • &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.

    Code Sample

            $(document).delegate(".selector", "igmaskeditormousemove", function (evt, ui) {
    
    
                //obtains type of html element under mouse, such as field, button, spinUpper, spinLower or item#.
                ui.elementType;
    
                //obtains id of html element under mouse, such as field, button, spinUpper, spinLower or item#.
                ui.id;
    
            });
    
            //Initialize
            $(".selector").igMaskEditor({
                mousemove: function (evt, ui) {
                ...
                }
            });
            
  • &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.

    Code Sample

          $(document).delegate(".selector", "igmaskeditormouseover", function (evt, ui) {
    
              //obtains type of html element under mouse, such as field, button, spinUpper, spinLower or item#.
              ui.elementType;
    
              //obtains id of html element under mouse, such as field, button, spinUpper, spinLower or item#.
              ui.id;
    
          });
    
          //Initialize
          $(".selector").igMaskEditor({
              mouseover: function (evt, ui) {
              ...
              }
          });
          
  • &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.

    Code Sample

            $(document).delegate(".selector", "igmaskeditormouseup", function (evt, ui) {
    
    
                //obtains type of html element under mouse, such as field, button, spinUpper, spinLower or item#.
                ui.elementType;
    
                //obtains id of html element under mouse, such as field, button, spinUpper, spinLower or item#.
                ui.id;
    
            });
    
            //Initialize
            $(".selector").igMaskEditor({
                mouseup: function (evt, ui) {
                ...
                }
            });
            
  • &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.

    Code Sample

            $(document).delegate(".selector", "igmaskeditorshowdropdown", function (evt) {
    
                //return browser event
                evt.originalEvent;
    
            });
    
            //Initialize
            $(".selector").igMaskEditor({
                showDropDown: function (evt) {
                ...
                }
            });
            
  • &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.

    Code Sample

            $(document).delegate(".selector", "igmaskeditorspin", function (evt, ui) {
    
                //gets delta for increment or decrement
                ui.delta;
                //gets the "value" of editor before spin action
                ui.value;
    
            });
    
            //Initialize
            $(".selector").igMaskEditor({
                spin: function (evt, ui) {
                ...
                }
            });
            
  • &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.

    Code Sample

            $(document).delegate(".selector", "igmaskeditortextchanged", function (evt, ui) {
    
                //gets the new value
                ui.value;
                //gets the old value
                ui.oldValue;
    
            });
    
            //Initialize
            $(".selector").igMaskEditor({
                textChanged: function (evt, ui) {
                ...
                }
            });
            
  • &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.

    Code Sample

     
            $(document).delegate(".selector", "igmaskeditorvaluechanged", function (evt, ui) {
    
              //gets the new value
              ui.value;
              //gets the old value
              ui.oldValue;
    
          });
    
          //Initialize
          $(".selector").igMaskEditor({
              valueChanged: function (evt, ui) {
              ...
              }
          });
          
  • &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.

    Code Sample

            $(document).delegate(".selector", "igmaskeditorvaluechanging", function (evt, ui) {
    
                //gets the new value
                ui.value;
                //gets the old value
                ui.oldValue;
    
            });
    
            //Initialize
            $(".selector").igMaskEditor({
                valueChanging: function (evt, ui) {
                ...
                }
            });
            
  • &nbspaddListItem

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

    Adds item to list.

    • item
    • Type:object
    • Item for list. It can be string, number or Date object.
    • 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.

    Code Sample

     
          $(".selector").igMaskEditor("addListItem", "New Item", 0);
          
  • &nbspaddListItems

    .igMaskEditor( "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.

    Code Sample

     
          $(".selector").igMaskEditor("addListItems", ["red", "blue"], 0);
          
          
  • &nbspclearListItems

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

    Removes all items from list.

    Code Sample

     
            $(".selector").igMaskEditor("clearListItems");
          
  • &nbspdestroy

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

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

    Code Sample

     
          $(".selector").igMaskEditor("destroy");
          
  • &nbspdropDownElement

    .igMaskEditor( "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.

    Code Sample

     
          var container = $(".selector").igMaskEditor("dropDownElement");
          
  • &nbspdropDownVisible

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

    Gets sets visibility of drop-down list.
    returnType="bool|object" If parameter is defined, then returns reference to this igCombo, otherwise, returns true if drop down is visible and false if drop down is hidden.

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

    Code Sample

     
            //Get
            var isVisible = $(".selector").igMaskEditor("dropDownVisible");
    
            //Set
            $(".selector").igMaskEditor("dropDownVisible", true);
            
  • &nbspfield

    .igMaskEditor( "field" );

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

    Code Sample

     
          var field = $(".selector").igMaskEditor("field");
          
  • &nbspfindListItemIndex

    .igMaskEditor( "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.

    Code Sample

     
            var index = $(".selector").igMaskEditor("findListItemIndex", "search value", true);     
            
  • &nbspgetRegionalOption

    .igMaskEditor( "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.

    Code Sample

     
                var dayNames = $(".selector").igMaskEditor("getRegionalOption", "dayNames");
          
  • &nbspgetSelectedListItem

    .igMaskEditor( "getSelectedListItem" );

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

    Code Sample

     
          var item = $(".selector").igMaskEditor("getSelectedListItem");
          
  • &nbspgetSelectedText

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

    Gets selected text in editor.

    Code Sample

     
          var text = $(".selector").igMaskEditor("getSelectedText");
          
  • &nbspgetSelection

    .igMaskEditor( "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.

    Code Sample

            $(".selector").igMaskEditor("getSelection",true);
            
  • &nbspgetValueByMode

    .igMaskEditor( "getValueByMode", mode:string, [v:object], [getVal:object] );

    Get value in editor by dataMode.
    returnType="string|number|date|object" Returns value in editor or null.

    • mode
    • Type:string
    • The value of dataMode option supported by editor. It can be string or number. 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.
    • v
    • Type:object
    • Optional
    • Internal use only.
    • getVal
    • Type:object
    • Optional
    • Internal use only.

    Code Sample

     
            var textValue = $(".selector").igMaskEditor("getValueByMode", "text");      
            
  • &nbsphasFocus

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

    Checks if editor has focus.

    Code Sample

           
            var focus = $(".selector").igMaskEditor("hasFocus");
            
  • &nbsphasInvalidMessage

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

    Checks if invalid message is displayed.

    Code Sample

     
          var hasInvalidMessage = $(".selector").igMaskEditor("hasInvalidMessage");      
          
  • &nbsphide

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

    Hides editor.

    Code Sample

     
          $(".selector").igMaskEditor("hide");
          
  • &nbspisValid

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

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

    Code Sample

     
          var isValid = $(".selector").igMaskEditor("isValid");
          
  • &nbspmainElement

    .igMaskEditor( "mainElement" );

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

    Code Sample

     
          var element = $(".selector").igMaskEditor("mainElement");
          
  • &nbsppaste

    .igMaskEditor( "paste", txt:string, [flag:bool] );
    Return Type:
    object

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

    • txt
    • Type:string
    • New text to paste.
    • flag
    • Type:bool
    • Optional
    • Internal use only.

    Code Sample

          $(".selector").igMaskEditor("paste","text");
          
  • &nbspremove

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

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

    Code Sample

     
          $(".selector").igMaskEditor("remove");
          
  • &nbspremoveListItem

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

    Removes item from list.

    • item
    • Type:object
    • Current item in list. It can be string, number or Date object.

    Code Sample

     
          $(".selector").igMaskEditor("removeListItem", "red");
  • &nbspremoveListItemAt

    .igMaskEditor( "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.

    Code Sample

     
          $(".selector").igMaskEditor("removeListItemAt", 0);
          
  • &nbspselect

    .igMaskEditor( "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).

    Code Sample

            $(".selector").igMaskEditor("select",1,5);
            
  • &nbspselectedListIndex

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

    Gets sets selected index of list item.

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

    Code Sample

     
            //Get
            var index = $(".selector").igMaskEditor("selectedListIndex");
    
            //Set
            $(".selector").igMaskEditor("selectedListIndex", 1);
            
  • &nbspsetFocus

    .igMaskEditor( "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.

    Code Sample

     
          $(".selector").igMaskEditor("setFocus", true);
          
  • &nbspshow

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

    Shows editor (if it was hidden).

    Code Sample

     
          $(".selector").igMaskEditor("show");
  • &nbspspin

    .igMaskEditor( "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.

    Code Sample

     
          $(".selector").igMaskEditor("spin", 1);
          
  • &nbsptext

    .igMaskEditor( "text", [val:string], [flag:number] );

    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.
    • flag
    • Type:number
    • Optional
    • Internal use only.

    Code Sample

     
            //Get
            var text = $(".selector").igMaskEditor("text");
    
            //Set
            $(".selector").igMaskEditor("text", "new text");
            
  • &nbspvalidate

    .igMaskEditor( "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.

    Code Sample

     
          $(".selector").igMaskEditor("validate");
          
  • &nbspvalidator

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

    Gets reference to igValidator used by igEditor.

    Code Sample

              var validator = $(".selector").igMaskEditor("validator");
          
  • &nbspvalue

    .igMaskEditor( "value", [val:object] );

    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:object
    • Optional
    • New value for editor. It can be string, number or Date object.

    Code Sample

     
            //Get
            var editorVal = $(".selector").igMaskEditor("value");
    
            //Set
            $(".selector").igMaskEditor("value", 42);
            
  • ui-igedit-button

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

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

    Class applied to the SPAN element which represents image on clear button. Default value is 'ui-igedit-buttonimage ui-icon-circle-close ui-icon'.
  • 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

    Classes applied to the SPAN element of button when editor has focus. Default value is 'ui-igedit-buttonfocus'.
  • 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-button-rtl

    Class applied to the SPAN element which represents button when direction is rtl. Default value is 'ui-igedit-button-rtl'.
  • 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-container

    Class applied to the top element when editor is rendered in container. Default value is 'ui-igedit-container'.
  • 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 ui-state-default ui-widget ui-corner-all

    Class applied to the main/top element. Default value is 'ui-igedit ui-state-default ui-widget ui-corner-all'.
  • ui-igedit-field

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

    Class applied to the field when direction is rtl. Default value is 'ui-igedit-rtl'.
  • ui-igedit-focus ui-state-focus

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

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

    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-corner-all'.
  • 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-no-bottom-corners

    Class applied to the main element when list is below editor and to list when list is above editor. Default value is 'ui-igedit-no-bottom-corners'.
  • ui-igedit-no-top-corners

    Class applied to the main element when list is above editor and to list when list is below editor. Default value is 'ui-igedit-no-top-corners'.
  • 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-buttonimage ui-igedit-spinbuttonimage

    Class applied to the SPAN element which represents image on spin button. Default value is 'ui-igedit-spinbuttonimage ui-igedit-spinbuttonimage'.
  • ui-igedit-spinlowerimage ui-icon-carat-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-carat-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-carat-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-carat-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'.