FixedWidthLoadOptions Class

Namespace:: GemBox.Spreadsheet

Assembly:: GemBox.Spreadsheet.dll

Represents options for loading from Fixed-Width Text file format.

C#
VB.NET

public sealed class FixedWidthLoadOptions : LoadOptions

Public NotInheritable Class FixedWidthLoadOptions
    Inherits LoadOptions

Inheritance:: System.Object
LoadOptions
FixedWidthLoadOptions

Constructors

FixedWidthLoadOptions(FixedWidthColumn[])

Initializes a new instance of the FixedWidthLoadOptions class.

C#
VB.NET

public FixedWidthLoadOptions(params FixedWidthColumn[] columns)

Public Sub New(ParamArray columns As FixedWidthColumn())

Parameters

columns: FixedWidthColumn[]

The column definitions for Fixed-Width Text file.

FixedWidthLoadOptions(IEnumerable<FixedWidthColumn>)

Initializes a new instance of the FixedWidthLoadOptions class.

C#
VB.NET

public FixedWidthLoadOptions(IEnumerable<FixedWidthColumn> columns)

Public Sub New(columns As IEnumerable(Of FixedWidthColumn))

Parameters

columns: System.Collections.Generic.IEnumerable<FixedWidthColumn>

The column definitions for Fixed-Width Text file.

Properties

Columns

Gets the list of column definitions for Fixed-Width Text file.

C#
VB.NET

public IList<FixedWidthColumn> Columns { get; }

Public ReadOnly Property Columns As IList(Of FixedWidthColumn)

Property Value

System.Collections.Generic.IList<FixedWidthColumn>

Encoding

Gets or sets the encoding for the Fixed-Width Text file.

C#
VB.NET

public Encoding Encoding { get; set; }

Public Property Encoding As Encoding

Property Value

System.Text.Encoding

Exceptions

System.ArgumentNullException

Value is set to null.

FormatProvider

Gets or sets the format provider for the Fixed-Width Text file.

C#
VB.NET

public IFormatProvider FormatProvider { get; set; }

Public Property FormatProvider As IFormatProvider

Property Value

System.IFormatProvider

Exceptions

System.ArgumentNullException

Value is set to null.

NumberStyles

Gets or sets a value indicating number styles permitted in strings when parsing them to numeric types.

C#
VB.NET

public NumberStyles NumberStyles { get; set; }

Public Property NumberStyles As NumberStyles

Property Value

System.Globalization.NumberStyles

ParseNumbers

Gets or sets a value indicating whether numbers will be parsed and stored as System.Double value when loading Fixed-Width Text file. If false, numbers will be loaded as strings.

C#
VB.NET

public bool ParseNumbers { get; set; }

Public Property ParseNumbers As Boolean

Property Value

System.Boolean

StartRow

Gets or sets the index of the first row of data being loaded from Fixed-Width Text file.

C#
VB.NET

public int StartRow { get; set; }

Public Property StartRow As Integer

Property Value

System.Int32

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)