XlsxLoadOptions Class

Namespace:
GemBox.Spreadsheet
Assembly:
GemBox.Spreadsheet.dll

Represent options for loading from XLSX file format (Microsoft Excel Open XML Spreadsheet; Strict Open XML Spreadsheet; Excel 2007 and later).

public sealed class XlsxLoadOptions : LoadOptions
Public NotInheritable Class XlsxLoadOptions
    Inherits LoadOptions
Inheritance:
System.Object
XlsxLoadOptions

Constructors

XlsxLoadOptions()

Initializes a new instance of the XlsxLoadOptions class.

public XlsxLoadOptions()
Public Sub New

Properties

Password

Gets or sets the password to open protected / encrypted workbook.

public string Password { get; set; }
Public Property Password As String
Property Value
System.String

PreserveUnsupportedFeatures

Gets or sets a value indicating whether to preserve XLSX file format features that are not directly supported through GemBox.Spreadsheet object model.

public bool PreserveUnsupportedFeatures { get; set; }
Public Property PreserveUnsupportedFeatures As Boolean
Property Value
System.Boolean

true to preserve XLSX file format features that are not directly supported through GemBox.Spreadsheet object model; otherwise, false.

Remarks

Default value is set to true.

StreamingMode

Gets or sets the streaming mode that allows streamlined reading of ExcelRows of each ExcelWorksheet of a loaded ExcelFile.

Default value: None.

public LoadStreamingMode StreamingMode { get; set; }
Public Property StreamingMode As LoadStreamingMode
Property Value
LoadStreamingMode

The streaming mode.

Methods

IsEncrypted(Stream)

Determines whether the file is an encrypted XLSX.

public static bool IsEncrypted(Stream stream)
Public Shared Function IsEncrypted(stream As Stream) As Boolean
Parameters
stream
System.IO.Stream

The stream from which to read a file.

Returns
System.Boolean

true if file is an encrypted XLSX; otherwise, false.

IsEncrypted(String)

Determines whether the file is an encrypted XLSX.

public static bool IsEncrypted(string path)
Public Shared Function IsEncrypted(path As String) As Boolean
Parameters
path
System.String

The path from which to read a file.

Returns
System.Boolean

true if file is an encrypted XLSX; otherwise, false.

Events

ProgressChanged

Occurs when the loading progress of a file has changed.

public event EventHandler<OperationProgressChangedEventArgs> ProgressChanged
Public Event ProgressChanged As EventHandler(Of OperationProgressChangedEventArgs)
Event Type
System.EventHandler<OperationProgressChangedEventArgs>
Remarks

The file path or stream that was provided as a file source is used as a System.ComponentModel.ProgressChangedEventArgs.UserState.

Inherited Properties

CsvDefault

Gets the default options for loading from Character Separated Values file format.

(Inherited from LoadOptions)

HtmlDefault

Gets the default options for loading from HyperText Markup Language File (HTML) format.

(Inherited from LoadOptions)

OdsDefault

Gets the default options for loading from OpenDocument Spreadsheet file format.

(Inherited from LoadOptions)

TxtDefault

Gets the default options for loading from Tab delimited file format.

(Inherited from LoadOptions)

XlsDefault

Gets the default options for loading from XLS file format (Microsoft Excel Spreadsheet format; Excel 2003 and prior versions) .

(Inherited from LoadOptions)

XlsbDefault

Gets the default options for loading from XLSX file format (Microsoft Excel Binary File Format).

(Inherited from LoadOptions)

XlsxDefault

Gets the default options for loading from XLSX file format (Microsoft Excel Open XML Spreadsheet; Excel 2007 and later).

(Inherited from LoadOptions)

XmlDefault

Gets the default options for loading from XML file format (XML Spreadsheet 2003).

(Inherited from LoadOptions)

Examples