Class IgbExporterOptionsBase

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

Constructors

IgbExporterOptionsBase()

Declaration
public IgbExporterOptionsBase()

Properties

AlwaysExportHeaders

Specifies whether the headers should be exported if there is no data.

let alwaysExportHeaders = this.exportOptions.alwaysExportHeaders;
this.exportOptions.alwaysExportHeaders = false;

@memberof IgxExporterOptionsBase

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

ExportSummaries

Specifies whether the exported data should include column summaries.

let exportSummaries = this.exportOptions.exportSummaries;
this.exportOptions.exportSummaries = true;

@memberof IgxExporterOptionsBase

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

FileName

Gets the file name which will be used for the exporting operation.

let fileName = this.exportOptions.fileName;

@memberof IgxExporterOptionsBase

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

FreezeHeaders

Specifies whether the exported data should have frozen headers.

let freezeHeaders = this.exportOptions.freezeHeaders;
this.exportOptions.freezeHeaders = true;

@memberof IgxExporterOptionsBase

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

IgnoreColumnsOrder

Specifies if the exporter should ignore the current column order in the IgxGrid.

let ignoreColumnsOrder = this.exportOptions.ignoreColumnsOrder;
this.exportOptions.ignoreColumnsOrder = true;

@memberof IgxExporterOptionsBase

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

IgnoreColumnsVisibility

Specifies whether hidden columns should be exported.

let ignoreColumnsVisibility = this.exportOptions.ignoreColumnsVisibility;
this.exportOptions.ignoreColumnsVisibility = true;

@memberof IgxExporterOptionsBase

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

IgnoreFiltering

Specifies whether filtered out rows should be exported.

let ignoreFiltering = this.exportOptions.ignoreFiltering;
this.exportOptions.ignoreFiltering = true;

@memberof IgxExporterOptionsBase

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

IgnoreGrouping

Specifies whether the exported data should be grouped as in the provided IgxGrid.

let ignoreGrouping = this.exportOptions.ignoreGrouping;
this.exportOptions.ignoreGrouping = true;

@memberof IgxExporterOptionsBase

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

IgnoreMultiColumnHeaders

Specifies whether the exported data should include multi column headers as in the provided IgxGrid.

let ignoreMultiColumnHeaders = this.exportOptions.ignoreMultiColumnHeaders;
this.exportOptions.ignoreMultiColumnHeaders = true;

@memberof IgxExporterOptionsBase

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

IgnoreSorting

Specifies whether the exported data should be sorted as in the provided IgxGrid. When you export grouped data, setting ignoreSorting to true will cause the grouping to fail because it relies on the sorting of the records.

let ignoreSorting = this.exportOptions.ignoreSorting;
this.exportOptions.ignoreSorting = true;

@memberof IgxExporterOptionsBase

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

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

SetNativeElement(Object)

Declaration
public void SetNativeElement(object element)
Parameters
Type Name Description
System.Object element

SetNativeElementAsync(Object)

Declaration
public Task SetNativeElementAsync(object element)
Parameters
Type Name Description
System.Object element
Returns
Type Description
System.Threading.Tasks.Task

Implements