Class SplitterSaveOptions

public class SplitterSaveOptions : SaveOptions  

Inheritance

object ←
SaveOptions ←
SplitterSaveOptions

Inherited Members

• SaveOptions.OutputFile,
• SaveOptions.OutputStream,
• object.ToString(),
• object.Equals(object),
• object.Equals(object, object),
• object.ReferenceEquals(object, object),
• object.GetHashCode(),
• object.GetType(),
• object.MemberwiseClone()

Constructors

SplitterSaveOptions()

public SplitterSaveOptions()  

Properties

SaveFormat

Gets and sets the format of spreadsheet.

public FileFormatType SaveFormat { get; set; }  

Property Value

FileFormatType

Methods

Finish(Stream)

Finish writing data to the stream.

By default this method just closes the stream directly(including the situation that
the stream is the one specified by Sheetize.SaveOptions.OutputStream).

User may overwrite this method to control how to release resources
according to their requirement and the implementation of Sheetize.SplitterSaveOptions.GetStream(System.Int32).

public virtual void Finish(Stream stream)  

Parameters

• stream Stream: the stream that has finished its task(saving data to)

GetStream(int)

Gets stream to save the split part.

public virtual Stream GetStream(int sn)  

Parameters

• sn int: the sequence number of the split part, 0 based.

Returns

Stream : Stream for writing split part to.

Remarks

By default, if Sheetize.SaveOptions.OutputStream has been specified and takes effect,
then this method returns the specified Stream always. User should overwrite this method in his own implementation
of this class to provide different and proper Stream objects for multi-parts output.

If Sheetize.SaveOptions.OutputFile has been specified and takes effect,
then the sequence number will be appended to the file name and then return the FileStream build from the file.
For example, if output path is specified as res.xlsx, then the generated files will be res0.xlsx, res1.xlsx,…