Class IgxMultiColumnComboBoxComponent

Hierarchy

Hierarchy

  • IgxMultiColumnComboBoxComponent

Implements

  • AfterContentInit

Constructors

Properties

Accessors

Methods

Constructors

  • Parameters

    • renderer: Renderer2
    • _elRef: ViewContainerRef
    • ngZone: NgZone
    • injector: Injector
    • componentFactoryResolver: ComponentFactoryResolver

    Returns IgxMultiColumnComboBoxComponent

Properties

_childTemplateRef: TemplateRef<any>
_dynamicContent: ViewContainerRef
_mainDiv: Element
_mainDivRef: ElementRef<any>
ngAcceptInputType_actualBaseTheme: string | BaseControlTheme
ngAcceptInputType_actualBorderWidth: string | number
ngAcceptInputType_actualContentPaddingBottom: string | number
ngAcceptInputType_actualContentPaddingLeft: string | number
ngAcceptInputType_actualContentPaddingRight: string | number
ngAcceptInputType_actualContentPaddingTop: string | number
ngAcceptInputType_actualCornerRadiusBottomLeft: string | number
ngAcceptInputType_actualCornerRadiusBottomRight: string | number
ngAcceptInputType_actualCornerRadiusTopLeft: string | number
ngAcceptInputType_actualCornerRadiusTopRight: string | number
ngAcceptInputType_actualDensity: string | ControlDisplayDensity
ngAcceptInputType_actualFocusBorderWidth: string | number
ngAcceptInputType_actualFocusUnderlineOpacity: string | number
ngAcceptInputType_actualFocusUnderlineRippleOpacity: string | number
ngAcceptInputType_actualHoverUnderlineOpacity: string | number
ngAcceptInputType_actualHoverUnderlineWidth: string | number
ngAcceptInputType_actualLabelVisible: string | boolean
ngAcceptInputType_actualUnderlineOpacity: string | number
ngAcceptInputType_actualUnderlineRippleOpacity: string | number
ngAcceptInputType_actualUnderlineRippleWidth: string | number
ngAcceptInputType_actualUnderlineWidth: string | number
ngAcceptInputType_actualValueField: string | string[]
ngAcceptInputType_allowFilter: string | boolean
ngAcceptInputType_baseTheme: string | BaseControlTheme
ngAcceptInputType_borderWidth: string | number
ngAcceptInputType_columnHeadersVisible: string | boolean
ngAcceptInputType_contentPaddingBottom: string | number
ngAcceptInputType_contentPaddingLeft: string | number
ngAcceptInputType_contentPaddingRight: string | number
ngAcceptInputType_contentPaddingTop: string | number
ngAcceptInputType_cornerRadiusBottomLeft: string | number
ngAcceptInputType_cornerRadiusBottomRight: string | number
ngAcceptInputType_cornerRadiusTopLeft: string | number
ngAcceptInputType_cornerRadiusTopRight: string | number
ngAcceptInputType_dataSourceDesiredProperties: string | string[]
ngAcceptInputType_density: string | ControlDisplayDensity
ngAcceptInputType_dropDownButtonVisible: string | boolean
ngAcceptInputType_fields: string | string[]
ngAcceptInputType_focusBorderWidth: string | number
ngAcceptInputType_focusUnderlineOpacity: string | number
ngAcceptInputType_focusUnderlineRippleOpacity: string | number
ngAcceptInputType_hoverUnderlineOpacity: string | number
ngAcceptInputType_hoverUnderlineWidth: string | number
ngAcceptInputType_rowSeparatorsVisible: string | boolean
ngAcceptInputType_showClearButton: string | boolean
ngAcceptInputType_sortMode: string | SortMode
ngAcceptInputType_underlineOpacity: string | number
ngAcceptInputType_underlineRippleOpacity: string | number
ngAcceptInputType_underlineRippleWidth: string | number
ngAcceptInputType_underlineWidth: string | number
ngAcceptInputType_valueField: string | string[]
ɵcmp: unknown
ɵfac: unknown

Accessors

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

    Returns string

  • set actualBackgroundColor(v: string): void
  • Parameters

    • v: string

    Returns void

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

    Returns BaseControlTheme

  • set actualBaseTheme(v: BaseControlTheme): void
  • Parameters

    Returns void

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

    Returns string

  • set actualBorderColor(v: string): void
  • Parameters

    • v: string

    Returns void

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

    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

  • 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 actualFocusBorderColor(): string
  • Gets the actual item border color.

    Returns string

  • set actualFocusBorderColor(v: string): void
  • Parameters

    • v: string

    Returns void

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

    Returns number

  • set actualFocusBorderWidth(v: number): 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: string): 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: number): 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: number): void
  • Parameters

    • v: number

    Returns void

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

    Returns string

  • set actualHoverUnderlineColor(v: string): 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: number): 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: number): void
  • Parameters

    • v: number

    Returns void

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

    Returns string

  • set actualLabelTextColor(v: string): void
  • Parameters

    • v: string

    Returns void

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

    Returns boolean

  • set actualLabelVisible(v: boolean): 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: string): 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: string): 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: string): void
  • Parameters

    • v: string

    Returns void

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

    Returns string

  • set actualTextColor(v: string): void
  • Parameters

    • v: string

    Returns void

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

    Returns string

  • set actualUnderlineColor(v: string): void
  • Parameters

    • v: string

    Returns void

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

    Returns number

  • set actualUnderlineOpacity(v: number): 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: string): 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: number): void
  • Parameters

    • v: number

    Returns void

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

    Returns number

  • set actualUnderlineRippleWidth(v: number): void
  • Parameters

    • v: number

    Returns void

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

    Returns number

  • set actualUnderlineWidth(v: number): 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: string[]): void
  • Parameters

    • v: string[]

    Returns void

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

    Returns boolean

  • set allowFilter(v: boolean): 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: string): 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: BaseControlTheme): void
  • Parameters

    Returns void

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

    Returns string

  • set borderColor(v: string): 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: number): void
  • Parameters

    • v: number

    Returns void

  • get change(): EventEmitter<{
        args: IgxInputChangeEventArgs;
        sender: any;
    }>
  • Returns EventEmitter<{
        args: IgxInputChangeEventArgs;
        sender: any;
    }>

  • get changing(): EventEmitter<{
        args: IgxInputChangeEventArgs;
        sender: any;
    }>
  • Returns EventEmitter<{
        args: IgxInputChangeEventArgs;
        sender: any;
    }>

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

    Returns boolean

  • set columnHeadersVisible(v: boolean): void
  • Parameters

    • v: boolean

    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

  • 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: any): 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: string[]): void
  • Parameters

    • v: string[]

    Returns void

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

    Returns IgxColumnWidth

  • set defaultColumnWidth(value: IgxColumnWidth): void
  • Parameters

    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: string[]): 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: string): 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: number): 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: string): 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: number): 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: number): void
  • Parameters

    • v: number

    Returns void

  • get gotFocus(): EventEmitter<{
        args: IgxGotFocusEventArgs;
        sender: any;
    }>
  • Returns EventEmitter<{
        args: IgxGotFocusEventArgs;
        sender: any;
    }>

  • get height(): string
  • Returns string

  • set height(value: string): 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: string): 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: number): 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: number): void
  • Parameters

    • v: number

    Returns void

  • get i(): MultiColumnComboBox
  • Returns MultiColumnComboBox

  • get keyDown(): EventEmitter<{
        args: IgxKeyEventArgs;
        sender: any;
    }>
  • Returns EventEmitter<{
        args: IgxKeyEventArgs;
        sender: any;
    }>

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

    Returns string

  • set label(v: string): void
  • Parameters

    • v: string

    Returns void

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

    Returns string

  • set labelTextColor(v: string): void
  • Parameters

    • v: string

    Returns void

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

    Returns string

  • set labelTextStyle(v: string): void
  • Parameters

    • v: string

    Returns void

  • get lostFocus(): EventEmitter<{
        args: IgxLostFocusEventArgs;
        sender: any;
    }>
  • Returns EventEmitter<{
        args: IgxLostFocusEventArgs;
        sender: any;
    }>

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

    Returns string

  • set noMatchesFoundLabel(v: string): 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: string): 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: string): void
  • Parameters

    • v: string

    Returns void

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

    Returns string

  • set noMatchesFoundLabelTextStyle(v: string): 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: string): 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: boolean): 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: boolean): 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: SortMode): void
  • Parameters

    Returns void

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

    Returns string

  • set text(v: string): void
  • Parameters

    • v: string

    Returns void

  • get textChange(): EventEmitter<string>
  • Returns EventEmitter<string>

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

    Returns string

  • set textColor(v: string): 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: string): void
  • Parameters

    • v: string

    Returns void

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

    Returns string

  • set textStyle(v: string): 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: string): 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: number): 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: string): 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: number): 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: number): 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: number): 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: any): void
  • Parameters

    • v: any

    Returns void

  • get valueChange(): EventEmitter<any>
  • Returns EventEmitter<any>

  • 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: string[]): void
  • Parameters

    • v: string[]

    Returns void

  • get width(): string
  • Returns string

  • set width(value: string): void
  • Parameters

    • value: string

    Returns void

Methods

  • Programmatically closes the list.

    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

  • Returns void

  • Returns void

  • Returns void

  • Selects all the text in the combo input area.

    Returns void

  • Returns void