Hierarchy

Hierarchy

Constructors

Properties

Accessors

Methods

Constructors

Properties

context: any

If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType. Should be used with type annotation or static contextType.

static contextType = MyContext
// For TS pre-3.7:
context!: React.ContextType<typeof MyContext>
// For TS 3.7 and above:
declare context: React.ContextType<typeof MyContext>
props: Readonly<IIgrMultiColumnComboBoxProps> & Readonly<{
    children?: ReactNode;
}>
refs: {
    [key: string]: ReactInstance;
}

Type declaration

  • [key: string]: ReactInstance
state: Readonly<{}>
contextType?: Context<any>

If set, this.context will be set at runtime to the current value of the given Context.

Usage:

type MyContext = number
const Ctx = React.createContext<MyContext>(0)

class Foo extends React.Component {
static contextType = Ctx
context!: React.ContextType<typeof Ctx>
render () {
return <>My context's value: {this.context}</>;
}
}

Accessors

  • get actualBackgroundColor(): string
  • Gets the actual opacity to use for the underline ripple element.

    Returns string

  • set actualBackgroundColor(v): void
  • Parameters

    • v: string

    Returns void

  • get actualBaseTheme(): BaseControlTheme
  • Gets the actual display baseTheme to use for the component.

    Returns BaseControlTheme

  • set actualBaseTheme(v): void
  • Parameters

    • v: BaseControlTheme

    Returns void

  • get actualBorderColor(): string
  • Gets the actual item background color.

    Returns string

  • set actualBorderColor(v): void
  • Parameters

    • v: string

    Returns void

  • get actualBorderWidth(): number
  • Gets the actual item border width.

    Returns number

  • set actualBorderWidth(v): void
  • Parameters

    • v: number

    Returns void

  • get actualContentPaddingBottom(): number
  • Returns number

  • set actualContentPaddingBottom(v): void
  • Parameters

    • v: number

    Returns void

  • get actualContentPaddingLeft(): number
  • Returns number

  • set actualContentPaddingLeft(v): void
  • Parameters

    • v: number

    Returns void

  • get actualContentPaddingRight(): number
  • Returns number

  • set actualContentPaddingRight(v): void
  • Parameters

    • v: number

    Returns void

  • get actualContentPaddingTop(): number
  • Returns number

  • set actualContentPaddingTop(v): void
  • Parameters

    • v: number

    Returns void

  • get actualCornerRadiusBottomLeft(): number
  • Returns number

  • set actualCornerRadiusBottomLeft(v): void
  • Parameters

    • v: number

    Returns void

  • get actualCornerRadiusBottomRight(): number
  • Returns number

  • set actualCornerRadiusBottomRight(v): void
  • Parameters

    • v: number

    Returns void

  • get actualCornerRadiusTopLeft(): number
  • Returns number

  • set actualCornerRadiusTopLeft(v): void
  • Parameters

    • v: number

    Returns void

  • get actualCornerRadiusTopRight(): number
  • Returns number

  • set actualCornerRadiusTopRight(v): void
  • Parameters

    • v: number

    Returns void

  • get actualDataSource(): IDataSource
  • 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.

    Returns IDataSource

  • get actualDensity(): ControlDisplayDensity
  • Gets the actual display Density to use for the component.

    Returns ControlDisplayDensity

  • set actualDensity(v): void
  • Parameters

    • v: ControlDisplayDensity

    Returns void

  • get actualFocusBorderColor(): string
  • Gets the actual item border color.

    Returns string

  • set actualFocusBorderColor(v): void
  • Parameters

    • v: string

    Returns void

  • get actualFocusBorderWidth(): number
  • Gets the actual item border width.

    Returns number

  • set actualFocusBorderWidth(v): void
  • Parameters

    • v: number

    Returns void

  • get actualFocusUnderlineColor(): string
  • Gets the actual color to use for the underline element when focused.

    Returns string

  • set actualFocusUnderlineColor(v): void
  • Parameters

    • v: string

    Returns void

  • get actualFocusUnderlineOpacity(): number
  • Gets the actual opacity to use for the underline element when focused.

    Returns number

  • set actualFocusUnderlineOpacity(v): void
  • Parameters

    • v: number

    Returns void

  • get actualFocusUnderlineRippleOpacity(): number
  • Gets the actual opacity to use for the underline ripple element when focused.

    Returns number

  • set actualFocusUnderlineRippleOpacity(v): void
  • Parameters

    • v: number

    Returns void

  • get actualHoverUnderlineColor(): string
  • Gets the actual color to use for the underline element.

    Returns string

  • set actualHoverUnderlineColor(v): void
  • Parameters

    • v: string

    Returns void

  • get actualHoverUnderlineOpacity(): number
  • Gets the actual opacity to use for the underline element when hovered.

    Returns number

  • set actualHoverUnderlineOpacity(v): void
  • Parameters

    • v: number

    Returns void

  • get actualHoverUnderlineWidth(): number
  • Gets the width to use for the underline element when hovered.

    Returns number

  • set actualHoverUnderlineWidth(v): void
  • Parameters

    • v: number

    Returns void

  • get actualLabelTextColor(): string
  • Gets the actual color to use for the text color.

    Returns string

  • set actualLabelTextColor(v): void
  • Parameters

    • v: string

    Returns void

  • get actualLabelVisible(): boolean
  • Gets or sets the visibility of the label.

    Returns boolean

  • set actualLabelVisible(v): void
  • Parameters

    • v: boolean

    Returns void

  • get actualNoMatchesFoundLabel(): string
  • Gets the actual text to display on the list when no suggested matches are found.

    Returns string

  • set actualNoMatchesFoundLabel(v): void
  • Parameters

    • v: string

    Returns void

  • get actualNoMatchesFoundLabelBackgroundColor(): string
  • Gets the actual color to use for the "no matches found" label.

    Returns string

  • set actualNoMatchesFoundLabelBackgroundColor(v): void
  • Parameters

    • v: string

    Returns void

  • get actualNoMatchesFoundLabelTextColor(): string
  • Gets the actual color to use for the "no matches found" label.

    Returns string

  • set actualNoMatchesFoundLabelTextColor(v): void
  • Parameters

    • v: string

    Returns void

  • get actualTextColor(): string
  • Gets the actual color to use for the text color.

    Returns string

  • set actualTextColor(v): void
  • Parameters

    • v: string

    Returns void

  • get actualUnderlineColor(): string
  • Gets the actual color to use for the underline element.

    Returns string

  • set actualUnderlineColor(v): void
  • Parameters

    • v: string

    Returns void

  • get actualUnderlineOpacity(): number
  • Gets the actual opacity to use for the underline element.

    Returns number

  • set actualUnderlineOpacity(v): void
  • Parameters

    • v: number

    Returns void

  • get actualUnderlineRippleColor(): string
  • Gets the actual color to use for the underline ripple element.

    Returns string

  • set actualUnderlineRippleColor(v): void
  • Parameters

    • v: string

    Returns void

  • get actualUnderlineRippleOpacity(): number
  • Gets the actual opacity to use for the underline ripple element.

    Returns number

  • set actualUnderlineRippleOpacity(v): void
  • Parameters

    • v: number

    Returns void

  • get actualUnderlineRippleWidth(): number
  • Gets the actual width to use for the underline element.

    Returns number

  • set actualUnderlineRippleWidth(v): void
  • Parameters

    • v: number

    Returns void

  • get actualUnderlineWidth(): number
  • Gets the actual width to use for the underline element.

    Returns number

  • set actualUnderlineWidth(v): void
  • Parameters

    • v: number

    Returns void

  • get actualValueField(): string[]
  • Gets the actual name of the field in the data source will be used as the Value of the MultiColumnComboBox.

    Returns string[]

  • set actualValueField(v): void
  • Parameters

    • v: string[]

    Returns void

  • get allowFilter(): boolean
  • Whether to allow filtering of the combo

    Returns boolean

  • set allowFilter(v): void
  • Parameters

    • v: boolean

    Returns void

  • get backgroundColor(): string
  • Gets or sets the background color to use for the input group.

    Returns string

  • set backgroundColor(v): void
  • Parameters

    • v: string

    Returns void

  • get baseTheme(): BaseControlTheme
  • Gets or sets the base built in theme to use for the component.

    Returns BaseControlTheme

  • set baseTheme(v): void
  • Parameters

    • v: BaseControlTheme

    Returns void

  • get borderColor(): string
  • Gets or sets the color to use the border of the input group.

    Returns string

  • set borderColor(v): void
  • Parameters

    • v: string

    Returns void

  • get borderWidth(): number
  • Gets or sets the border width to use for the border of the item group.

    Returns number

  • set borderWidth(v): void
  • Parameters

    • v: number

    Returns void

  • get change(): ((s, e) => void)
  • Returns ((s, e) => void)

  • set change(ev): void
  • Parameters

    Returns void

  • get changing(): ((s, e) => void)
  • Returns ((s, e) => void)

  • set changing(ev): void
  • Parameters

    Returns void

  • get columnHeadersVisible(): boolean
  • Gets or sets the visibility of the drop down button.

    Returns boolean

  • set columnHeadersVisible(v): void
  • Parameters

    • v: boolean

    Returns void

  • get contentPaddingBottom(): number
  • Returns number

  • set contentPaddingBottom(v): void
  • Parameters

    • v: number

    Returns void

  • get contentPaddingLeft(): number
  • Returns number

  • set contentPaddingLeft(v): void
  • Parameters

    • v: number

    Returns void

  • get contentPaddingRight(): number
  • Returns number

  • set contentPaddingRight(v): void
  • Parameters

    • v: number

    Returns void

  • get contentPaddingTop(): number
  • Returns number

  • set contentPaddingTop(v): void
  • Parameters

    • v: number

    Returns void

  • get cornerRadiusBottomLeft(): number
  • Returns number

  • set cornerRadiusBottomLeft(v): void
  • Parameters

    • v: number

    Returns void

  • get cornerRadiusBottomRight(): number
  • Returns number

  • set cornerRadiusBottomRight(v): void
  • Parameters

    • v: number

    Returns void

  • get cornerRadiusTopLeft(): number
  • Returns number

  • set cornerRadiusTopLeft(v): void
  • Parameters

    • v: number

    Returns void

  • get cornerRadiusTopRight(): number
  • Returns number

  • set cornerRadiusTopRight(v): void
  • Parameters

    • v: number

    Returns void

  • get 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.

    Returns any

  • set dataSource(v): void
  • Parameters

    • v: any

    Returns void

  • get 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.

    Returns string[]

  • set dataSourceDesiredProperties(v): void
  • Parameters

    • v: string[]

    Returns void

  • get defaultColumnWidth(): IgrColumnWidth
  • Gets or sets the default column width to use if a column as no local width.

    Returns IgrColumnWidth

  • set defaultColumnWidth(value): void
  • Parameters

    Returns void

  • get density(): ControlDisplayDensity
  • Gets or sets the display Density to use for the buttons and dropdown grid.

    Returns ControlDisplayDensity

  • set density(v): void
  • Parameters

    • v: ControlDisplayDensity

    Returns void

  • Gets or sets the visibility of the drop down button.

    Returns boolean

  • Parameters

    • v: boolean

    Returns void

  • get 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.

    Returns string[]

  • set fields(v): void
  • Parameters

    • v: string[]

    Returns void

  • get focusBorderColor(): string
  • Gets or sets the color to use the hovered background of the inputs in the group.

    Returns string

  • set focusBorderColor(v): void
  • Parameters

    • v: string

    Returns void

  • get focusBorderWidth(): number
  • Gets or sets the border width to use for the border of the item group when focused.

    Returns number

  • set focusBorderWidth(v): void
  • Parameters

    • v: number

    Returns void

  • get focusUnderlineColor(): string
  • Gets or sets the color to use for the underline element.

    Returns string

  • set focusUnderlineColor(v): void
  • Parameters

    • v: string

    Returns void

  • get focusUnderlineOpacity(): number
  • Gets or sets the color to use for the underline element.

    Returns number

  • set focusUnderlineOpacity(v): void
  • Parameters

    • v: number

    Returns void

  • get focusUnderlineRippleOpacity(): number
  • Gets or sets the opacity to use for the underline ripple element when focused.

    Returns number

  • set focusUnderlineRippleOpacity(v): void
  • Parameters

    • v: number

    Returns void

  • get gotFocus(): ((s, e) => void)
  • Returns ((s, e) => void)

  • set gotFocus(ev): void
  • Parameters

    Returns void

  • get height(): string
  • Returns string

  • set height(value): void
  • Parameters

    • value: string

    Returns void

  • get hoverUnderlineColor(): string
  • Gets or sets the color to use for the underline element.

    Returns string

  • set hoverUnderlineColor(v): void
  • Parameters

    • v: string

    Returns void

  • get hoverUnderlineOpacity(): number
  • Gets or sets the color to use for the underline element.

    Returns number

  • set hoverUnderlineOpacity(v): void
  • Parameters

    • v: number

    Returns void

  • get hoverUnderlineWidth(): number
  • Gets or sets the width to use for the underline element when hovered.

    Returns number

  • set hoverUnderlineWidth(v): void
  • Parameters

    • v: number

    Returns void

  • get i(): MultiColumnComboBox
  • Returns MultiColumnComboBox

  • get keyDown(): ((s, e) => void)
  • Returns ((s, e) => void)

  • set keyDown(ev): void
  • Parameters

    Returns void

  • get label(): string
  • The text displayed in the label portion of the control.

    Returns string

  • set label(v): void
  • Parameters

    • v: string

    Returns void

  • get labelTextColor(): string
  • Gets or sets the color to use for the text.

    Returns string

  • set labelTextColor(v): void
  • Parameters

    • v: string

    Returns void

  • get labelTextStyle(): string
  • Gets or sets the font to use for the combobox.

    Returns string

  • set labelTextStyle(v): void
  • Parameters

    • v: string

    Returns void

  • get lostFocus(): ((s, e) => void)
  • Returns ((s, e) => void)

  • set lostFocus(ev): void
  • Parameters

    Returns void

  • get noMatchesFoundLabel(): string
  • Gets or sets the text to display on the list when no suggested matches are found.

    Returns string

  • set noMatchesFoundLabel(v): void
  • Parameters

    • v: string

    Returns void

  • get noMatchesFoundLabelBackgroundColor(): string
  • Gets or sets the color to use for the "no matches found" label.

    Returns string

  • set noMatchesFoundLabelBackgroundColor(v): void
  • Parameters

    • v: string

    Returns void

  • get noMatchesFoundLabelTextColor(): string
  • Gets or sets the color to use for the "no matches found" label.

    Returns string

  • set noMatchesFoundLabelTextColor(v): void
  • Parameters

    • v: string

    Returns void

  • get noMatchesFoundLabelTextStyle(): string
  • Gets or sets the font to use for the combobox.

    Returns string

  • set noMatchesFoundLabelTextStyle(v): void
  • Parameters

    • v: string

    Returns void

  • get placeholder(): string
  • Placeholder text which gives the user a hint about what kind of text is expected.

    Returns string

  • set placeholder(v): void
  • Parameters

    • v: string

    Returns void

  • get rowSeparatorsVisible(): boolean
  • Gets or sets the visibility of the row separators in the drop down.

    Returns boolean

  • set rowSeparatorsVisible(v): void
  • Parameters

    • v: boolean

    Returns void

  • get showClearButton(): boolean
  • Gets or sets the ShowClearButton property to detirmine if the clear button is shown

    Returns boolean

  • set showClearButton(v): void
  • Parameters

    • v: boolean

    Returns void

  • get sortMode(): SortMode
  • Returns/sets the action to take when a column header is clicked.

    Returns SortMode

  • set sortMode(v): void
  • Parameters

    Returns void

  • get text(): string
  • The text displayed in the edit portion of the control.

    Returns string

  • set text(v): void
  • Parameters

    • v: string

    Returns void

  • get textChange(): ((s, e) => void)
  • Returns ((s, e) => void)

  • set textChange(ev): void
  • Parameters

    Returns void

  • get textColor(): string
  • Gets or sets the color to use for the text.

    Returns string

  • set textColor(v): void
  • Parameters

    • v: string

    Returns void

  • get textField(): string
  • Determines the name of the field in the data source will be used as the Text of the MultiColumnComboBox.

    Returns string

  • set textField(v): void
  • Parameters

    • v: string

    Returns void

  • get textStyle(): string
  • Gets or sets the font to use for the combobox.

    Returns string

  • set textStyle(v): void
  • Parameters

    • v: string

    Returns void

  • get underlineColor(): string
  • Gets or sets the color to use for the underline element.

    Returns string

  • set underlineColor(v): void
  • Parameters

    • v: string

    Returns void

  • get underlineOpacity(): number
  • Gets or sets the color to use for the underline element.

    Returns number

  • set underlineOpacity(v): void
  • Parameters

    • v: number

    Returns void

  • get underlineRippleColor(): string
  • Gets or sets the color to use for the underline ripple element.

    Returns string

  • set underlineRippleColor(v): void
  • Parameters

    • v: string

    Returns void

  • get underlineRippleOpacity(): number
  • Gets or sets the opacity to use for the underline ripple element.

    Returns number

  • set underlineRippleOpacity(v): void
  • Parameters

    • v: number

    Returns void

  • get underlineRippleWidth(): number
  • Gets or sets the width to use for the underline element.

    Returns number

  • set underlineRippleWidth(v): void
  • Parameters

    • v: number

    Returns void

  • get underlineWidth(): number
  • Gets or sets the width to use for the underline element.

    Returns number

  • set underlineWidth(v): void
  • Parameters

    • v: number

    Returns void

  • get 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.

    Returns any

  • set value(v): void
  • Parameters

    • v: any

    Returns void

  • get valueChange(): ((s, e) => void)
  • Returns ((s, e) => void)

  • set valueChange(ev): void
  • Parameters

    Returns void

  • get 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.

    Returns string[]

  • set valueField(v): void
  • Parameters

    • v: string[]

    Returns void

  • get width(): string
  • Returns string

  • set width(value): void
  • Parameters

    • value: string

    Returns void

Methods

  • Programmatically closes the list.

    Returns void

  • Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

    Parameters

    • error: Error
    • errorInfo: ErrorInfo

    Returns void

  • Returns void

  • Called immediately after updating occurs. Not called for the initial render.

    The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

    Parameters

    Returns void

  • Returns void

  • Returns void

  • Programmatically drops down the list.

    Returns void

  • Returns void

  • Returns void

  • Returns void

  • Returns void

  • Returns a serialized copy of the exported visual model

    Returns string

  • Exports visual information about the current state of the grid.

    Returns any

  • Parameters

    • name: string

    Returns any

  • Parameters

    • Optional callback: (() => void)
        • (): void
        • Returns void

    Returns void

  • Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it.

    Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.

    Parameters

    Returns any

  • Returns void

  • Returns DetailedReactHTMLElement<{
        children: any[];
        className: string;
        ref: ((ref) => void);
    }, any>

  • Selects all the text in the combo input area.

    Returns void

  • Type parameters

    Type Parameters

    • K extends never

    Parameters

    • state: {} | ((prevState, props) => {} | Pick<{}, K>) | Pick<{}, K>
    • Optional callback: (() => void)
        • (): void
        • Returns void

    Returns void

  • Parameters

    • nextProps: any
    • nextState: any

    Returns boolean

  • Returns void