IgrComboEditor

new IgrComboEditor(props: IIgrComboEditorProps): IgrComboEditor

Returns IgrComboEditor

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

get actualBackgroundColor(): string

Returns string

set actualBackgroundColor(v: string): void

Parameters

  • v: string

Returns void

Gets the actual display baseTheme to use for the component.

get actualBaseTheme(): BaseControlTheme

Returns BaseControlTheme

set actualBaseTheme(v: BaseControlTheme): void

Parameters

  • v: BaseControlTheme

Returns void

Gets the actual item background color.

get actualBorderColor(): string

Returns string

set actualBorderColor(v: string): void

Parameters

  • v: string

Returns void

Gets the actual item border width.

get actualBorderWidth(): number

Returns number

set actualBorderWidth(v: number): void

Parameters

  • v: number

Returns void

get actualContentPaddingBottom(): number

Returns number

set actualContentPaddingBottom(v: number): void

Parameters

  • v: number

Returns void

get actualContentPaddingLeft(): number

Returns number

set actualContentPaddingLeft(v: number): void

Parameters

  • v: number

Returns void

get actualContentPaddingRight(): number

Returns number

set actualContentPaddingRight(v: number): void

Parameters

  • v: number

Returns void

get actualContentPaddingTop(): number

Returns number

set actualContentPaddingTop(v: number): void

Parameters

  • v: number

Returns void

get actualCornerRadiusBottomLeft(): number

Returns number

set actualCornerRadiusBottomLeft(v: number): void

Parameters

  • v: number

Returns void

get actualCornerRadiusBottomRight(): number

Returns number

set actualCornerRadiusBottomRight(v: number): void

Parameters

  • v: number

Returns void

get actualCornerRadiusTopLeft(): number

Returns number

set actualCornerRadiusTopLeft(v: number): void

Parameters

  • v: number

Returns void

get actualCornerRadiusTopRight(): number

Returns number

set actualCornerRadiusTopRight(v: number): void

Parameters

  • v: number

Returns void

Gets the actual data source that is being used by the combo box list. If a collection was provided for the combo box data, an implicit LocalDataSource has been created, and this is available via this property.

get actualDataSource(): IDataSource

Returns IDataSource

Gets the actual display Density to use for the component.

get actualDensity(): ControlDisplayDensity

Returns ControlDisplayDensity

set actualDensity(v: ControlDisplayDensity): void

Parameters

  • v: ControlDisplayDensity

Returns void

Gets the actual item border color.

get actualFocusBorderColor(): string

Returns string

set actualFocusBorderColor(v: string): void

Parameters

  • v: string

Returns void

Gets the actual item border width.

get actualFocusBorderWidth(): number

Returns number

set actualFocusBorderWidth(v: number): void

Parameters

  • v: number

Returns void

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

get actualFocusUnderlineColor(): string

Returns string

set actualFocusUnderlineColor(v: string): void

Parameters

  • v: string

Returns void

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

get actualFocusUnderlineOpacity(): number

Returns number

set actualFocusUnderlineOpacity(v: number): void

Parameters

  • v: number

Returns void

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

get actualFocusUnderlineRippleOpacity(): number

Returns number

set actualFocusUnderlineRippleOpacity(v: number): void

Parameters

  • v: number

Returns void

Gets the actual color to use for the underline element.

get actualHoverUnderlineColor(): string

Returns string

set actualHoverUnderlineColor(v: string): void

Parameters

  • v: string

Returns void

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

get actualHoverUnderlineOpacity(): number

Returns number

set actualHoverUnderlineOpacity(v: number): void

Parameters

  • v: number

Returns void

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

get actualHoverUnderlineWidth(): number

Returns number

set actualHoverUnderlineWidth(v: number): void

Parameters

  • v: number

Returns void

Gets the actual color to use for the text color.

get actualLabelTextColor(): string

Returns string

set actualLabelTextColor(v: string): void

Parameters

  • v: string

Returns void

Gets or sets the visibility of the label.

get actualLabelVisible(): boolean

Returns boolean

set actualLabelVisible(v: boolean): void

Parameters

  • v: boolean

Returns void

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

get actualNoMatchesFoundLabel(): string

Returns string

set actualNoMatchesFoundLabel(v: string): void

Parameters

  • v: string

Returns void

actualNoMatchesFoundLabelBackgroundColor

Section titled "actualNoMatchesFoundLabelBackgroundColor"

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

get actualNoMatchesFoundLabelBackgroundColor(): string

Returns string

set actualNoMatchesFoundLabelBackgroundColor(v: string): void

Parameters

  • v: string

Returns void

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

get actualNoMatchesFoundLabelTextColor(): string

Returns string

set actualNoMatchesFoundLabelTextColor(v: string): void

Parameters

  • v: string

Returns void

Gets the actual color to use for the text color.

get actualTextColor(): string

Returns string

set actualTextColor(v: string): void

Parameters

  • v: string

Returns void

Gets the actual color to use for the underline element.

get actualUnderlineColor(): string

Returns string

set actualUnderlineColor(v: string): void

Parameters

  • v: string

Returns void

Gets the actual opacity to use for the underline element.

get actualUnderlineOpacity(): number

Returns number

set actualUnderlineOpacity(v: number): void

Parameters

  • v: number

Returns void

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

get actualUnderlineRippleColor(): string

Returns string

set actualUnderlineRippleColor(v: string): void

Parameters

  • v: string

Returns void

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

get actualUnderlineRippleOpacity(): number

Returns number

set actualUnderlineRippleOpacity(v: number): void

Parameters

  • v: number

Returns void

Gets the actual width to use for the underline element.

get actualUnderlineRippleWidth(): number

Returns number

set actualUnderlineRippleWidth(v: number): void

Parameters

  • v: number

Returns void

Gets the actual width to use for the underline element.

get actualUnderlineWidth(): number

Returns number

set actualUnderlineWidth(v: number): void

Parameters

  • v: number

Returns void

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

get actualValueField(): string[]

Returns string[]

set actualValueField(v: string[]): void

Parameters

  • v: string[]

Returns void

Whether to allow filtering of the combo

get allowFilter(): boolean

Returns boolean

set allowFilter(v: boolean): void

Parameters

  • v: boolean

Returns void

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

get backgroundColor(): string

Returns string

set backgroundColor(v: string): void

Parameters

  • v: string

Returns void

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

get baseTheme(): BaseControlTheme

Returns BaseControlTheme

set baseTheme(v: BaseControlTheme): void

Parameters

  • v: BaseControlTheme

Returns void

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

get borderColor(): string

Returns string

set borderColor(v: string): void

Parameters

  • v: string

Returns void

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

get borderWidth(): number

Returns number

set borderWidth(v: number): void

Parameters

  • v: number

Returns void

get change(): object

Returns object

set change(ev: object): void

Parameters

  • ev: object

Returns void

get changing(): object

Returns object

set changing(ev: object): void

Parameters

  • ev: object

Returns void

get contentPaddingBottom(): number

Returns number

set contentPaddingBottom(v: number): void

Parameters

  • v: number

Returns void

get contentPaddingLeft(): number

Returns number

set contentPaddingLeft(v: number): void

Parameters

  • v: number

Returns void

get contentPaddingRight(): number

Returns number

set contentPaddingRight(v: number): void

Parameters

  • v: number

Returns void

get contentPaddingTop(): number

Returns number

set contentPaddingTop(v: number): void

Parameters

  • v: number

Returns void

get cornerRadiusBottomLeft(): number

Returns number

set cornerRadiusBottomLeft(v: number): void

Parameters

  • v: number

Returns void

get cornerRadiusBottomRight(): number

Returns number

set cornerRadiusBottomRight(v: number): void

Parameters

  • v: number

Returns void

get cornerRadiusTopLeft(): number

Returns number

set cornerRadiusTopLeft(v: number): void

Parameters

  • v: number

Returns void

get cornerRadiusTopRight(): number

Returns number

set cornerRadiusTopRight(v: number): void

Parameters

  • v: number

Returns void

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.

get dataSource(): any

Returns any

set dataSource(v: any): void

Parameters

  • v: any

Returns void

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.

get dataSourceDesiredProperties(): string[]

Returns string[]

set dataSourceDesiredProperties(v: string[]): void

Parameters

  • v: string[]

Returns void

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

get density(): ControlDisplayDensity

Returns ControlDisplayDensity

set density(v: ControlDisplayDensity): void

Parameters

  • v: ControlDisplayDensity

Returns void

Gets or sets the visibility of the drop down button.

get dropDownButtonVisible(): boolean

Returns boolean

set dropDownButtonVisible(v: boolean): void

Parameters

  • v: boolean

Returns void

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.

get fields(): string[]

Returns string[]

set fields(v: string[]): void

Parameters

  • v: string[]

Returns void

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

get focusBorderColor(): string

Returns string

set focusBorderColor(v: string): void

Parameters

  • v: string

Returns void

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

get focusBorderWidth(): number

Returns number

set focusBorderWidth(v: number): void

Parameters

  • v: number

Returns void

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

get focusUnderlineColor(): string

Returns string

set focusUnderlineColor(v: string): void

Parameters

  • v: string

Returns void

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

get focusUnderlineOpacity(): number

Returns number

set focusUnderlineOpacity(v: number): void

Parameters

  • v: number

Returns void

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

get focusUnderlineRippleOpacity(): number

Returns number

set focusUnderlineRippleOpacity(v: number): void

Parameters

  • v: number

Returns void

get gotFocus(): object

Returns object

set gotFocus(ev: object): void

Parameters

  • ev: object

Returns void

get height(): string

Returns string

set height(value: string): void

Parameters

  • value: string

Returns void

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

get hoverUnderlineColor(): string

Returns string

set hoverUnderlineColor(v: string): void

Parameters

  • v: string

Returns void

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

get hoverUnderlineOpacity(): number

Returns number

set hoverUnderlineOpacity(v: number): void

Parameters

  • v: number

Returns void

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

get hoverUnderlineWidth(): number

Returns number

set hoverUnderlineWidth(v: number): void

Parameters

  • v: number

Returns void

get i(): ComboEditor

Returns ComboEditor

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

get isFixed(): boolean

Returns boolean

set isFixed(v: boolean): void

Parameters

  • v: boolean

Returns void

get keyDown(): object

Returns object

set keyDown(ev: object): void

Parameters

  • ev: object

Returns void

The text displayed in the label portion of the control.

get label(): string

Returns string

set label(v: string): void

Parameters

  • v: string

Returns void

Gets or sets the color to use for the text.

get labelTextColor(): string

Returns string

set labelTextColor(v: string): void

Parameters

  • v: string

Returns void

Gets or sets the font to use for the combobox.

get labelTextStyle(): string

Returns string

set labelTextStyle(v: string): void

Parameters

  • v: string

Returns void

get lostFocus(): object

Returns object

set lostFocus(ev: object): void

Parameters

  • ev: object

Returns void

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

get noMatchesFoundLabel(): string

Returns string

set noMatchesFoundLabel(v: string): void

Parameters

  • v: string

Returns void

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

get noMatchesFoundLabelBackgroundColor(): string

Returns string

set noMatchesFoundLabelBackgroundColor(v: string): void

Parameters

  • v: string

Returns void

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

get noMatchesFoundLabelTextColor(): string

Returns string

set noMatchesFoundLabelTextColor(v: string): void

Parameters

  • v: string

Returns void

Gets or sets the font to use for the combobox.

get noMatchesFoundLabelTextStyle(): string

Returns string

set noMatchesFoundLabelTextStyle(v: string): void

Parameters

  • v: string

Returns void

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

get openAsChild(): boolean

Returns boolean

set openAsChild(v: boolean): void

Parameters

  • v: boolean

Returns void

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

get placeholder(): string

Returns string

set placeholder(v: string): void

Parameters

  • v: string

Returns void

get selectedValueChanged(): object

Returns object

set selectedValueChanged(ev: object): void

Parameters

  • ev: object

Returns void

The text displayed in the edit portion of the control.

get text(): string

Returns string

set text(v: string): void

Parameters

  • v: string

Returns void

get textChange(): object

Returns object

set textChange(ev: object): void

Parameters

  • ev: object

Returns void

Gets or sets the color to use for the text.

get textColor(): string

Returns string

set textColor(v: string): void

Parameters

  • v: string

Returns void

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

get textField(): string

Returns string

set textField(v: string): void

Parameters

  • v: string

Returns void

Gets or sets the font to use for the combobox.

get textStyle(): string

Returns string

set textStyle(v: string): void

Parameters

  • v: string

Returns void

get textValueChanged(): object

Returns object

set textValueChanged(ev: object): void

Parameters

  • ev: object

Returns void

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

get underlineColor(): string

Returns string

set underlineColor(v: string): void

Parameters

  • v: string

Returns void

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

get underlineOpacity(): number

Returns number

set underlineOpacity(v: number): void

Parameters

  • v: number

Returns void

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

get underlineRippleColor(): string

Returns string

set underlineRippleColor(v: string): void

Parameters

  • v: string

Returns void

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

get underlineRippleOpacity(): number

Returns number

set underlineRippleOpacity(v: number): void

Parameters

  • v: number

Returns void

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

get underlineRippleWidth(): number

Returns number

set underlineRippleWidth(v: number): void

Parameters

  • v: number

Returns void

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

get underlineWidth(): number

Returns number

set underlineWidth(v: number): void

Parameters

  • v: number

Returns void

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

get useTopLayer(): boolean

Returns boolean

set useTopLayer(v: boolean): void

Parameters

  • v: boolean

Returns void

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.

get value(): any

Returns any

set value(v: any): void

Parameters

  • v: any

Returns void

get valueChange(): object

Returns object

set valueChange(ev: object): void

Parameters

  • ev: object

Returns void

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.

get valueField(): string[]

Returns string[]

set valueField(v: string[]): void

Parameters

  • v: string[]

Returns void

get width(): string

Returns string

set width(value: string): void

Parameters

  • value: string

Returns void

Programmatically closes the list.

closeUp(): void

Returns void

componentDidMount(): void

Returns void

componentWillUnmount(): void

Returns void

destroy(): void

Returns void

Programmatically drops down the list.

dropDown(): void

Returns void

enableDisableFiltering(allowFilter: boolean): void

Parameters

  • allowFilter: boolean

Returns void

ensureActualContentPadding(): void

Returns void

ensureActualCornerRadius(): void

Returns void

ensureContentPadding(): void

Returns void

ensureCornerRadius(): void

Returns void

Returns a serialized copy of the exported visual model

exportSerializedVisualModel(): string

Returns string

Exports visual information about the current state of the grid.

exportVisualModel(): any

Returns any

findByName(name: string): any

Parameters

  • name: string

Returns any

initializeContent(): void

Returns void

render(): DetailedReactHTMLElement<object, any>

Returns DetailedReactHTMLElement<object, any>

Selects all the text in the combo input area.

select(): void

Returns void

selectGridRow(index: number): void

Parameters

  • index: number

Returns void

shouldComponentUpdate(nextProps: any, nextState: any): boolean

Parameters

  • nextProps: any
  • nextState: any

Returns boolean

updateStyle(): void

Returns void

verifyDisplayText(): void

Returns void