Version

ComboModel Class Properties

For a list of all members of this type, see ComboModel members.

Public Properties
 NameDescription
Public PropertyAllowCustomValueGets or sets whether custom value is allowed in the combo.  
Public PropertyAnimationHideDurationGets sets hide drop-down list animation duration in milliseconds.  
Public PropertyAnimationShowDurationGets sets show drop-down list animation duration in milliseconds.  
Public PropertyAutoCompleteGets sets ability to autocomplete field from first matching item in list  
Public PropertyAutoSelectFirstMatchGets sets whether the first matching item should be auto selected when typing in input.  
Public PropertyCaseSensitiveGets sets whether filtering and auto selection should be case sensitive.  
Public PropertyClientEventsSet implementations of client events raised by a widget.

Event handler assumes 2 parameters: 1st parameter has name "evt" and 2nd parameter has name "ui". To get information about member variables available for "ui" parameter, please consult documentation of a widget and its events.

Examples:

1. Full implementation:

new Dictionary<string, string> { { "dropDownOpening", "function(evt,ui){alert('drop:'+ui.owner);}" } }

2. Content of inline function:

new Dictionary<string, string> { { "dropDownOpening", "alert('drop:'+ui.owner);" } }

3. Name of global function:

new Dictionary<string, string> { { "dropDownOpening", "nameOfGlobalFunction" } } Note:

Instead of explicit key-strings, which represent name of event exposed by a widget, the event-constants defined by a particular control can be used.

Example:

new Dictionary<string, string> { { ComboClientEvents.DropDownOpening, "nameOfGlobalFunction" } } (Inherited from Infragistics.Web.Mvc.ModelWidgetBase)
Public PropertyCloseDropDownOnBlurGets sets ability to close drop-down list when control loses focus.  
Public PropertyCloseDropDownOnSelectGets sets ability to close drop down list when single item in the list is selected with mouse click or enter press. The default value when multi selection is enabled will be false. This option will not close the drop down when multiple selection is enabled and selection with ctrl or shift is performed.  
Public PropertyCompactDataSet option to pass to client only data with ValueKey and TextKey columns.  
Public PropertyDataSourceGets sets a valid data source accepted by $.ig.DataSource, or an instance of an $.ig.DataSource itself.  
Public PropertyDataSourceTypeGets sets data source type (such as "json", "xml", etc). Please refer to the documentation of $.ig.DataSource and its type property.  
Public PropertyDataSourceUrlGets sets url which is used for sending JSON on request for remote filtering (MVC for example). That option is required when load on demand is enabled and its type is remote.  
Public PropertyDataViewthe DataView property contains the filtered and transformed data records after data binding and all feature transformations have been applied  
Public PropertyDelayFilteringOnKeyUpSpecifies the delay duration before triggering next filtering operation. Useful to boost performance by lowering the filtering operations count.  
Public PropertyDisabledSets enabled state of control.  
Public PropertyDropDownAttachedToBodyGets sets ability to append container of drop-down list to the body or to the parent of combo.  
Public PropertyDropDownOnFocusGets sets ability to show drop down list when combo gets focus. This option has effect only if mode is 'editable'  
Public PropertyDropDownOrientationGets sets drop down opening orientation for the drop down list when open button is clicked. 'auto' type="string" Calculate orientation depending on combo position. 'top' type="string" Top orientation. 'bottom' type="string" Bottom orientation.  
Public PropertyDropDownWidthGets sets width of drop down list in pixels  
Public PropertyEnableClearButtonSpecifies whether the clear button should be rendered  
Public PropertyFilterExprUrlKeyGets sets url key name that specifies how the remote filtering expressions will be encoded for remote requests, e.g. '&amp;filter('col') = startsWith.' Default is OData  
Public PropertyFilteringConditionGets sets condition used for filtering. type="contains|doesNotContain|startsWith|endsWith|greaterThan|lessThan|greaterThanOrEqualTo|lessThanOrEqualTo|equals|doesNotEqual  
Public PropertyFilteringLogicGets sets filtering logic. type="OR|AND"  
Public PropertyFilteringTypeGets sets type of filtering.  
Public PropertyFooterTemplateGets sets template used to render footer in drop-down list.  
Public PropertyFormatGets or sets the format string that is used to format the text display values in the combo. Valid options are: "auto" (default) - uses automatic formatting for Date and number objects. "none", "", or null - will disable formatting Custom values can be something like "currency", "percent", "dateLong", "time", "MMM-dd-yyyy H:mm tt", etc. Custom format strings should match the data type in "textKey" column.  
Public PropertyGroupingGets sets object specifying grouping feature options. The option has key and dir properties  
Public PropertyHeaderTemplateGets sets template used to render header in drop-down list.  
Public PropertyHeightGets sets height of combo.  
Public PropertyHighlightMatchesModeGets sets condition used for highlighting of matching parts in items of drop-down list. multi type="string" multiple matches in a single item are rendered. contains type="string" match at any position in item is rendered. startsWith type="string" only match which starts from the beginning of text is rendered. full type="string" only fully matched items are rendered. null type="object" matches are not rendered.  
Public PropertyHtmlAttributesSets custom attributes for main html element used by control  
Public PropertyIDSets the ID of the Combo.  
Public PropertyInitialSelectedItemsSettingsA list of initial selected items  
Public PropertyInputNameGets sets name of the hidden INPUT element, which is used when submiting data. Its value will be set to values of selected items valueKeys separated by "," character on any change in igCombo.  
Public PropertyItemTemplateGets sets template used to render an item in list.  
Public PropertyLanguageGets/sets Language the control (Inherited from Infragistics.Web.Mvc.Framework.LocalizationBaseModel)
Public PropertyLoadOnDemandSettingsSets load on demand settings. If CascadingSettings.ParentComboKey is set, then LoadOnDemand is not supported.  
Public PropertyLocaleSets strings used for combo button titles and placeholders. Note: Locale properties take priority over those defined in $.ig.Combo.locale in localization script files.  
Public PropertyModeSets gets functionality mode. editable type="string" Allows to modify value by edit field and drop-down list. dropdown type="string" Allows to modify value by drop-down list only. readonlylist type="string" Allows to open list, but does not allow any changes in field or selection in drop-down list. If selection is not set, then first item in dataSource is automatically selected. readonly type="string" Does not allow to open list or change value in field. If selection is not set, then first item in dataSource is automatically selected.  
Public PropertyMultiSelectionSettingsGets sets object specifying multi selection feature options. The object has following properties enabled, addWithKeyModifier, showCheckboxes and itemSeparator. Set enabled to true to turn multi selection on. Set addWithKeyModifier to true to disable the additive selection, then additive selection can be done by ctrl + mouse click / enter. Set showCheckboxes to true to render check boxes in front of each drop down item. Use itemSeparator to set what string to be rendered between items in field. Note showCheckboxes and itemSeparator has effect only if multi selection is enabled.  
Public PropertyPreventSubmitOnEnterGets sets ability to prevent form submitting on enter key press  
Public PropertyRegionalGets/sets the Regional of the control (Inherited from Infragistics.Web.Mvc.Framework.LocalizationBaseModel)
Public PropertyRequestTypeSpecifies the HTTP verb to be used to issue the request  
Public PropertyResponseContentTypeContent type of the response.  
Public PropertyResponseDataKeySets the name of record which holds the list of data rows in response-JSON object and when CompactData is disabled.  
Public PropertyResponseDataTypeResponse type when a URL is set as the data source.  
Public PropertyResponseTotalRecCountKeySets property in the response specifying the total number of records on the server.  
Public PropertySelectedIndexesSet gets indexes of selected items in list.  
Public PropertySelectedValuesSet gets selected items in list.  
Public PropertySelectItemBySpaceKeyGets sets ability to select items by space button press  
Public PropertySuppressKeyboardGets sets whether the onscreen keyboard should be shown when the dropdown button is clicked (touch devices only)  
Public PropertyTabIndexGets sets tabIndex for field of combo.  
Public PropertyTextKeyGets sets name of column which contains the displayed text.  
Public PropertyUseExistingElementSets the ID of the Combo.  
Public PropertyValidatorOptionsSets validator options. Note: this option will have effect only when application registers ig.ui.validator.js and ig.ui.validator.css.  
Public PropertyValueKeyGets sets name of column which contains the "value".  
Public PropertyVirtualizationGets sets ability to use virtual rendering for drop-down list. If that option is enabled, then only visible items are created and top edge of first visible item in list is aligned to the top edge of list.  
Public PropertyVisibleItemsCountGets sets how many items should be shown at once.  
Public PropertyWidthGets sets width of combo.  
Protected Properties
 NameDescription
Protected PropertyStoreReturn the store with all of the options (Inherited from Infragistics.Web.Mvc.ModelBase)
See Also

View on GitHub