SpreadsheetSaveOptions

SpreadsheetSaveOptions class

Allows to specify custom options for generating and saving Spreadsheet (Excel-compliant) documents

public sealed class SpreadsheetSaveOptions : ISaveOptions

Constructors

Name Description
SpreadsheetSaveOptions() This parameterless constructor creates a new instance of SpreadsheetSaveOptions with XLSX output format (can be modified then through OutputFormat property)
SpreadsheetSaveOptions(SpreadsheetFormats) Creates a new instance of SpreadsheetSaveOptions with specified mandatory Spreadsheet output format, while all other parameters are default

Properties

Name Description
InsertAsNewWorksheet { get; set; } Boolean flag, which specifies whether edited worksheet should replace the existing worksheet in original spreadsheet on the position, specified by the WorksheetNumber property, or it should be injected between existing worksheet and previous one, without replacing its content. By default is false — existing worksheet will be replaced. This property is ignored, if value of WorksheetNumber property is set to ‘0’.
OutputFormat { get; set; } Allows to specify a Spreadsheet format, which will be used for saving the document
Password { get; set; } Allows to specify, modify, obtain, or remove a password, which will be used to encode the generated Spreadsheet document, if tis document format supports password protection. Specify NULL or empty string for removing (cleaning) the password.
WorksheetNumber { get; set; } Allows to insert edited worksheet into copy of existing spreadsheet instead of creating a new single-worksheet spreadsheet (default behavior). WorksheetNumber is a 1-based number of a worksheet in the spreadsheet, loaded in the Editor class. If it is 0 (default value), the new spreadsheet will be created with single edited worksheet. If it is greater or lesser then zero, and there is valid spreadsheet, loaded in the Editor class, the edited worksheet, that is represented by input EditableDocument instance, will be inserted into this spreadsheet.
WorksheetProtection { get; set; } Allows to enable a worksheet protection for the output Spreadsheet document. By default is NULL - protection is not applied. Not all formats support a worksheet protection.

See Also

SpreadsheetLoadOptions TextDirection