DelimitedTextOptions Constructor

Definition

Namespace: Extreme.Data.Text
Assembly: Extreme.Data (in Extreme.Data.dll) Version: 3.2.0

Overload List

DelimitedTextOptions(IFormatProvider, Boolean, Boolean, Int32, Int32, Type, Char, String, QuoteUsage, Char, QuoteEscapeMethod, Char, Boolean)	Constructs a new set of options for delimited text files.
DelimitedTextOptions(IFormatProvider, Boolean, Boolean, Int32, Int32, Type, Char, String, QuoteUsage, Char, QuoteEscapeMethod, Char, Boolean, AutoCategorization, Int32)	Constructs a new set of options for delimited text files.

DelimitedTextOptions(IFormatProvider, Boolean, Boolean, Int32, Int32, Type, Char, String, QuoteUsage, Char, QuoteEscapeMethod, Char, Boolean)

Constructs a new set of options for delimited text files.

public DelimitedTextOptions(
	IFormatProvider formatProvider,
	bool rowHeaders,
	bool columnHeaders,
	int startRow,
	int inferenceRows,
	Type decimalType,
	char columnDelimiter,
	string endOfLine,
	QuoteUsage quote,
	char quoteCharacter,
	QuoteEscapeMethod quoteEscapeMethod,
	char escapeCharacter,
	bool mergeConsecutiveDelimiters
)

Visual Basic

Public Sub New ( 
	formatProvider As IFormatProvider,
	rowHeaders As Boolean,
	columnHeaders As Boolean,
	startRow As Integer,
	inferenceRows As Integer,
	decimalType As Type,
	columnDelimiter As Char,
	endOfLine As String,
	quote As QuoteUsage,
	quoteCharacter As Char,
	quoteEscapeMethod As QuoteEscapeMethod,
	escapeCharacter As Char,
	mergeConsecutiveDelimiters As Boolean
)

C++/CLI

public:
DelimitedTextOptions(
	IFormatProvider^ formatProvider, 
	bool rowHeaders, 
	bool columnHeaders, 
	int startRow, 
	int inferenceRows, 
	Type^ decimalType, 
	wchar_t columnDelimiter, 
	String^ endOfLine, 
	QuoteUsage quote, 
	wchar_t quoteCharacter, 
	QuoteEscapeMethod quoteEscapeMethod, 
	wchar_t escapeCharacter, 
	bool mergeConsecutiveDelimiters
)

new : 
        formatProvider : IFormatProvider * 
        rowHeaders : bool * 
        columnHeaders : bool * 
        startRow : int * 
        inferenceRows : int * 
        decimalType : Type * 
        columnDelimiter : char * 
        endOfLine : string * 
        quote : QuoteUsage * 
        quoteCharacter : char * 
        quoteEscapeMethod : QuoteEscapeMethod * 
        escapeCharacter : char * 
        mergeConsecutiveDelimiters : bool -> DelimitedTextOptions

Parameters

formatProvider IFormatProvider: An IFormatProvider that is used in the conversion between text and other data types.
rowHeaders Boolean: Indicates that the first column contains row headers.
columnHeaders Boolean: Indicates that the first row contains column headers.
startRow Int32: An integer specifying the 1-based row which contains the start of the data.
inferenceRows Int32: The number of rows to use to infer the types of the columns.
decimalType Type: The type to use for numbers containing decimals.
columnDelimiter Char: The character used to separate columns.
endOfLine String: The string used to terminate a row.
quote QuoteUsage: A QuoteUsage value that specifies when fields should be quoted. The default is AsNeededForColumnType.
quoteCharacter Char: The character used to quote fields.
quoteEscapeMethod QuoteEscapeMethod: Specifies whether the quote character should be repeated twice when it appears in quoted text.
escapeCharacter Char: The character to use to escape quote characters.
mergeConsecutiveDelimiters Boolean: Indicates whether consecutive column delimiters are to be treated as a single delimiter.

Exceptions

ArgumentOutOfRangeException

startRow is less than 1.

DelimitedTextOptions(IFormatProvider, Boolean, Boolean, Int32, Int32, Type, Char, String, QuoteUsage, Char, QuoteEscapeMethod, Char, Boolean, AutoCategorization, Int32)

Constructs a new set of options for delimited text files.

public DelimitedTextOptions(
	IFormatProvider formatProvider = null,
	bool rowHeaders = false,
	bool columnHeaders = true,
	int startRow = 0,
	int inferenceRows = 100,
	Type decimalType = null,
	char columnDelimiter = ',',
	string endOfLine = "",
	QuoteUsage quote = QuoteUsage.AsNeededForColumnType,
	char quoteCharacter = '"',
	QuoteEscapeMethod quoteEscapeMethod = QuoteEscapeMethod.Double,
	char escapeCharacter = '\',
	bool mergeConsecutiveDelimiters = false,
	AutoCategorization autoCategorize = AutoCategorization.None,
	int maxCategories = 100
)

Visual Basic

Public Sub New ( 
	Optional formatProvider As IFormatProvider = Nothing,
	Optional rowHeaders As Boolean = false,
	Optional columnHeaders As Boolean = true,
	Optional startRow As Integer = 0,
	Optional inferenceRows As Integer = 100,
	Optional decimalType As Type = Nothing,
	Optional columnDelimiter As Char = ","C,
	Optional endOfLine As String = "",
	Optional quote As QuoteUsage = QuoteUsage.AsNeededForColumnType,
	Optional quoteCharacter As Char = """C,
	Optional quoteEscapeMethod As QuoteEscapeMethod = QuoteEscapeMethod.Double,
	Optional escapeCharacter As Char = "\"C,
	Optional mergeConsecutiveDelimiters As Boolean = false,
	Optional autoCategorize As AutoCategorization = AutoCategorization.None,
	Optional maxCategories As Integer = 100
)

C++/CLI

public:
DelimitedTextOptions(
	IFormatProvider^ formatProvider = nullptr, 
	bool rowHeaders = false, 
	bool columnHeaders = true, 
	int startRow = 0, 
	int inferenceRows = 100, 
	Type^ decimalType = nullptr, 
	wchar_t columnDelimiter = L',', 
	String^ endOfLine = L"", 
	QuoteUsage quote = QuoteUsage::AsNeededForColumnType, 
	wchar_t quoteCharacter = L'"', 
	QuoteEscapeMethod quoteEscapeMethod = QuoteEscapeMethod::Double, 
	wchar_t escapeCharacter = L'\', 
	bool mergeConsecutiveDelimiters = false, 
	AutoCategorization autoCategorize = AutoCategorization::None, 
	int maxCategories = 100
)

new : 
        ?formatProvider : IFormatProvider * 
        ?rowHeaders : bool * 
        ?columnHeaders : bool * 
        ?startRow : int * 
        ?inferenceRows : int * 
        ?decimalType : Type * 
        ?columnDelimiter : char * 
        ?endOfLine : string * 
        ?quote : QuoteUsage * 
        ?quoteCharacter : char * 
        ?quoteEscapeMethod : QuoteEscapeMethod * 
        ?escapeCharacter : char * 
        ?mergeConsecutiveDelimiters : bool * 
        ?autoCategorize : AutoCategorization * 
        ?maxCategories : int 
(* Defaults:
        let _formatProvider = defaultArg formatProvider null
        let _rowHeaders = defaultArg rowHeaders false
        let _columnHeaders = defaultArg columnHeaders true
        let _startRow = defaultArg startRow 0
        let _inferenceRows = defaultArg inferenceRows 100
        let _decimalType = defaultArg decimalType null
        let _columnDelimiter = defaultArg columnDelimiter ','
        let _endOfLine = defaultArg endOfLine ""
        let _quote = defaultArg quote QuoteUsage.AsNeededForColumnType
        let _quoteCharacter = defaultArg quoteCharacter '"'
        let _quoteEscapeMethod = defaultArg quoteEscapeMethod QuoteEscapeMethod.Double
        let _escapeCharacter = defaultArg escapeCharacter '\'
        let _mergeConsecutiveDelimiters = defaultArg mergeConsecutiveDelimiters false
        let _autoCategorize = defaultArg autoCategorize AutoCategorization.None
        let _maxCategories = defaultArg maxCategories 100
*)
-> DelimitedTextOptions

Parameters

formatProvider IFormatProvider (Optional): An IFormatProvider that is used in the conversion between text and other data types.
rowHeaders Boolean (Optional): Indicates that the first column contains row headers.
columnHeaders Boolean (Optional): Indicates that the first row contains column headers.
startRow Int32 (Optional): An integer specifying the 1-based row which contains the start of the data.
inferenceRows Int32 (Optional): The number of rows to use to infer the types of the columns.
decimalType Type (Optional): The type to use for numbers containing decimals.
columnDelimiter Char (Optional): The character used to separate columns.
endOfLine String (Optional): The string used to terminate a row.
quote QuoteUsage (Optional): A QuoteUsage value that specifies when fields should be quoted. The default is AsNeededForColumnType.
quoteCharacter Char (Optional): The character used to quote fields.
quoteEscapeMethod QuoteEscapeMethod (Optional): Specifies whether the quote character should be repeated twice when it appears in quoted text.
escapeCharacter Char (Optional): The character to use to escape quote characters.
mergeConsecutiveDelimiters Boolean (Optional): Indicates whether consecutive column delimiters are to be treated as a single delimiter.
autoCategorize AutoCategorization (Optional): Specifies which columns should be automatically converted to categorical columns.
maxCategories Int32 (Optional): The largest number of distinct levels for a column to be considered categorical.

Exceptions

ArgumentOutOfRangeException

startRow is less than 1.

DelimitedTextOptions Constructor

Definition

Overload List

DelimitedTextOptions(IFormatProvider, Boolean, Boolean, Int32, Int32, Type, Char, String, QuoteUsage, Char, QuoteEscapeMethod, Char, Boolean)

Parameters

Exceptions

DelimitedTextOptions(IFormatProvider, Boolean, Boolean, Int32, Int32, Type, Char, String, QuoteUsage, Char, QuoteEscapeMethod, Char, Boolean, AutoCategorization, Int32)

Parameters

Exceptions

See Also

Reference