Ignite UI for React

All
  • Public
  • Public/Protected
  • All

Interface IIgrComboEditorProps

Hierarchy

Hierarchy

  • IIgrComboEditorProps

Properties

Properties

Optional actualBackgroundColor

actualBackgroundColor?: string

Gets the actual opacity to use for the underline ripple element.

Optional actualBaseTheme

actualBaseTheme?: string | BaseControlTheme

Gets the actual display baseTheme to use for the component.

Optional actualBorderColor

actualBorderColor?: string

Gets the actual item background color.

Optional actualBorderWidth

actualBorderWidth?: string | number

Gets the actual item border width.

Optional actualContentPaddingBottom

actualContentPaddingBottom?: string | number

Optional actualContentPaddingLeft

actualContentPaddingLeft?: string | number

Optional actualContentPaddingRight

actualContentPaddingRight?: string | number

Optional actualContentPaddingTop

actualContentPaddingTop?: string | number

Optional actualCornerRadiusBottomLeft

actualCornerRadiusBottomLeft?: string | number

Optional actualCornerRadiusBottomRight

actualCornerRadiusBottomRight?: string | number

Optional actualCornerRadiusTopLeft

actualCornerRadiusTopLeft?: string | number

Optional actualCornerRadiusTopRight

actualCornerRadiusTopRight?: string | number

Optional actualDensity

actualDensity?: string | ControlDisplayDensity

Gets the actual display Density to use for the component.

Optional actualFocusBorderColor

actualFocusBorderColor?: string

Gets the actual item border color.

Optional actualFocusBorderWidth

actualFocusBorderWidth?: string | number

Gets the actual item border width.

Optional actualFocusUnderlineColor

actualFocusUnderlineColor?: string

Gets the actual color to use for the underline element when focused.

Optional actualFocusUnderlineOpacity

actualFocusUnderlineOpacity?: string | number

Gets the actual opacity to use for the underline element when focused.

Optional actualFocusUnderlineRippleOpacity

actualFocusUnderlineRippleOpacity?: string | number

Gets the actual opacity to use for the underline ripple element when focused.

Optional actualHoverUnderlineColor

actualHoverUnderlineColor?: string

Gets the actual color to use for the underline element.

Optional actualHoverUnderlineOpacity

actualHoverUnderlineOpacity?: string | number

Gets the actual opacity to use for the underline element when hovered.

Optional actualHoverUnderlineWidth

actualHoverUnderlineWidth?: string | number

Gets the width to use for the underline element when hovered.

Optional actualLabelTextColor

actualLabelTextColor?: string

Gets the actual color to use for the text color.

Optional actualLabelVisible

actualLabelVisible?: string | boolean

Gets or sets the visibility of the label.

Optional actualNoMatchesFoundLabel

actualNoMatchesFoundLabel?: string

Gets the actual text to display on the list when no suggested matches are found.

Optional actualNoMatchesFoundLabelBackgroundColor

actualNoMatchesFoundLabelBackgroundColor?: string

Gets the actual color to use for the "no matches found" label.

Optional actualNoMatchesFoundLabelTextColor

actualNoMatchesFoundLabelTextColor?: string

Gets the actual color to use for the "no matches found" label.

Optional actualTextColor

actualTextColor?: string

Gets the actual color to use for the text color.

Optional actualUnderlineColor

actualUnderlineColor?: string

Gets the actual color to use for the underline element.

Optional actualUnderlineOpacity

actualUnderlineOpacity?: string | number

Gets the actual opacity to use for the underline element.

Optional actualUnderlineRippleColor

actualUnderlineRippleColor?: string

Gets the actual color to use for the underline ripple element.

Optional actualUnderlineRippleOpacity

actualUnderlineRippleOpacity?: string | number

Gets the actual opacity to use for the underline ripple element.

Optional actualUnderlineRippleWidth

actualUnderlineRippleWidth?: string | number

Gets the actual width to use for the underline element.

Optional actualUnderlineWidth

actualUnderlineWidth?: string | number

Gets the actual width to use for the underline element.

Optional actualValueField

actualValueField?: string[]

Gets the actual name of the field in the data source will be used as the Value of the ComboEditor.

Optional allowFilter

allowFilter?: string | boolean

Whether to allow filtering of the combo

Optional backgroundColor

backgroundColor?: string

Gets or sets the background color to use for the input group.

Optional baseTheme

baseTheme?: string | BaseControlTheme

Gets or sets the base built in theme to use for the component.

Optional borderColor

borderColor?: string

Gets or sets the color to use the border of the input group.

Optional borderWidth

borderWidth?: string | number

Gets or sets the border width to use for the border of the item group.

Optional change

change?: ((s, e) => void)

Type declaration

    • (s, e): void

    • Parameters

      Returns void

Optional changing

changing?: ((s, e) => void)

Type declaration

    • (s, e): void

    • Parameters

      Returns void

Optional contentPaddingBottom

contentPaddingBottom?: string | number

Optional contentPaddingLeft

contentPaddingLeft?: string | number

Optional contentPaddingRight

contentPaddingRight?: string | number

Optional contentPaddingTop

contentPaddingTop?: string | number

Optional cornerRadiusBottomLeft

cornerRadiusBottomLeft?: string | number

Optional cornerRadiusBottomRight

cornerRadiusBottomRight?: string | number

Optional cornerRadiusTopLeft

cornerRadiusTopLeft?: string | number

Optional cornerRadiusTopRight

cornerRadiusTopRight?: string | number

Optional dataSource

dataSource?: any

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.

Optional dataSourceDesiredProperties

dataSourceDesiredProperties?: string[]

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.

Optional density

density?: string | ControlDisplayDensity

Gets or sets the display Density to use for the buttons and dropdown grid.

Optional dropDownButtonVisible

dropDownButtonVisible?: string | boolean

Gets or sets the visibility of the drop down button.

Optional fields

fields?: string[]

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.

Optional focusBorderColor

focusBorderColor?: string

Gets or sets the color to use the hovered background of the inputs in the group.

Optional focusBorderWidth

focusBorderWidth?: string | number

Gets or sets the border width to use for the border of the item group when focused.

Optional focusUnderlineColor

focusUnderlineColor?: string

Gets or sets the color to use for the underline element.

Optional focusUnderlineOpacity

focusUnderlineOpacity?: string | number

Gets or sets the color to use for the underline element.

Optional focusUnderlineRippleOpacity

focusUnderlineRippleOpacity?: string | number

Gets or sets the opacity to use for the underline ripple element when focused.

Optional gotFocus

gotFocus?: ((s, e) => void)

Type declaration

Optional height

height?: string

Optional hoverUnderlineColor

hoverUnderlineColor?: string

Gets or sets the color to use for the underline element.

Optional hoverUnderlineOpacity

hoverUnderlineOpacity?: string | number

Gets or sets the color to use for the underline element.

Optional hoverUnderlineWidth

hoverUnderlineWidth?: string | number

Gets or sets the width to use for the underline element when hovered.

Optional isFixed

isFixed?: string | boolean

Indicates that the dropdown will position itself relative to the window instead of the document.

Optional keyDown

keyDown?: ((s, e) => void)

Type declaration

Optional label

label?: string

The text displayed in the label portion of the control.

Optional labelTextColor

labelTextColor?: string

Gets or sets the color to use for the text.

Optional labelTextStyle

labelTextStyle?: string

Gets or sets the font to use for the combobox.

Optional lostFocus

lostFocus?: ((s, e) => void)

Type declaration

Optional noMatchesFoundLabel

noMatchesFoundLabel?: string

Gets or sets the text to display on the list when no suggested matches are found.

Optional noMatchesFoundLabelBackgroundColor

noMatchesFoundLabelBackgroundColor?: string

Gets or sets the color to use for the "no matches found" label.

Optional noMatchesFoundLabelTextColor

noMatchesFoundLabelTextColor?: string

Gets or sets the color to use for the "no matches found" label.

Optional noMatchesFoundLabelTextStyle

noMatchesFoundLabelTextStyle?: string

Gets or sets the font to use for the combobox.

Optional openAsChild

openAsChild?: string | boolean

Indicates that the dropdown should open as a child of the combobox.

Optional placeholder

placeholder?: string

Placeholder text which gives the user a hint about what kind of text is expected.

Optional selectedValueChanged

selectedValueChanged?: ((s, e) => void)

Type declaration

Optional text

text?: string

The text displayed in the edit portion of the control.

Optional textColor

textColor?: string

Gets or sets the color to use for the text.

Optional textField

textField?: string

Determines the name of the field in the data source will be used as the Text of the ComboEditor.

Optional textStyle

textStyle?: string

Gets or sets the font to use for the combobox.

Optional textValueChanged

textValueChanged?: ((s, e) => void)

Type declaration

Optional underlineColor

underlineColor?: string

Gets or sets the color to use for the underline element.

Optional underlineOpacity

underlineOpacity?: string | number

Gets or sets the color to use for the underline element.

Optional underlineRippleColor

underlineRippleColor?: string

Gets or sets the color to use for the underline ripple element.

Optional underlineRippleOpacity

underlineRippleOpacity?: string | number

Gets or sets the opacity to use for the underline ripple element.

Optional underlineRippleWidth

underlineRippleWidth?: string | number

Gets or sets the width to use for the underline element.

Optional underlineWidth

underlineWidth?: string | number

Gets or sets the width to use for the underline element.

Optional useTopLayer

useTopLayer?: string | boolean

Indicates that the dropdown will place itself into the browser top layer.

Optional value

value?: any

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.

Optional valueField

valueField?: string[]

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.

Optional width

width?: string