Ignite UI for React

All
  • Public
  • Public/Protected
  • All

Class IgrColumnExportingEventArgsDetail

columnExporting event arguments

this.exporterService.columnExporting.subscribe((args: IColumnExportingEventArgs) => {
// set args properties here
});

Hierarchy

Hierarchy

Constructors

Accessors

Methods

Constructors

constructor

Accessors

cancel

  • get cancel(): boolean

  • Skip the exporting column when set to true

    Returns boolean

  • set cancel(v): void

  • Parameters

    • v: boolean

    Returns void

columnIndex

  • get columnIndex(): number

  • Contains the exporting column index

    Returns number

  • set columnIndex(v): void

  • Parameters

    • v: number

    Returns void

field

  • get field(): string

  • Contains the exporting column field name

    Returns string

  • set field(v): void

  • Parameters

    • v: string

    Returns void

grid

header

  • get header(): string

  • Contains the exporting column header

    Returns string

  • set header(v): void

  • Parameters

    • v: string

    Returns void

nativeElement

  • get nativeElement(): HTMLElement

  • Returns HTMLElement

owner

  • get owner(): any

  • Provides reference to the owner component.

    Returns any

  • set owner(v): void

  • Parameters

    • v: any

    Returns void

skipFormatter

  • get skipFormatter(): boolean

  • Export the column's data without applying its formatter, when set to true

    Returns boolean

  • set skipFormatter(v): void

  • Parameters

    • v: boolean

    Returns void

Methods

findByName

  • Parameters

    • name: string

    Returns any

setNativeElement

  • Parameters

    • element: any

    Returns void