ExportOptions

Definition

Namespace: Surya.Ab.Export.Client.Models
Assembly: Surya.Ab.Export.dll

Provides the optional properties needed for Export of Datasets

public class ExportOptions

Properties

Name	Definition
SpreadsheetOptions	Provides optional parameters for each sheet in Excel such as SheetName, SheetHeader, SheetFooter, SheetStyle and common style properties for all datasets in that sheet
PdfOptions	Provides optional parameters for export in Pdf such as Header and Footer, PdfStyle, common style properties for all datasets
DisplayDataFormat	To pass custom format for any DisplayType
Delimiter	To set delimiter in CSV Export

Structure

public class ExportOptions
{
    public List<SpreadsheetOption>? SpreadsheetOptions { get; set; }
    public PdfOptions? PdfOptions { get; set; }
    public Dictionary<DisplayType, string>? DisplayDataFormat { get; set; }
    public string? Delimiter { get; set; }
}

Example

var exportOption = new ExportOptions()
{
    // options for Pdf
    PdfOptions = new PdfOptions()
    {
        Header = "DocumentHeader",
        Footer = "DocumentFooter",
    }

    // options for Excel
    SpreadsheetOptions = new List<SpreadsheetOption>()
    {
        new SpreadsheetOption()
        {
            SheetName = "Sheet 1",
            Header = "SheetHeader",
            Footer = "SheetFooter",
        }
    }
};

---

Edit on GitHub