Sheetize Namespace

Namespace: Sheetize Assembly: Sheetize.dll

Class HtmlConverter

Info

Converter for conversion between html files(html, mht, …) and other spreadsheet file formats.

public class HtmlConverter

Inheritance

object ← HtmlConverter

Inherited Members

Examples

[C#]
LoadOptions loadOptions = new LoadOptions();
loadOptions.InputFile = "Template.xlsx";
HtmlSaveOptions saveOptions = new HtmlSaveOptions();
saveOptions.OutputFile = "res.html";
HtmlConverter.Process(loadOptions, saveOptions);

Methods

Process(LoadOptions, SaveOptions)

Converts file between html and other spreadsheet file formats.

public static void Process(LoadOptions loadOptions, SaveOptions saveOptions)

Parameters

loadOptions LoadOptions: Options for input and loading:
saveOptions SaveOptions: Options for output and saving

Namespace: Sheetize Assembly: Sheetize.dll

Class HtmlSaveOptions

Info

Options for saving html.

public class HtmlSaveOptions : SaveOptions

Inheritance

object ← SaveOptions ← HtmlSaveOptions

Inherited Members

Constructors

HtmlSaveOptions()

public HtmlSaveOptions()

Properties

SaveFormat

Gets and sets the format of spreadsheet.

public FileFormatType SaveFormat { get; set; }

Property Value

Namespace: Sheetize Assembly: Sheetize.dll

Class ImageConverter

Info

Converter for converting template file to pdf.

public class ImageConverter

Inheritance

object ← ImageConverter

Inherited Members

Examples

[C#]
LoadOptions loadOptions = new LoadOptions();
loadOptions.InputFile = "Template.xlsx";
ImageSaveOptions saveOptions = new ImageSaveOptions();
ImageConverter.Process(loadOptions, saveOptions);

Methods

Process(LoadOptions, ImageSaveOptions)

Converts template file to images

public static void Process(LoadOptions loadOptions, ImageSaveOptions saveOptions)

Parameters

loadOptions LoadOptions: Options for input and loading:
saveOptions ImageSaveOptions: Options for output and saving

Remarks

When converting to image of format that supports multiple pages(such as tiff), the specified Sheetize.SaveOptions.OutputFile or Sheetize.SaveOptions.OutputStream will be used directly for the resultant image.
For other types of image, if the save options has specified Stream as output, then all resultant images will be saved to the same Stream. Otherwise, the output files will be build from the specified output file of the save options by appending sequence number of the sheet and split part. For example, if the specified output file is Image.png, then the generated image files will be Image_0_0.png, Image_0_1.png, …, Image_1_0.png, …

Process(LoadOptions, ImageSaveOptions, AbstractSaveOptionsProvider)

Converts template file to images

public static void Process(LoadOptions loadOptions, ImageSaveOptions saveOptions, AbstractSaveOptionsProvider provider)

Parameters

loadOptions LoadOptions: Options for input and loading:
saveOptions ImageSaveOptions: Options for saving. Its output(Sheetize.SaveOptions.OutputFile or Sheetize.SaveOptions.OutputStream): takes no effect because all outputs will be specified by the “provider” parameter:
provider AbstractSaveOptionsProvider: Provider of save options for saving the generated images

Namespace: Sheetize Assembly: Sheetize.dll

Class ImageSaveOptions

Info

Options for saving image.

public class ImageSaveOptions : SaveOptions

Inheritance

object ← SaveOptions ← ImageSaveOptions

Inherited Members

Constructors

ImageSaveOptions()

public ImageSaveOptions()

Properties

HorizontalResolution

Gets or sets the horizontal resolution for generated images, in dots per inch.

public int HorizontalResolution { get; set; }

Property Value

Remarks

The default value is 96.

Setting Sheetize.ImageSaveOptions.HorizontalResolution and Sheetize.ImageSaveOptions.VerticalResolution effects the width and height of the output image in pixels.

ImageType

Gets or sets the format of the generated images. Default value is Sheetize.ImageType.Png.

public ImageType ImageType { get; set; }

Property Value

ImageType

OnePagePerSheet

If OnePagePerSheet is true, all content of one sheet will output to only one page in result. The paper size defined by PageSetup will be ignored, but other settings of PageSetup still takes effect.

public bool OnePagePerSheet { get; set; }

Property Value

VerticalResolution

Gets or sets the vertical resolution for generated images, in dots per inch.

public int VerticalResolution { get; set; }

Property Value

Remarks

The default value is 96.

Setting Sheetize.ImageSaveOptions.HorizontalResolution and Sheetize.ImageSaveOptions.VerticalResolution effects the width and height of the output image in pixels.

Namespace: Sheetize Assembly: Sheetize.dll

Class JsonConverter

Info

Converter for conversion between json data and other spreadsheet file formats.

public class JsonConverter

Inheritance

object ← JsonConverter

Inherited Members

Examples

[C#]
LoadOptions loadOptions = new LoadOptions();
loadOptions.InputFile = "data.json";
SaveOptions saveOptions = new SaveOptions();
saveOptions.OutputFile = "res.xlsx";
JsonConverter.Process(loadOptions, saveOptions);

Methods

Process(LoadOptions, SaveOptions)

Converts between json data and other spreadsheet file formats.

public static void Process(LoadOptions loadOptions, SaveOptions saveOptions)

Parameters

loadOptions LoadOptions: Options for input and loading:
saveOptions SaveOptions: Options for output and saving

Namespace: Sheetize Assembly: Sheetize.dll

Class JsonSaveOptions

Info

Options for saving json.

public class JsonSaveOptions : SaveOptions

Inheritance

object ← SaveOptions ← JsonSaveOptions

Inherited Members

Constructors

JsonSaveOptions()

public JsonSaveOptions()

Namespace: Sheetize Assembly: Sheetize.dll

Class License

Info

Licenses the product.

public class License

Inheritance

object ← License

Inherited Members

Examples

[C#]
Sheetize.License license = new Sheetize.License();
license.SetLicense("mylic.lic");

Constructors

License()

public License()

Methods

SetLicense(Stream)

Licenses the product by the Stream which provides license data.

public void SetLicense(Stream stream)

Parameters

stream Stream

SetLicense(string)

Licenses the product by the license file.

public void SetLicense(string licenseName)

Parameters

licenseName string

Namespace: Sheetize Assembly: Sheetize.dll

Class LoadOptions

Info

Options for loading template file.

public class LoadOptions

Inheritance

object ← LoadOptions

Derived

UnlockerLoadOptions

Inherited Members

Constructors

LoadOptions()

public LoadOptions()

Properties

InputFile

Gets and sets the file(with path if needed) of the template.

public string InputFile { get; set; }

Property Value

Remarks

When setting a non-null and non-empty path to this property, the previously set value for Sheetize.LoadOptions.InputStream will be ignored.

InputStream

Gets and sets the Stream of the template.

public Stream InputStream { get; set; }

Property Value

Stream

Remarks

When setting a non-null Stream to this property, the previously set value for Sheetize.LoadOptions.InputFile will be ignored.

Namespace: Sheetize Assembly: Sheetize.dll

Class LockerSaveOptions

Info

Options to lock excel files.

public class LockerSaveOptions : SaveOptions

Inheritance

object ← SaveOptions ← LockerSaveOptions

Inherited Members

Constructors

LockerSaveOptions()

public LockerSaveOptions()

Properties

Password

Password to open the file.

public string Password { get; set; }

Property Value

PasswordOfWriteProtection

Password to modify the file.

public string PasswordOfWriteProtection { get; set; }

Property Value

SettingsOfWorkbookProtection

Protection settings to protect the workbook.

public ProtectionSettings SettingsOfWorkbookProtection { get; set; }

Property Value

ProtectionSettings

SettingsOfWorksheetProtection

The default protection settings used to protect the worksheet.

public ProtectionSettings SettingsOfWorksheetProtection { get; set; }

Property Value

ProtectionSettings

Methods

GetPasswordOfWorksheetProtection(SplitPartInfo)

Gets the protection settings to protect one worksheet.

public virtual ProtectionSettings GetPasswordOfWorksheetProtection(SplitPartInfo info)

Parameters

info SplitPartInfo: Infomation about current sheet which needs to be protected.

Returns

ProtectionSettings : the protection settings to protect current sheet. By default this method returns the settings specified by Sheetize.LockerSaveOptions.SettingsOfWorksheetProtection. If it is null, current sheet will not be protected.

Namespace: Sheetize Assembly: Sheetize.dll

Class PdfConverter

Info

Converter for converting template file to pdf.

public class PdfConverter

Inheritance

object ← PdfConverter

Inherited Members

Examples

[C#]
LoadOptions loadOptions = new LoadOptions();
loadOptions.InputFile = "Template.xlsx";
PdfSaveOptions saveOptions = new PdfSaveOptions();
saveOptions.OutputFile = "res.pdf";
PdfConverter.Process(loadOptions, saveOptions);

Methods

Process(LoadOptions, PdfSaveOptions)

Converts template file to pdf

public static void Process(LoadOptions loadOptions, PdfSaveOptions saveOptions)

Parameters

loadOptions LoadOptions: Options for input and loading:
saveOptions PdfSaveOptions: Options for output and saving

Namespace: Sheetize Assembly: Sheetize.dll

Class PdfSaveOptions

Info

Options for saving pdf.

public class PdfSaveOptions : SaveOptions

Inheritance

object ← SaveOptions ← PdfSaveOptions

Inherited Members

Constructors

PdfSaveOptions()

public PdfSaveOptions()

Namespace: Sheetize Assembly: Sheetize.dll

Class ProtectionSettings

Info

Represents the required settings for protecting one excel file or one sheet in it.

public class ProtectionSettings

Inheritance

object ← ProtectionSettings

Inherited Members

Constructors

ProtectionSettings()

public ProtectionSettings()

Properties

Password

The password of protection.

public string Password { get; set; }

Property Value

ProtectionType

The protection type to lock one excel file or one sheet in it.

public ProtectionType ProtectionType { get; set; }

Property Value

ProtectionType

Namespace: Sheetize Assembly: Sheetize.dll

Class SaveOptions

Info

Options for saving file.

public class SaveOptions

Inheritance

object ← SaveOptions

Derived

Inherited Members

Constructors

SaveOptions()

public SaveOptions()

Properties

OutputFile

Gets and sets the file(with path if needed) for saving the generated data. When setting this property with value other than null or empty string, Sheetize.SaveOptions.OutputStream will be ignored.

public string OutputFile { get; set; }

Property Value

OutputStream

Gets and sets the Stream for writing the generated data to. When setting this property with value other than null, Sheetize.SaveOptions.OutputFile will be ignored.

public Stream OutputStream { get; set; }

Property Value

Stream

Namespace: Sheetize Assembly: Sheetize.dll

Class SaveOptionsProviderAssembling

Info

Implementation to provide save options which save split parts to files and the path of resultant file are named as(it may contains directories): Sheetize.SaveOptionsProviderAssembling.PathHeader+Sheetize.SaveOptionsProviderAssembling.SheetPrefix+SheetIndex(or SheetName) +Sheetize.SaveOptionsProviderAssembling.SplitPartPrefix+SplitPartIndex+Sheetize.SaveOptionsProviderAssembling.PathTail.

public class SaveOptionsProviderAssembling : AbstractSaveOptionsProvider

Inheritance

object ← AbstractSaveOptionsProvider ← SaveOptionsProviderAssembling

Inherited Members

Constructors

SaveOptionsProviderAssembling()

public SaveOptionsProviderAssembling()

Properties

BuildPathWithSheetAlways

Whether add sheet index or name to file path always. Default value is false, that is, when there is only one sheet, the sheet index(or name) and corresponding prefix will not be added to the file path.

public bool BuildPathWithSheetAlways { get; set; }

Property Value

BuildPathWithSplitPartAlways

Whether add split part index to file path always. Default value is false, that is, when there is only one split part, the split part index and corresponding prefix will not be added to the file path.

public bool BuildPathWithSplitPartAlways { get; set; }

Property Value

PathHeader

Header part(before added content of sheet and split part) of file path.

public string PathHeader { get; set; }

Property Value

PathTail

Tailing part(after sequence numbers) of file path. It should include extension of file name.

public string PathTail { get; set; }

Property Value

SaveOptionsTemplate

The template for creating instance of save options in Sheetize.SaveOptionsProviderAssembling.GetSaveOptions(Sheetize.SplitPartInfo).

public SaveOptions SaveOptionsTemplate { get; set; }

Property Value

SaveOptions

Remarks

If the template has been specified, then the created instance will copy all setting from it and update the output file accordingly.

SheetIndexOffset

Offset of sheet’s index between what used in file path and its actual value(Sheetize.SplitPartInfo.SheetIndex).

public int SheetIndexOffset { get; set; }

Property Value

Remarks

Only takes effect when Sheetize.SaveOptionsProviderAssembling.UseSheetName is false.

SheetPrefix

Prefix for the index of worksheet.

public string SheetPrefix { get; set; }

Property Value

Remarks

If there is only one worksheet and Sheetize.SaveOptionsProviderAssembling.BuildPathWithSheetAlways is false, then this prefix and the sheet index(or name) will not be added to the resultant file path.

SplitPartIndexOffset

Offset of split part’s index between what used in file path and its actual value(Sheetize.SplitPartInfo.PartIndex).

public int SplitPartIndexOffset { get; set; }

Property Value

SplitPartPrefix

Prefix for the index of split part.

public string SplitPartPrefix { get; set; }

Property Value

Remarks

If there is only one split part and Sheetize.SaveOptionsProviderAssembling.BuildPathWithSplitPartAlways is false, then this prefix and the split part index(0) will not be added to the resultant file path.

UseSheetName

Whether builds the file path with sheet name instead of sheet index. Default value is false.

public bool UseSheetName { get; set; }

Property Value

Remarks

The sheet name will never be rebuilt automatically. So when set it to true, please make sure there is no special sheet name that can cause invalid file path or name.

Methods

GetSaveOptions(SplitPartInfo)

Gets the save options from which to get the output settings for currently split part.

public override SaveOptions GetSaveOptions(SplitPartInfo part)

Parameters

part SplitPartInfo

Returns

SaveOptions :

Namespace: Sheetize Assembly: Sheetize.dll

Class SaveOptionsProviderPlaceHolders

Info

Implementation to provide save options which save split parts to files and the path of resultant file are defined with placeholders.

public class SaveOptionsProviderPlaceHolders : AbstractSaveOptionsProvider

Inheritance

object ← AbstractSaveOptionsProvider ← SaveOptionsProviderPlaceHolders

Inherited Members

Constructors

SaveOptionsProviderPlaceHolders(string)

Instantiates an instance to provide save options according to specified templates.

public SaveOptionsProviderPlaceHolders(string pathTemplate)

Parameters

pathTemplate string: The template of the resultant file path.

Remarks

The supported placeholders in file path template:

${SheetIndex}: will be replaced by the sheet index of the split part
${SheetName}: will be replaced by the sheet name of the split part
${SplitPartIndex}: will be replaced by the index of the split part
${SheetIndexPrefix}: will be replaced by Sheetize.SaveOptionsProviderPlaceHolders.SheetIndexPrefix
${SheetNamePrefix}: will be replaced by Sheetize.SaveOptionsProviderPlaceHolders.SheetNamePrefix
${SplitPartPrefix}: will be replaced by Sheetize.SaveOptionsProviderPlaceHolders.SplitPartPrefix

Properties

BuildPathWithSheetAlways

Whether add sheet index or name to file path always. Default value is false, that is, when there is only one sheet, the sheet index and name and corresponding prefix(Sheetize.SaveOptionsProviderPlaceHolders.SheetNamePrefix) will not be added to the file path.

public bool BuildPathWithSheetAlways { get; set; }

Property Value

BuildPathWithSplitPartAlways

Whether add split part index to file path always. Default value is false, that is, when there is only one split part, the split part index and corresponding prefix(Sheetize.SaveOptionsProviderPlaceHolders.SplitPartPrefix) will not be added to the file path.

public bool BuildPathWithSplitPartAlways { get; set; }

Property Value

SaveOptionsTemplate

The template for creating instance of save options in Sheetize.SaveOptionsProviderPlaceHolders.GetSaveOptions(Sheetize.SplitPartInfo).

public SaveOptions SaveOptionsTemplate { get; set; }

Property Value

SaveOptions

Remarks

If the template has been specified, then the created instance will copy all setting from it and update the output file accordingly.

SheetIndexOffset

Offset of sheet’s index between what used in file path and its actual value(Sheetize.SplitPartInfo.SheetIndex).

public int SheetIndexOffset { get; set; }

Property Value

SheetIndexPrefix

Prefix for the index of worksheet.

public string SheetIndexPrefix { get; set; }

Property Value

Remarks

If there is only one worksheet and Sheetize.SaveOptionsProviderPlaceHolders.BuildPathWithSheetAlways is false, then this prefix and the sheet index(or name) will not be added to the resultant file path.

SheetNamePrefix

Prefix for the index of worksheet.

public string SheetNamePrefix { get; set; }

Property Value

Remarks

SplitPartIndexOffset

Offset of split part’s index between what used in file path and its actual value(Sheetize.SplitPartInfo.PartIndex).

public int SplitPartIndexOffset { get; set; }

Property Value

SplitPartPrefix

Prefix for the index of split part.

public string SplitPartPrefix { get; set; }

Property Value

Remarks

If there is only one split part and Sheetize.SaveOptionsProviderPlaceHolders.BuildPathWithSplitPartAlways is false, then this prefix and the split part index(0) will not be added to the resultant file path.

Methods

GetSaveOptions(SplitPartInfo)

Gets the save options from which to get the output settings for currently split part.

public override SaveOptions GetSaveOptions(SplitPartInfo part)

Parameters

part SplitPartInfo

Returns

SaveOptions :

Namespace: Sheetize Assembly: Sheetize.dll

Class SheetizeException

Info

The exception that is thrown when Sheetize specified error occurs.

public class SheetizeException : ApplicationException, ISerializable

Inheritance

object ← Exception ← ApplicationException ← SheetizeException

Implements

ISerializable

Inherited Members

Properties

Code

Represents custom exception code.

public ExceptionType Code { get; }

Property Value

ExceptionType

Namespace: Sheetize Assembly: Sheetize.dll

Class SignatureData

Info

Data used to add signature for spreadsheet file.

public class SignatureData

Inheritance

object ← SignatureData

Inherited Members

Constructors

SignatureData()

public SignatureData()

Properties

CertificateData

Certificate data.

public byte[] CertificateData { get; set; }

Property Value

byte[]

Comment

Comment for the signature.

public string Comment { get; set; }

Property Value

Password

Password of the certificate file.

public string Password { get; set; }

Property Value

Namespace: Sheetize Assembly: Sheetize.dll

Class SignatureSaveOptions

Info

Options for adding signature and saving the signed spreadsheet file.

public class SignatureSaveOptions : SaveOptions

Inheritance

object ← SaveOptions ← SignatureSaveOptions

Inherited Members

Constructors

SignatureSaveOptions()

public SignatureSaveOptions()

Properties

SignatureData

Signature data used for adding signature for spreadsheet file. Null value for this property denotes to remove signature from spreadsheet file.

public SignatureData[] SignatureData { get; set; }

Property Value

SignatureData[]

Namespace: Sheetize Assembly: Sheetize.dll

Class SplitPartInfo

Info

Represents the information of one input/output for multiple inputs/outputs, such as current page to be rendered when converting spreadsheet to image.

public class SplitPartInfo

Inheritance

object ← SplitPartInfo

Inherited Members

Remarks

For some processes, such as converting workbook to image of format that supports multiple pages(such as tiff), the Sheetize.SplitPartInfo.SheetIndex and Sheetize.SplitPartInfo.PartIndex will be -1, Sheetize.SplitPartInfo.SheetName will be empty.

Properties

PartIndex

Index of current part in sequence(0 based). -1 means there are no multiple parts so the result is single.

public int PartIndex { get; }

Property Value

Remarks

If multiple sheets need to be processed and every sheet is processed(split) separately, the part index always starts from 0 for every sheet. For example, when converting workbook to images, it represents the output page index of currently processed sheet. And -1 denotes there is only one page for current sheet.

SheetIndex

Index of the sheet where current part is in. -1 denotes there is only one sheet.

public int SheetIndex { get; }

Property Value

SheetName

Name of the sheet where current part is in.

public string SheetName { get; }

Property Value

Remarks

May be null for some situations such as when rendering the whole workbook to tiff image.

Namespace: Sheetize Assembly: Sheetize.dll

Class SplitterSaveOptions

Info

Options for splitting template file.

public class SplitterSaveOptions : SaveOptions

Inheritance

object ← SaveOptions ← SplitterSaveOptions

Inherited Members

Constructors

SplitterSaveOptions()

public SplitterSaveOptions()

Namespace: Sheetize Assembly: Sheetize.dll

Class SpreadsheetConverter

Info

Converter for conversion between different spreadsheet file formats, such as xls, xlsx, xlsb, spreadsheet ml…

public class SpreadsheetConverter

Inheritance

object ← SpreadsheetConverter

Inherited Members

Examples

[C#]
LoadOptions loadOptions = new LoadOptions();
loadOptions.InputFile = "Template.xlsx";
SpreadsheetSaveOptions saveOptions = new SpreadsheetSaveOptions();
saveOptions.OutputFile = "res.xlsb";
SpreadsheetConverter.Process(loadOptions, saveOptions);

Methods

Process(LoadOptions, SaveOptions)

Converts between different spreadsheet file formats.

public static void Process(LoadOptions loadOptions, SaveOptions saveOptions)

Parameters

loadOptions LoadOptions: Options for input and loading:
saveOptions SaveOptions: Options for output and saving

Namespace: Sheetize Assembly: Sheetize.dll

Class SpreadsheetLocker

Info

Locks spreadsheet file

public class SpreadsheetLocker

Inheritance

object ← SpreadsheetLocker

Inherited Members

Examples

[C#]
private class MyLockerSaveOptions : LockerSaveOptions
{
    public override ProtectionSettings GetPasswordOfWorksheetProtection(SplitPartInfo info)
    {
        if (info.SheetName == "ToProtect")
        {
            ProtectionSettings ps = new ProtectionSettings();
            ps.Password = "123456";
            ps.ProtectionType = ProtectionType.All;
            return ps;
        }
        return null;
    }
}
SpreadsheetLocker processor = new SpreadsheetLocker();
LoadOptions loadOptions = new LoadOptions();
loadOptions.InputFile = "Template.xlsx";
MyLockerSaveOptions saveOptions = new MyLockerSaveOptions();
saveOptions.Password = "password to lock file";
saveOptions.OutputFile = "res_locked.xlsx";
SpreadsheetLocker.Process(loadOptions, saveOptions);

Methods

Process(LoadOptions, LockerSaveOptions)

public static void Process(LoadOptions loadOptions, LockerSaveOptions saveOptions)

Parameters

loadOptions LoadOptions: Options for input and loading:
saveOptions LockerSaveOptions: Options for output and saving

Remarks

The re-saved file after being locked will always have the same format with the source file.

Namespace: Sheetize Assembly: Sheetize.dll

Class SpreadsheetMerger

Info

Merges multiple template files into one.

public class SpreadsheetMerger

Inheritance

object ← SpreadsheetMerger

Inherited Members

Examples

[C#]
LoadOptions loadOptions = new LoadOptions();
list.Add(new LoadOptions() { InputFile = "template1.xlsx" });
list.Add(new LoadOptions() { InputFile = "template2.xlsx" });
SpreadsheetSaveOptions saveOptions = new SpreadsheetSaveOptions();
saveOptions.OutputFile = "merged.xlsx";
SpreadsheetMerger.Process(loadOptions, saveOptions,
    new string[] { "template2.xlsx", "template2.xlsx", });

Methods

Process(LoadOptions, SaveOptions, string[])

public static void Process(LoadOptions loadOptions, SaveOptions saveOptions, string[] files)

Parameters

loadOptions LoadOptions: Options for input and loading. Its input(Sheetize.LoadOptions.InputFile or Sheetize.LoadOptions.InputStream): takes no effect because all inputs will be specified by “files” parameter.
saveOptions SaveOptions: Options for output and saving:
files string[]: All template files to be merged

Process(LoadOptions, SaveOptions, AbstractLoadOptionsProvider)

public static void Process(LoadOptions loadOptions, SaveOptions saveOptions, AbstractLoadOptionsProvider provider)

Parameters

loadOptions LoadOptions: Options for loading. Its input(Sheetize.LoadOptions.InputFile or Sheetize.LoadOptions.InputStream): takes no effect because all inputs will be specified by “provider” parameter.
saveOptions SaveOptions: Options for output and saving:
provider AbstractLoadOptionsProvider: Provider of load options for getting inputs to be merged

Namespace: Sheetize Assembly: Sheetize.dll

Class SpreadsheetSaveOptions

Info

Options for saving spreadsheet.

public class SpreadsheetSaveOptions : SaveOptions

Inheritance

object ← SaveOptions ← SpreadsheetSaveOptions

Inherited Members

Constructors

SpreadsheetSaveOptions()

public SpreadsheetSaveOptions()

Properties

SaveFormat

Gets and sets the format of spreadsheet.

public FileFormatType SaveFormat { get; set; }

Property Value

Namespace: Sheetize Assembly: Sheetize.dll

Class SpreadsheetSignature

Info

Adds/Removes signature for spreadsheet file.

public class SpreadsheetSignature

Inheritance

object ← SpreadsheetSignature

Inherited Members

Methods

Process(LoadOptions, SignatureSaveOptions)

public static void Process(LoadOptions loadOptions, SignatureSaveOptions saveOptions)

Parameters

loadOptions LoadOptions:
saveOptions SignatureSaveOptions

Namespace: Sheetize Assembly: Sheetize.dll

Class SpreadsheetSplitter

Info

Splits spreadsheet file into multiple parts.

public class SpreadsheetSplitter

Inheritance

object ← SpreadsheetSplitter

Inherited Members

Examples

[C#]
LoadOptions loadOptions = new LoadOptions();
loadOptions.InputFile = "Template.xlsx";
SpreadsheetSaveOptions saveOptions = new SpreadsheetSaveOptions();
SpreadsheetSplitter.Process(loadOptions, saveOptions);

Methods

Process(LoadOptions, SplitterSaveOptions)

public static void Process(LoadOptions loadOptions, SplitterSaveOptions saveOptions)

Parameters

loadOptions LoadOptions: Options for input and loading:
saveOptions SplitterSaveOptions: Options for output and saving

Remarks

If the save options has specified Stream as output, then all split parts will be saved to the same Stream. Otherwise, the output files will be build from the specified output file by appending sequence number of the sheet and split part. For example, if the specified output file is Split.xlsx, then the generated files will be Split_0_0.xlsx, Split_0_1.xlsx, …, Split_1_0.xlsx, …

Process(LoadOptions, SplitterSaveOptions, AbstractSaveOptionsProvider)

public static void Process(LoadOptions loadOptions, SplitterSaveOptions saveOptions, AbstractSaveOptionsProvider provider)

Parameters

loadOptions LoadOptions: Options for input and loading:
saveOptions SplitterSaveOptions: Options for saving. Its output(Sheetize.SaveOptions.OutputFile or Sheetize.SaveOptions.OutputStream): takes no effect because all outputs will be specified by the “provider” parameter:
provider AbstractSaveOptionsProvider: Provider of save options for saving split parts

Namespace: Sheetize Assembly: Sheetize.dll

Class SpreadsheetUnlocker

Info

Unlocks spreadsheet file.

public class SpreadsheetUnlocker

Inheritance

object ← SpreadsheetUnlocker

Inherited Members

Examples

[C#]
UnlockerLoadOptions loadOptions = new UnlockerLoadOptions();
loadOptions.InputFile = "Template.xlsx";
loadOptions.Password = "password to open file";
SaveOptions saveOptions = new SaveOptions();
saveOptions.OutputFile = "res.xlsx";
SpreadsheetUnlocker.Process(loadOptions, saveOptions);

Methods

Process(UnlockerLoadOptions, SaveOptions)

public static void Process(UnlockerLoadOptions loadOptions, SaveOptions saveOptions)

Parameters

loadOptions UnlockerLoadOptions: Options for input and loading:
saveOptions SaveOptions: Options for output and saving

Remarks

The re-saved file after being unlocked will always have the same format with the source file.

Namespace: Sheetize Assembly: Sheetize.dll

Class TextConverter

Info

Converter for conversion between text based formats(csv, markdown, dif…) and other spreadsheet file formats.

public class TextConverter

Inheritance

object ← TextConverter

Inherited Members

Examples

[C#]
LoadOptions loadOptions = new LoadOptions();
loadOptions.InputFile = "Template.csv";
TextSaveOptions saveOptions = new TextSaveOptions();
saveOptions.OutputFile = "res.xlsx";
TextConverter.Process(loadOptions, saveOptions);

Methods

Process(LoadOptions, SaveOptions)

Converts file format between text based formats and other spreadsheet file formats

public static void Process(LoadOptions loadOptions, SaveOptions saveOptions)

Parameters

loadOptions LoadOptions: Options for input and loading:
saveOptions SaveOptions: Options for output and saving

Namespace: Sheetize Assembly: Sheetize.dll

Class TextSaveOptions

Info

Options for saving .SQL,.MD, .CSV, .TSV, .TXT, .XML, .DIF.

public class TextSaveOptions : SaveOptions

Inheritance

object ← SaveOptions ← TextSaveOptions

Inherited Members

Constructors

TextSaveOptions()

public TextSaveOptions()

Properties

SaveFormat

Gets and sets the format of spreadsheet.

public FileFormatType SaveFormat { get; set; }

Property Value

Namespace: Sheetize Assembly: Sheetize.dll

Class UnlockerLoadOptions

Info

Options to unlock excel files.

public class UnlockerLoadOptions : LoadOptions

Inheritance

object ← LoadOptions ← UnlockerLoadOptions

Inherited Members

Constructors

UnlockerLoadOptions()

public UnlockerLoadOptions()

Properties

Password

Password to open the file.

public string Password { get; set; }

Property Value

PasswordOfWorkbookProtection

Password to protect the workbook. If it is null, workbook protection will be kept without change.

public string PasswordOfWorkbookProtection { get; set; }

Property Value

PasswordOfWriteProtection

Password to modify the file. If it is null, write protection will be kept without change.

public string PasswordOfWriteProtection { get; set; }

Property Value