Class IgbGridToolbarExportEventArgsDetail

Represents the arguments for the grid toolbar export event. It provides information about the grid instance, exporter service, export options, and allows the event to be canceled.

Inheritance
System.Object
BaseRendererElement
IgbBaseEventArgsDetail
IgbGridToolbarExportEventArgsDetail
Implements
Inherited Members
Namespace: IgniteUI.Blazor.Controls
Assembly: IgniteUI.Blazor.dll
Syntax
public class IgbGridToolbarExportEventArgsDetail : IgbBaseEventArgsDetail, JsonSerializable

Constructors

IgbGridToolbarExportEventArgsDetail()

Declaration
public IgbGridToolbarExportEventArgsDetail()

Properties

Cancel

cancel returns whether the event has been intercepted and stopped If the value becomes "true", it returns/exits from the method, instantiating the interface

Declaration
public bool Cancel { get; set; }
Property Value
Type Description
System.Boolean

Exporter

The exporter is a base service. The type (an abstract class IgxBaseExporter) has it's own properties and methods It is used to define the format and options of the export, the exported element and methods for preparing the data from the elements for exporting

Declaration
public IgbBaseExporter Exporter { get; set; }
Property Value
Type Description
IgbBaseExporter

Grid

grid represents a reference to the instance of the grid te event originated from

Declaration
public IgbGridBaseDirective Grid { get; set; }
Property Value
Type Description
IgbGridBaseDirective

Options

Represents the different settings, that can be given to an export The type (an abstract class IgxExporterOptionsBase) has properties for column settings (whether they should be ignored) as well as method for generating a file name

Declaration
public IgbExporterOptionsBase Options { get; set; }
Property Value
Type Description
IgbExporterOptionsBase

Type

Declaration
public override string Type { get; }
Property Value
Type Description
System.String
Overrides

Methods

FindByName(String)

Declaration
public override object FindByName(string name)
Parameters
Type Name Description
System.String name
Returns
Type Description
System.Object
Overrides

FromEventJson(BaseRendererControl, Dictionary<String, Object>)

Declaration
protected override void FromEventJson(BaseRendererControl control, Dictionary<string, object> args)
Parameters
Type Name Description
BaseRendererControl control
System.Collections.Generic.Dictionary<System.String, System.Object> args
Overrides

ToEventJson(BaseRendererControl, Dictionary<String, Object>)

Declaration
protected override void ToEventJson(BaseRendererControl control, Dictionary<string, object> args)
Parameters
Type Name Description
BaseRendererControl control
System.Collections.Generic.Dictionary<System.String, System.Object> args
Overrides

Implements