Provides a pre-configured exporter component for the grid.
Inheritance
object
Implements
- IComponent
- IHandleEvent
- IHandleAfterRender
- JsonSerializable
- IDisposable
Constructors
Section titled "Constructors"constructor
public IgbGridToolbarExporter()Returns IgbGridToolbarExporter
Properties
Section titled "Properties"ColumnListHeight
Section titled "ColumnListHeight"Inherited from: IgbBaseToolbarDirective
Sets the height of the column list in the dropdown.
[Parameter]
public string ColumnListHeight { get; set; }Title
Section titled "Title"Inherited from: IgbBaseToolbarDirective
Title text for the column action component
[Parameter]
public string Title { get; set; }Prompt
Section titled "Prompt"Inherited from: IgbBaseToolbarDirective
The placeholder text for the search input.
[Parameter]
public string Prompt { get; set; }OverlaySettings
Section titled "OverlaySettings"Inherited from: IgbBaseToolbarDirective
Sets overlay settings
[Parameter]
public IgbOverlaySettings OverlaySettings { get; set; }GridToolbarActionsParent
Section titled "GridToolbarActionsParent"Inherited from: IgbGridToolbarBaseAction
[CascadingParameter(Name = "GridToolbarActionsParent")]
protected BaseRendererElement GridToolbarActionsParent { get; set; }IgBlazor
Section titled "IgBlazor"Inherited from: BaseRendererElement
[Inject]
protected IIgniteUIBlazor IgBlazor { get; set; }IsComponentRooted
Section titled "IsComponentRooted"Inherited from: BaseRendererElement
public bool IsComponentRooted { get; }UseDirectRender
Section titled "UseDirectRender"Inherited from: BaseRendererElement
protected virtual bool UseDirectRender { get; }ChildContent
Section titled "ChildContent"Inherited from: BaseRendererElement
[Parameter]
public RenderFragment ChildContent { get; set; }MethodTarget
Section titled "MethodTarget"Inherited from: BaseRendererElement
protected virtual string MethodTarget { get; }CurrParent
Section titled "CurrParent"Inherited from: BaseRendererElement
protected object CurrParent { get; }ExportCSV
Section titled "ExportCSV"Show entry for CSV export.
[Parameter]
public bool ExportCSV { get; set; }ExportExcel
Section titled "ExportExcel"Show entry for Excel export.
[Parameter]
public bool ExportExcel { get; set; }ExportPDF
Section titled "ExportPDF"Show entry for PDF export.
[Parameter]
public bool ExportPDF { get; set; }Filename
Section titled "Filename"The name for the exported file.
[Parameter]
public string Filename { get; set; }SupportsVisualChildren
Section titled "SupportsVisualChildren"protected override bool SupportsVisualChildren { get; }Accessors
Section titled "Accessors"_name
Section titled "_name"Inherited from: BaseRendererElement
protected string _nameeventCallbacksCache
Section titled "eventCallbacksCache"Inherited from: BaseRendererElement
protected Dictionary<Type, Dictionary<string, FieldInfo>> eventCallbacksCache_cachedSerializedContent
Section titled "_cachedSerializedContent"Inherited from: BaseRendererElement
protected string _cachedSerializedContentMethods
Section titled "Methods"SetNativeElementAsync(object)
Section titled "SetNativeElementAsync(object)"Inherited from: IgbBaseToolbarDirective
public Task SetNativeElementAsync(object element)Parameters
- element:
object
Returns any
SetNativeElement(object)
Section titled "SetNativeElement(object)"Inherited from: IgbBaseToolbarDirective
public void SetNativeElement(object element)Parameters
- element:
object
Returns any
Dispose()
Section titled "Dispose()"Inherited from: IgbGridToolbarBaseAction
public void Dispose()Returns any
OnInitializedAsync()
Section titled "OnInitializedAsync()"Inherited from: IgbGridToolbarBaseAction
protected override Task OnInitializedAsync()Returns any
BuildRenderTree(RenderTreeBuilder)
Section titled "BuildRenderTree(RenderTreeBuilder)"Inherited from: BaseRendererElement
protected override void BuildRenderTree(RenderTreeBuilder builder)Parameters
- builder:
RenderTreeBuilder
Returns any
OnElementNameChanged(BaseRendererElement, string, string)
Section titled "OnElementNameChanged(BaseRendererElement, string, string)"Inherited from: BaseRendererElement
protected void OnElementNameChanged(BaseRendererElement element, string oldName, string newName)Parameters
- element:
BaseRendererElement - oldName:
string - newName:
string
Returns any
InvokeMethod(string, object[], string[], ElementReference[])
Section titled "InvokeMethod(string, object[], string[], ElementReference[])"Inherited from: BaseRendererElement
protected Task<object> InvokeMethod(string methodName, object[] arguments, string[] types, ElementReference[] nativeElements = null)Parameters
- methodName:
string - arguments:
object[] - types:
string[] - nativeElements:
ElementReference[]
Returns any
InvokeMethodSync(string, object[], string[], ElementReference[])
Section titled "InvokeMethodSync(string, object[], string[], ElementReference[])"Inherited from: BaseRendererElement
protected object InvokeMethodSync(string methodName, object[] arguments, string[] types, ElementReference[] nativeElements = null)Parameters
- methodName:
string - arguments:
object[] - types:
string[] - nativeElements:
ElementReference[]
Returns any
InvokeMethodHelper(string, string, object[], string[], ElementReference[])
Section titled "InvokeMethodHelper(string, string, object[], string[], ElementReference[])"Inherited from: BaseRendererElement
protected Task<object> InvokeMethodHelper(string target, string methodName, object[] arguments, string[] types, ElementReference[] nativeElements)Parameters
- target:
string - methodName:
string - arguments:
object[] - types:
string[] - nativeElements:
ElementReference[]
Returns any
InvokeMethodHelperSync(string, string, object[], string[], ElementReference[])
Section titled "InvokeMethodHelperSync(string, string, object[], string[], ElementReference[])"Inherited from: BaseRendererElement
protected object InvokeMethodHelperSync(string target, string methodName, object[] arguments, string[] types, ElementReference[] nativeElements)Parameters
- target:
string - methodName:
string - arguments:
object[] - types:
string[] - nativeElements:
ElementReference[]
Returns any
IsPropDirty(string)
Section titled "IsPropDirty(string)"Inherited from: BaseRendererElement
protected bool IsPropDirty(string propertyName)Parameters
- propertyName:
string
Returns any
Serialize(SerializationContext, string)
Section titled "Serialize(SerializationContext, string)"Inherited from: BaseRendererElement
public void Serialize(SerializationContext context, string propertyName = null)Parameters
- context:
SerializationContext - propertyName:
string
Returns any
Serialize()
Section titled "Serialize()"Inherited from: BaseRendererElement
public string Serialize()Returns any
EnsureValid()
Section titled "EnsureValid()"Inherited from: BaseRendererElement
protected void EnsureValid()Returns any
FromEventJson(BaseRendererControl, Dictionary<string, object>)
Section titled "FromEventJson(BaseRendererControl, Dictionary<string, object>)"Inherited from: BaseRendererElement
protected virtual void FromEventJson(BaseRendererControl control, Dictionary<string, object> args)Parameters
- control:
BaseRendererControl - args:
Dictionary
Returns any
ToEventJson(BaseRendererControl, Dictionary<string, object>)
Section titled "ToEventJson(BaseRendererControl, Dictionary<string, object>)"Inherited from: BaseRendererElement
protected virtual void ToEventJson(BaseRendererControl control, Dictionary<string, object> args)Parameters
- control:
BaseRendererControl - args:
Dictionary
Returns any
SetResourceStringAsync(string, string, string)
Section titled "SetResourceStringAsync(string, string, string)"Inherited from: BaseRendererElement
protected Task<object> SetResourceStringAsync(string grouping, string id, string value)Parameters
- grouping:
string - id:
string - value:
string
Returns any
SetResourceStringAsync(string, string)
Section titled "SetResourceStringAsync(string, string)"Inherited from: BaseRendererElement
protected Task<object> SetResourceStringAsync(string grouping, string json)Parameters
- grouping:
string - json:
string
Returns any
EnsureModulesLoaded()
Section titled "EnsureModulesLoaded()"protected override void EnsureModulesLoaded()Returns any
ExportGrid(GridToolbarExporterType)
Section titled "ExportGrid(GridToolbarExporterType)"[WCWidgetMemberName("Export")]
public void ExportGrid(GridToolbarExporterType type)Parameters
- type:
GridToolbarExporterType
Returns any
ExportGridAsync(GridToolbarExporterType)
Section titled "ExportGridAsync(GridToolbarExporterType)"Export the grid's data type File type to export
[WCWidgetMemberName("Export")]
public Task ExportGridAsync(GridToolbarExporterType type)Parameters
- type:
GridToolbarExporterType
Returns any
FindByName(string)
Section titled "FindByName(string)"public override object FindByName(string name)Parameters
- name:
string
Returns any
Events
Section titled "Events"Opening
Section titled "Opening"[Parameter]
public EventCallback<IgbToggleViewCancelableEventArgs> Opening { get; set; }Opened
Section titled "Opened"[Parameter]
public EventCallback<IgbToggleViewEventArgs> Opened { get; set; }Closing
Section titled "Closing"[Parameter]
public EventCallback<IgbToggleViewEventArgs> Closing { get; set; }Closed
Section titled "Closed"[Parameter]
public EventCallback<IgbToggleViewEventArgs> Closed { get; set; }ColumnToggle
Section titled "ColumnToggle"[Parameter]
public EventCallback<IgbColumnToggledEventArgs> ColumnToggle { get; set; }ExportEnded
Section titled "ExportEnded"[Parameter]
public EventCallback<IgbVoidEventArgs> ExportEnded { get; set; }ExportStarted
Section titled "ExportStarted"[Parameter]
public EventCallback<IgbExporterEventArgs> ExportStarted { get; set; }OpeningScript
Section titled "OpeningScript"[Parameter]
public string OpeningScript { get; set; }OpenedScript
Section titled "OpenedScript"[Parameter]
public string OpenedScript { get; set; }ClosingScript
Section titled "ClosingScript"[Parameter]
public string ClosingScript { get; set; }ClosedScript
Section titled "ClosedScript"[Parameter]
public string ClosedScript { get; set; }ColumnToggleScript
Section titled "ColumnToggleScript"[Parameter]
public string ColumnToggleScript { get; set; }ExportEndedScript
Section titled "ExportEndedScript"[Parameter]
public string ExportEndedScript { get; set; }ExportStartedScript
Section titled "ExportStartedScript"[Parameter]
public string ExportStartedScript { get; set; }