Interface IExcelWriter

Namespace: Casewhere.Runtime.IO
Assembly: Casewhere.Runtime.IO.dll

Provide methods for write data to an excel file.

var filter = FilterBuilder.Create().Build();
var schools = dataApi.Search(DataObjectApiQuery.For("School").FilterBy(filter)).Data;
using(var stream = new MemoryStream())
{
using (var writer = Writers.GetExcelWriter())
{
writer.Open(stream);
var sheetWriter = writer.AddSheet("Sheet1");
var row = 0;
foreach(dynamic school in schools) {

sheetWriter.Write(row, 0, school.Name);
sheetWriter.Write(row, 1, school.Description);
row ++;
}

}

         // Note: MUST move the cursor to the beginning of the stream before storing.
         stream.Seek(0, SeekOrigin.Begin);
         var documentInfo = documentApi.Create("Sample.xlsx");
         documentApi.Store(documentInfo, stream);
     }</code></pre></example>

public interface IExcelWriter : IDisposable, IIOApi

Implements

IDisposable, IIOApi

Extension Methods

ObjectExtension.ConvertToBsonValue(object), EnumExtensions.DeepClone<IExcelWriter>(IExcelWriter)

Methods

AddSheet(string)

Create a sheet with the given name.

IExcelSheetWriter AddSheet(string name)

Parameters

name string

The sheet name

Returns

IExcelSheetWriter

An excel sheet writer

Close()

Close the connection to an excel file.

void Close()

GetSheet(int)

Get a sheet with its index.

IExcelSheetWriter GetSheet(int index)

Parameters

index int

The sheet index.

Returns

IExcelSheetWriter

An excel sheet writer.

Open(Stream)

Connect to the stream of an excel file to prepare for writing

void Open(Stream stream)

Parameters

stream Stream

Open(FileInfo)

Connect to an excel file to prepare for writing.

void Open(FileInfo fileInfo)

Parameters

fileInfo FileInfo