TextDataReaderSettings Class

Spotfire 14.7 API Reference

Settings for the TextFileDataSource class.

Inheritance Hierarchy

SystemObject
Spotfire.Dxp.Data.ImportTextDataReaderSettings

Namespace: Spotfire.Dxp.Data.Import
Assembly: Spotfire.Dxp.Data (in Spotfire.Dxp.Data.dll) Version: 69.0.21424.2902 (69.0.21424.2902)

Syntax

Copy

[SerializableAttribute]
[PersistenceVersionAttribute(2, 0)]
public sealed class TextDataReaderSettings

The TextDataReaderSettings type exposes the following members.

Constructors

	Name	Description
	TextDataReaderSettings	Initializes a new instance of the TextDataReaderSettings class.

Top

Properties

	Name	Description
	AllowNewlinesInQuotedFields	Gets or sets a value indicating whether the data set has quoted fields which contain newline characters (that is, multi-line fields).
	CodePage	Gets or sets the code page.
	ColumnNameConcatenation	Gets or sets the format string used to concatenate the column names if there are more than one column name row defined.
	ColumnNameNullValueReplacement	Gets or sets the way an empty field is replaced if there are more than one name row.
	ColumnNameNullValueReplacementString	Gets or sets the string used to replace empty fields when concatenation column names.
	ColumnNameRows	Gets a readonly collection of column name rows.
	CommentPrefix	Gets or sets the string describing how a commented line starts.
	ConstantFieldCount	Gets or sets the number of columns in the data set.
	CultureName	Gets or sets the name of the explicitly set culture. Example: "en-US" for English(United States) culture settings.
	DataTypesGivenName	Gets a mapping (Dictionary) between column names and column types.
	DefaultColumnName	Gets or sets the default column name. Add a "{0}" to get a 1-based index applied to the column name. If no "{0}" is added, one will be automatically appended to the end.
	HasQuoteChar	Gets or sets a value indicating whether the data set has quote characters. The quote character to use is set in QuoteChar.
	HasTrailingSeparator	Gets or sets a value indicating whether the data has trailing separator.
	IgnoreColumns	Gets a readonly collection of ignored columns.
	IgnoreRows	Gets a readonly collection of ignored rows.
	MinimumFieldCount	Gets or sets the minimum number of columns in the data set.
	NullValueDescriptor	Gets or sets the string describing how a null value will be described in the data set.
	QuoteChar	Gets or sets the quote character.
	QuoteCharEscape	Gets or sets the quote character escape sequence.
	ReadOnly	Gets or sets a value indicating whether this instance is readonly.
	Separator	Gets or sets the separator string used to split the data set into fields.
	StartReadingRow	Gets or sets the row to start reading from.
	TypesRow	Gets or sets the types row.

Top

Methods

	Name	Description
	AddColumnNameRow	Adds the provided row to the list of column name rows.
	AddColumnNameRows	Adds the provided rows to the list of column name rows.
	AddIgnoreColumn	Adds the provided column to the list of ignored columns.
	AddIgnoreColumns	Adds the provided columns to the list of ignore columns.
	AddIgnoreRow	Adds the provided row to the list of ignored rows.
	AddIgnoreRows	Adds the provided rows to the list of ignored rows.
	AddPercentColumn	Adds a column to the list of percent columns.
	ClearColumnNameRows	Clears the list of column name rows.
	ClearColumnNames	Clears the list of column names. If the clearPersisted flag is false, the persisted names are kept.
	ClearDataTypes	Clears the list of data types. If the clearPersisted flag is false, the persisted data types are kept.
	ClearFormatters	Clears the list of formatters. If the clearPersisted flag is false, the persisted formatters are kept.
	ClearIgnoreColumns	Clears the list of ignored columns.
	ClearIgnoreRows	Clears the list of ignored rows.
	ClearParsers	Clear the list of parsers.
	ClearPercentColumns	Clears the list of Percent columns.
	Clone	Makes a clone of the settings object.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	GetColumnName	Gets the name for a specific column.
	GetColumnOffset	Gets the offset for the column, that is the count of ignored columns prior to this column. This is used when reading the data in TextDataReader.
	GetDataType	Gets the DataType for a specific column.
	GetDataTypeName	Gets the Spotfire type for the specified column.
	GetFormatter	Gets the IDataFormatter for the provided column.
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetInvariantCurrencySymbol	Gets the invariant currency symbol, if one exists.
	GetParser	Gets the parser that will be used to parse this column. If none has been set, None will be returned.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	HasMoreHeaders	Returns true if there are any type or name rows with higher number than the provided row number.
	IsPercentColumn	Returns true if the provided column is present in the list of percent columns.
	RemoveColumnName	Removes the column name from the list of column names.
	RemoveColumnNameRows	Removes the provided rows from the list of column name rows.
	RemoveDataType	Removes the stored data type for the specified column.
	RemoveFormatter	Removes the IDataFormatter for the provided column.
	RemoveIgnoreColumns	Removes the provided columns to the list of ignored columns.
	RemoveIgnoreRows	Removes the provided rows from the list of ignored rows.
	RemoveParser	Removes the parser for the provided column from the list of parsers, if it exists.
	RemovePercentColumn	Removes the provided column from the list of percent columns, if it exists.
	SetColumnName	Explicitly sets the name of a column.
	SetDataType	Explicitly sets the DataType of a column.
	SetFormatter	Sets the IDataFormatter for the provided column.
	SetInvariantCurrencySymbol	Sets the invariant currency symbol for the provided column index.
	SetParser	Sets the parser to use for the provided column.
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	ValidateColumnType	Validates the data type string, and if valid return the corresponding data type, otherwise returns Undefined.
	ValidateUniqueLines	A sanity check to make sure that no name rows, type row or ignored rows are the same.
	VerifyDefaultColumnName(String)	Verifies if the string is a valid default column name string.
	VerifyDefaultColumnName(String, String)	Verifies if the string is a valid default column name string.

Top

Events

	Name	Description
	CultureChanged	Event raised when the culture is changed in the settings object.

Top

Version Information

Supported in: 14.7, 14.6, 14.5, 14.4, 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8

Reference

Spotfire.Dxp.Data.Import Namespace