FixedWidthSaveOptions Class

Namespace:: GemBox.Spreadsheet

Assembly:: GemBox.Spreadsheet.dll

Represents options for saving to Fixed-Width Text file format.

C#
VB.NET

public sealed class FixedWidthSaveOptions : SaveOptions

Public NotInheritable Class FixedWidthSaveOptions
    Inherits SaveOptions

Inheritance:: System.Object
SaveOptions
FixedWidthSaveOptions

Constructors

FixedWidthSaveOptions(FixedWidthColumn[])

Initializes a new instance of the FixedWidthSaveOptions class.

C#
VB.NET

public FixedWidthSaveOptions(params FixedWidthColumn[] columns)

Public Sub New(ParamArray columns As FixedWidthColumn())

Parameters

columns: FixedWidthColumn[]

The column definitions for Fixed-Width Text file.

FixedWidthSaveOptions(IEnumerable<FixedWidthColumn>)

Initializes a new instance of the FixedWidthSaveOptions class.

C#
VB.NET

public FixedWidthSaveOptions(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 saving data.

C#
VB.NET

public IList<FixedWidthColumn> Columns { get; }

Public ReadOnly Property Columns As IList(Of FixedWidthColumn)

Property Value

System.Collections.Generic.IList<FixedWidthColumn>

ContentType

Gets the content-type for Fixed-Width Text file format: "text/plain; charset=" + Encoding.System.Text.Encoding.WebName.

C#
VB.NET

public override string ContentType { get; }

Public Overrides ReadOnly Property ContentType As String

Property Value

System.String

The content-type for Fixed-Width Text file format.

Overrides

SaveOptions.ContentType

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.

Limitations

Gets limitations for saving to Fixed-Width Text file format.

C#
VB.NET

public override FileFormatLimitations Limitations { get; }

Public Overrides ReadOnly Property Limitations As FileFormatLimitations

Property Value

FileFormatLimitations

Overrides

SaveOptions.Limitations

Remarks

These are the limits:

MaxRows: System.Int32.MaxValue
MaxColumns: System.Int32.MaxValue
MaxColors: System.Int32.MaxValue
MaxCellStyles: System.Int32.MaxValue

StartRow

Gets or sets the index of the first row of data being saved to 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 saving to Character Separated Values file format. (Inherited from SaveOptions)
HtmlDefault	Gets the default options for saving to HyperText Markup Language File format. (Inherited from SaveOptions)
ImageDefault	Gets the default options for saving to image formats. (Inherited from SaveOptions)
OdsDefault	Gets the default options for saving to OpenDocument Spreadsheet file format. (Inherited from SaveOptions)
PdfDefault	Gets the default options for saving to Portable Document Format file. (Inherited from SaveOptions)
TxtDefault	Gets the default options for saving to Tab delimited file format. (Inherited from SaveOptions)
XlsDefault	Gets the default options for saving to, XLS file format (Microsoft Excel Spreadsheet format; Excel 2003 and prior versions) . (Inherited from SaveOptions)
XlsbDefault	Gets the default options for saving to XLSB file format (Microsoft Excel Binary File Format). (Inherited from SaveOptions)
XlsxDefault	Gets the default options for saving to XLSX file format (Microsoft Excel Open XML Spreadsheet; Excel 2007 and later). (Inherited from SaveOptions)
XpsDefault	Gets the default options for saving to XML Paper Specification file format. (Inherited from SaveOptions)