Show / Hide Table of Contents

Class IgbGridToolbarExporter

Provides a pre-configured exporter component for the grid. @remarks This component still needs the actual exporter service(s) provided in the DI chain in order to export something. @igxModule IgxGridToolbarModule @igxParent IgxGridToolbarComponent, IgxGridToolbarActionsComponent

Inheritance
System.Object
BaseRendererElement
IgbGridToolbarBaseAction
IgbBaseToolbarDirective
IgbGridToolbarExporter
Implements
JsonSerializable
System.IDisposable
Inherited Members
IgbBaseToolbarDirective.SetNativeElementAsync(Object)
IgbBaseToolbarDirective.SetNativeElement(Object)
IgbBaseToolbarDirective.ColumnListHeight
IgbBaseToolbarDirective.Title
IgbBaseToolbarDirective.Prompt
IgbBaseToolbarDirective.OverlaySettings
IgbBaseToolbarDirective.OpeningScript
IgbBaseToolbarDirective.Opening
IgbBaseToolbarDirective.OpenedScript
IgbBaseToolbarDirective.Opened
IgbBaseToolbarDirective.ClosingScript
IgbBaseToolbarDirective.Closing
IgbBaseToolbarDirective.ClosedScript
IgbBaseToolbarDirective.Closed
IgbBaseToolbarDirective.ColumnToggleScript
IgbBaseToolbarDirective.ColumnToggle
IgbGridToolbarBaseAction.Dispose()
IgbGridToolbarBaseAction.OnInitializedAsync()
IgbGridToolbarBaseAction.GridToolbarActionsParent
BaseRendererElement._name
BaseRendererElement.eventCallbacksCache
BaseRendererElement._cachedSerializedContent
BaseRendererElement.BuildRenderTree(RenderTreeBuilder)
BaseRendererElement.OnElementNameChanged(BaseRendererElement, String, String)
BaseRendererElement.InvokeMethod(String, Object[], String[], ElementReference[])
BaseRendererElement.InvokeMethodSync(String, Object[], String[], ElementReference[])
BaseRendererElement.InvokeMethodHelper(String, String, Object[], String[], ElementReference[])
BaseRendererElement.InvokeMethodHelperSync(String, String, Object[], String[], ElementReference[])
BaseRendererElement.IsPropDirty(String)
BaseRendererElement.Serialize(SerializationContext, String)
BaseRendererElement.Serialize()
BaseRendererElement.EnsureValid()
BaseRendererElement.FromEventJson(BaseRendererControl, Dictionary<String, Object>)
BaseRendererElement.ToEventJson(BaseRendererControl, Dictionary<String, Object>)
BaseRendererElement.SetResourceStringAsync(String, String, String)
BaseRendererElement.SetResourceStringAsync(String, String)
BaseRendererElement.CompareEventCallbacks<T>(T, T, Dictionary<Type, Dictionary<String, FieldInfo>>)
BaseRendererElement.IgBlazor
BaseRendererElement.IsComponentRooted
BaseRendererElement.UseDirectRender
BaseRendererElement.ChildContent
BaseRendererElement.Name
BaseRendererElement.Parent
BaseRendererElement.MethodTarget
BaseRendererElement.CurrParent
Namespace: IgniteUI.Blazor.Controls
Assembly: IgniteUI.Blazor.dll
Syntax
public class IgbGridToolbarExporter : IgbBaseToolbarDirective, JsonSerializable, IDisposable

Constructors

IgbGridToolbarExporter()

Declaration
public IgbGridToolbarExporter()

Properties

ExportCSV

Show entry for CSV export.

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

ExportEnded

Declaration
public EventCallback<IgbVoidEventArgs> ExportEnded { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<IgbVoidEventArgs>

ExportEndedScript

Declaration
public string ExportEndedScript { get; set; }
Property Value
Type Description
System.String

ExportExcel

Show entry for Excel export.

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

ExportPDF

Show entry for PDF export.

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

ExportStarted

Declaration
public EventCallback<IgbExporterEventArgs> ExportStarted { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<IgbExporterEventArgs>

ExportStartedScript

Declaration
public string ExportStartedScript { get; set; }
Property Value
Type Description
System.String

Filename

The name for the exported file.

Declaration
public string Filename { get; set; }
Property Value
Type Description
System.String

ParentTypeName

Declaration
protected override string ParentTypeName { get; }
Property Value
Type Description
System.String
Overrides
BaseRendererElement.ParentTypeName

SupportsVisualChildren

Declaration
protected override bool SupportsVisualChildren { get; }
Property Value
Type Description
System.Boolean
Overrides
BaseRendererElement.SupportsVisualChildren

Type

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

Methods

EnsureModulesLoaded()

Declaration
protected override void EnsureModulesLoaded()
Overrides
BaseRendererElement.EnsureModulesLoaded()

ExportGrid(GridToolbarExporterType)

Declaration
[WCWidgetMemberName("Export")]
public void ExportGrid(GridToolbarExporterType type)
Parameters
Type Name Description
GridToolbarExporterType type

ExportGridAsync(GridToolbarExporterType)

Export the grid's data type File type to export

Declaration
[WCWidgetMemberName("Export")]
public Task ExportGridAsync(GridToolbarExporterType type)
Parameters
Type Name Description
GridToolbarExporterType type

File type to export

Returns
Type Description
System.Threading.Tasks.Task

FindByName(String)

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

Implements

JsonSerializable
System.IDisposable