IIgrComboEditorProps
Properties
Section titled "Properties"Optional actualBackgroundColor
Section titled "actualBackgroundColor"Gets the actual opacity to use for the underline ripple element.
actualBackgroundColor?: string Optional actualBaseTheme
Section titled "actualBaseTheme"Gets the actual display baseTheme to use for the component.
actualBaseTheme?: any Optional actualBorderColor
Section titled "actualBorderColor"Gets the actual item background color.
actualBorderColor?: string Optional actualBorderWidth
Section titled "actualBorderWidth"Gets the actual item border width.
actualBorderWidth?: string | number Optional actualContentPaddingBottom
Section titled "actualContentPaddingBottom"actualContentPaddingBottom?: string | number Optional actualContentPaddingLeft
Section titled "actualContentPaddingLeft"actualContentPaddingLeft?: string | number Optional actualContentPaddingRight
Section titled "actualContentPaddingRight"actualContentPaddingRight?: string | number Optional actualContentPaddingTop
Section titled "actualContentPaddingTop"actualContentPaddingTop?: string | number Optional actualCornerRadiusBottomLeft
Section titled "actualCornerRadiusBottomLeft"actualCornerRadiusBottomLeft?: string | number Optional actualCornerRadiusBottomRight
Section titled "actualCornerRadiusBottomRight"actualCornerRadiusBottomRight?: string | number Optional actualCornerRadiusTopLeft
Section titled "actualCornerRadiusTopLeft"actualCornerRadiusTopLeft?: string | number Optional actualCornerRadiusTopRight
Section titled "actualCornerRadiusTopRight"actualCornerRadiusTopRight?: string | number Optional actualDensity
Section titled "actualDensity"Gets the actual display Density to use for the component.
actualDensity?: any Optional actualFocusBorderColor
Section titled "actualFocusBorderColor"Gets the actual item border color.
actualFocusBorderColor?: string Optional actualFocusBorderWidth
Section titled "actualFocusBorderWidth"Gets the actual item border width.
actualFocusBorderWidth?: string | number Optional actualFocusUnderlineColor
Section titled "actualFocusUnderlineColor"Gets the actual color to use for the underline element when focused.
actualFocusUnderlineColor?: string Optional actualFocusUnderlineOpacity
Section titled "actualFocusUnderlineOpacity"Gets the actual opacity to use for the underline element when focused.
actualFocusUnderlineOpacity?: string | number Optional actualFocusUnderlineRippleOpacity
Section titled "actualFocusUnderlineRippleOpacity"Gets the actual opacity to use for the underline ripple element when focused.
actualFocusUnderlineRippleOpacity?: string | number Optional actualHoverUnderlineColor
Section titled "actualHoverUnderlineColor"Gets the actual color to use for the underline element.
actualHoverUnderlineColor?: string Optional actualHoverUnderlineOpacity
Section titled "actualHoverUnderlineOpacity"Gets the actual opacity to use for the underline element when hovered.
actualHoverUnderlineOpacity?: string | number Optional actualHoverUnderlineWidth
Section titled "actualHoverUnderlineWidth"Gets the width to use for the underline element when hovered.
actualHoverUnderlineWidth?: string | number Optional actualLabelTextColor
Section titled "actualLabelTextColor"Gets the actual color to use for the text color.
actualLabelTextColor?: string Optional actualLabelVisible
Section titled "actualLabelVisible"Gets or sets the visibility of the label.
actualLabelVisible?: string | boolean Optional actualNoMatchesFoundLabel
Section titled "actualNoMatchesFoundLabel"Gets the actual text to display on the list when no suggested matches are found.
actualNoMatchesFoundLabel?: string Optional actualNoMatchesFoundLabelBackgroundColor
Section titled "actualNoMatchesFoundLabelBackgroundColor"Gets the actual color to use for the "no matches found" label.
actualNoMatchesFoundLabelBackgroundColor?: string Optional actualNoMatchesFoundLabelTextColor
Section titled "actualNoMatchesFoundLabelTextColor"Gets the actual color to use for the "no matches found" label.
actualNoMatchesFoundLabelTextColor?: string Optional actualTextColor
Section titled "actualTextColor"Gets the actual color to use for the text color.
actualTextColor?: string Optional actualUnderlineColor
Section titled "actualUnderlineColor"Gets the actual color to use for the underline element.
actualUnderlineColor?: string Optional actualUnderlineOpacity
Section titled "actualUnderlineOpacity"Gets the actual opacity to use for the underline element.
actualUnderlineOpacity?: string | number Optional actualUnderlineRippleColor
Section titled "actualUnderlineRippleColor"Gets the actual color to use for the underline ripple element.
actualUnderlineRippleColor?: string Optional actualUnderlineRippleOpacity
Section titled "actualUnderlineRippleOpacity"Gets the actual opacity to use for the underline ripple element.
actualUnderlineRippleOpacity?: string | number Optional actualUnderlineRippleWidth
Section titled "actualUnderlineRippleWidth"Gets the actual width to use for the underline element.
actualUnderlineRippleWidth?: string | number Optional actualUnderlineWidth
Section titled "actualUnderlineWidth"Gets the actual width to use for the underline element.
actualUnderlineWidth?: string | number Optional actualValueField
Section titled "actualValueField"Gets the actual name of the field in the data source will be used as the Value of the ComboEditor.
actualValueField?: string[] Optional allowFilter
Section titled "allowFilter"Whether to allow filtering of the combo
allowFilter?: string | boolean Optional backgroundColor
Section titled "backgroundColor"Gets or sets the background color to use for the input group.
backgroundColor?: string Optional baseTheme
Section titled "baseTheme"Gets or sets the base built in theme to use for the component.
baseTheme?: any Optional borderColor
Section titled "borderColor"Gets or sets the color to use the border of the input group.
borderColor?: string Optional borderWidth
Section titled "borderWidth"Gets or sets the border width to use for the border of the item group.
borderWidth?: string | number Optional change
Section titled "change"change?: object Optional changing
Section titled "changing"changing?: object Optional contentPaddingBottom
Section titled "contentPaddingBottom"contentPaddingBottom?: string | number Optional contentPaddingLeft
Section titled "contentPaddingLeft"contentPaddingLeft?: string | number Optional contentPaddingRight
Section titled "contentPaddingRight"contentPaddingRight?: string | number Optional contentPaddingTop
Section titled "contentPaddingTop"contentPaddingTop?: string | number Optional cornerRadiusBottomLeft
Section titled "cornerRadiusBottomLeft"cornerRadiusBottomLeft?: string | number Optional cornerRadiusBottomRight
Section titled "cornerRadiusBottomRight"cornerRadiusBottomRight?: string | number Optional cornerRadiusTopLeft
Section titled "cornerRadiusTopLeft"cornerRadiusTopLeft?: string | number Optional cornerRadiusTopRight
Section titled "cornerRadiusTopRight"cornerRadiusTopRight?: string | number Optional dataSource
Section titled "dataSource"Gets or sets the data to which to bind the combo box list. This can be some type of array or list, or it can be an IDataSource instance.
dataSource?: any Optional dataSourceDesiredProperties
Section titled "dataSourceDesiredProperties"Gets or sets the desired properties for the data source to load. If specified the data source may decide to constrain the properties it fetches to these properties and must make sure that at least those properties are loaded, rather than the default behavior for that data source.
dataSourceDesiredProperties?: string[] Optional density
Section titled "density"Gets or sets the display Density to use for the buttons and dropdown grid.
density?: any Optional dropDownButtonVisible
Section titled "dropDownButtonVisible"Gets or sets the visibility of the drop down button.
dropDownButtonVisible?: string | boolean Optional fields
Section titled "fields"Gets or sets the desired properties for the data source to load. If specified the data source may decide to constrain the properties it fetches to these properties and must make sure that at least those properties are loaded, rather than the default behavior for that data source.
fields?: string[] Optional focusBorderColor
Section titled "focusBorderColor"Gets or sets the color to use the hovered background of the inputs in the group.
focusBorderColor?: string Optional focusBorderWidth
Section titled "focusBorderWidth"Gets or sets the border width to use for the border of the item group when focused.
focusBorderWidth?: string | number Optional focusUnderlineColor
Section titled "focusUnderlineColor"Gets or sets the color to use for the underline element.
focusUnderlineColor?: string Optional focusUnderlineOpacity
Section titled "focusUnderlineOpacity"Gets or sets the color to use for the underline element.
focusUnderlineOpacity?: string | number Optional focusUnderlineRippleOpacity
Section titled "focusUnderlineRippleOpacity"Gets or sets the opacity to use for the underline ripple element when focused.
focusUnderlineRippleOpacity?: string | number Optional gotFocus
Section titled "gotFocus"gotFocus?: object Optional height
Section titled "height"height?: string Optional hoverUnderlineColor
Section titled "hoverUnderlineColor"Gets or sets the color to use for the underline element.
hoverUnderlineColor?: string Optional hoverUnderlineOpacity
Section titled "hoverUnderlineOpacity"Gets or sets the color to use for the underline element.
hoverUnderlineOpacity?: string | number Optional hoverUnderlineWidth
Section titled "hoverUnderlineWidth"Gets or sets the width to use for the underline element when hovered.
hoverUnderlineWidth?: string | number Optional isFixed
Section titled "isFixed"Indicates that the dropdown will position itself relative to the window instead of the document.
isFixed?: string | boolean Optional keyDown
Section titled "keyDown"keyDown?: object Optional label
Section titled "label"The text displayed in the label portion of the control.
label?: string Optional labelTextColor
Section titled "labelTextColor"Gets or sets the color to use for the text.
labelTextColor?: string Optional labelTextStyle
Section titled "labelTextStyle"Gets or sets the font to use for the combobox.
labelTextStyle?: string Optional lostFocus
Section titled "lostFocus"lostFocus?: object Optional noMatchesFoundLabel
Section titled "noMatchesFoundLabel"Gets or sets the text to display on the list when no suggested matches are found.
noMatchesFoundLabel?: string Optional noMatchesFoundLabelBackgroundColor
Section titled "noMatchesFoundLabelBackgroundColor"Gets or sets the color to use for the "no matches found" label.
noMatchesFoundLabelBackgroundColor?: string Optional noMatchesFoundLabelTextColor
Section titled "noMatchesFoundLabelTextColor"Gets or sets the color to use for the "no matches found" label.
noMatchesFoundLabelTextColor?: string Optional noMatchesFoundLabelTextStyle
Section titled "noMatchesFoundLabelTextStyle"Gets or sets the font to use for the combobox.
noMatchesFoundLabelTextStyle?: string Optional openAsChild
Section titled "openAsChild"Indicates that the dropdown should open as a child of the combobox.
openAsChild?: string | boolean Optional placeholder
Section titled "placeholder"Placeholder text which gives the user a hint about what kind of text is expected.
placeholder?: string Optional selectedValueChanged
Section titled "selectedValueChanged"selectedValueChanged?: object Optional text
Section titled "text"The text displayed in the edit portion of the control.
text?: string Optional textColor
Section titled "textColor"Gets or sets the color to use for the text.
textColor?: string Optional textField
Section titled "textField"Determines the name of the field in the data source will be used as the Text of the ComboEditor.
textField?: string Optional textStyle
Section titled "textStyle"Gets or sets the font to use for the combobox.
textStyle?: string Optional textValueChanged
Section titled "textValueChanged"textValueChanged?: object Optional underlineColor
Section titled "underlineColor"Gets or sets the color to use for the underline element.
underlineColor?: string Optional underlineOpacity
Section titled "underlineOpacity"Gets or sets the color to use for the underline element.
underlineOpacity?: string | number Optional underlineRippleColor
Section titled "underlineRippleColor"Gets or sets the color to use for the underline ripple element.
underlineRippleColor?: string Optional underlineRippleOpacity
Section titled "underlineRippleOpacity"Gets or sets the opacity to use for the underline ripple element.
underlineRippleOpacity?: string | number Optional underlineRippleWidth
Section titled "underlineRippleWidth"Gets or sets the width to use for the underline element.
underlineRippleWidth?: string | number Optional underlineWidth
Section titled "underlineWidth"Gets or sets the width to use for the underline element.
underlineWidth?: string | number Optional useTopLayer
Section titled "useTopLayer"Indicates that the dropdown will place itself into the browser top layer.
useTopLayer?: string | boolean Optional value
Section titled "value"Gets or sets the Value of the combo. When the user selects an item from, the value is set based on the specified ValueField field. If not ValueField is specified, then the first field in the data source is used. When the user enters text into the combo, the list is searched based on the TextField field. If a matching string is found, the Value of the combo is the value of the ValueField field in the same row. If the text entered in the combo does not match any item on the list, then the value will return null.
value?: any Optional valueField
Section titled "valueField"Sets or gets the user provided primary key to assume for the data. Certain functionality of the combo (such as the the current Value) requires a way to uniquely identify items in order to work correctly. If a primary key cannot be inferred from the data source, you may need to provide one here.
valueField?: string[] Optional width
Section titled "width"width?: string