Version

ColumnUpdatingComboEditorOptions Class Members

The following tables list the members exposed by ColumnUpdatingComboEditorOptions.

Public Constructors
Public Properties
 NameDescription
Public PropertyAnimationHideDurationSets duration of hide drop-down list animation in milliseconds.  
Public PropertyAnimationShowDurationSets duration of show drop-down list animation 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 PropertyCaseSensitiveSet ability to use case sensitive or ignore case searching for matches defined by RenderMatchItems and FilteringCondition.  
Public PropertyClearButtonTitleGets sets title for html element which represend clear button. That is an override for the $.ig.Combo.locale.clearButtonTitle.  
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 PropertyCompactDataSets ability to send to client all data or only required data (TextKey and ValueKey).  
Public PropertyDataSourceSet data source for data displayed in list.  
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 PropertyDelayFilteringOnKeyUpSpecifies the delay duration before triggering next filtering operation. Useful to boost performance by lowering the filtering operations count.  
Public PropertyDropDownAttachedToBodyGets sets ability to append container of drop-down list to the body or to the parent of combo.  
Public PropertyDropDownButtonTitleGets sets title for html element which represend drop-down button. That is an override for the $.ig.Combo.locale.dropDownButtonTitle.  
Public PropertyDropDownOnFocusSet ability to show drop-down list when Combo gets focus.  
Public PropertyDropDownOrientationGets sets drop down opening orientation for the dorp 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 PropertyDropDownWidthSets width of drop-down list in pixels.  
Public PropertyEnableClearButtonSet ability to show a button which allows to clear field.  
Public PropertyFilterExprUrlKeyGets sets url key name that specifies how the remote filtering expressions will be encoded for remote requests, e.g. '&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 PropertyIDSets 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 PropertyLoadOnDemandSettingsSets load on demand settings. If CascadingSettings.ParentComboKey is set, then LoadOnDemand is not supported.  
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 PropertyNoMatchFoundTextGets sets text of list item for condition when "filteringType" option is enabled and no match was found. That is an override for the $.ig.Combo.locale.noMatchFoundText.  
Public PropertyPlaceHolderGets sets value that is displayed when input field is empty. Default value is 'select...'.  
Public PropertyPreventSubmitOnEnterGets sets ability to prevent form submitting on enter key press  
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 PropertySelectItemBySpaceKeySet ability to select active item in list by Space key.  
Public PropertyTabIndexGets sets tabIndex for field of combo.  
Public PropertyTextKeySets name of column which contains the displayed text.  
Public PropertyUseExistingElementSets the ID of the Combo.  
Public PropertyValidatorOptionsSets validation options.  
Public PropertyValueKeySets 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)
Public Methods
 NameDescription
Public MethodToJsonSerializes the object to JSON. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected Methods
 NameDescription
Protected MethodCamelizeConverts the provided string to camel case. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodGetBoolGets the value of a bool property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodGetCharSets the value of a char property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodGetDateTimeGets the value of a DateTime property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodGetDoubleGets the value of a double property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodGetIEnumerable<T>Gets the value of an IEnumerable property of the model. If the value is null a new IEnumerable of type T will be created. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodGetIntGets the value of an int property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodGetJSLiteralSets the value of a literal property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodGetLongGets the value of a long property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodGetModel<T>Gets the value of an IModel property of the model. If the value is null a new model of type T will be created. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodGetStringGets the value of a string property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodGetStringEnum<T>Gets the value of a string property whose values are the lowercase values of an Enum. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodGetValue<T>Gets a property value of arbitrary type. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodGetValueModel<T>Gets the value of an IModel property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodJsonFromBoolSerializes a bool object into json. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodJsonFromDateTimeSerializes a DateTime object into json Date object. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodJsonFromDoubleSerializes a double object into json. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodJsonFromFloatSerializes a float object into json. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodJsonFromIDictionarySerializes an IDictionary of objects into json. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodJsonFromIEnumerableSerializes an IEnumerable object into json. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodJsonFromIntSerializes an int object into json. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodJsonFromModelStoreOverridden. ModelBase.JsonFromModelStore  
Protected MethodJsonFromObjectSerializes an arbitrary object in json using the typed serialization methods. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodJsonFromStringSerializes a string object into json string, escaping all single quotes. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodSetBoolSets a value to a bool property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodSetBrush (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodSetCamelizedStringEnum<T>Sets the value of a string property whose values are the lowercase values of an Enum. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodSetCharGets the value of a char property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodSetDateTimeSets a value to a DateTime property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodSetDoubleSets a value to a double property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodSetIEnumerable<T>Sets a value to an IEnumerable property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodSetIntSets a value to an int property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodSetJSLiteralGets the value of a literal property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodSetLongSets a value to a long property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodSetModel<T>Sets a value to an IModel property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodSetStringSets a value to a string property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodSetStringEnum<T>Sets the value of a string property whose values are the lowercase values of an Enum. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodSetValue<T>Sets a property value of arbitrary type. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodTransformDataTransforms the data. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodValidValueType<T>Checks type for value of existing property. Returns false as well if non existing property. (Inherited from Infragistics.Web.Mvc.ModelBase)
See Also

View on GitHub