Action
    Preparing search index...

    Class TextDataReaderSettings

    Settings for the Spotfire.Dxp.Data.Import.TextFileDataSource class.

    2.0

    Hierarchy (View Summary)

    Index

    Methods

    Cast Equals GetHashCode ToString TryCast Equals

    Default capability

    constructor AllowNewlinesInQuotedFields CodePage ColumnNameConcatenation ColumnNameNullValueReplacement ColumnNameNullValueReplacementString ColumnNameRows CommentPrefix ConstantFieldCount CultureName DataTypesGivenName DefaultColumnName HasQuoteChar HasTrailingSeparator IgnoreColumns IgnoreRows MinimumFieldCount NullValueDescriptor QuoteChar QuoteCharEscape ReadOnly Separator StartReadingRow TypesRow AddColumnNameRow AddColumnNameRows AddIgnoreColumn AddIgnoreColumns AddIgnoreRow AddIgnoreRows AddPercentColumn ClearColumnNameRows ClearColumnNames ClearDataTypes ClearFormatters ClearIgnoreColumns ClearIgnoreRows ClearParsers ClearPercentColumns Clone GetColumnName GetColumnOffset GetDataType GetDataTypeName GetFormatter GetInvariantCurrencySymbol GetParser HasMoreHeaders IsPercentColumn RemoveColumnName RemoveColumnNameRows RemoveDataType RemoveFormatter RemoveIgnoreColumns RemoveIgnoreRows RemoveParser RemovePercentColumn SetColumnName SetDataType SetFormatter SetInvariantCurrencySymbol SetParser ValidateUniqueLines ValidateColumnType VerifyDefaultColumnName

    Methods

    • Casts this object to the specified type. Throws error on failure.

      Type Parameters

      • T1

        The target type of the cast.

      • T2

        The type of the object to cast.

      Parameters

      Returns T1

    • Determines whether the specified object is equal to the current object.

      Parameters

      • obj: any

        The object to compare with the current object.

      Returns boolean

      true if the specified object is equal to the current object; otherwise, false.

    • Serves as the default hash function.

      Returns number

      A hash code for the current object.

    • Returns a string that represents the current object.

      Returns string

      A string that represents the current object.

    • Casts this object to the specified type. Returns null on failure.

      Type Parameters

      • T1

        The target type of the cast.

      • T2

        The type of the object to cast.

      Parameters

      Returns T1 | null

    • Determines whether the specified object instances are considered equal.

      Parameters

      • objA: any

        The first object to compare.

      • objB: any

        The second object to compare.

      Returns boolean

      true if the objects are considered equal; otherwise, false. If both objA and objB are null, the method returns true.

    Default capability

    • get AllowNewlinesInQuotedFields(): boolean

      Gets or sets a value indicating whether the data set has quoted fields which contain newline characters (that is, multi-line fields).

      Returns boolean

      2.0

    • set AllowNewlinesInQuotedFields(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get CodePage(): number

      Gets or sets the code page.

      Returns number

      2.0

    • set CodePage(value: number): void

      Parameters

      • value: number

      Returns void

    • get ColumnNameConcatenation(): string

      Gets or sets the format string used to concatenate the column names if there are more than one column name row defined.

      Returns string

      2.0

    • set ColumnNameConcatenation(value: string): void

      Parameters

      • value: string

      Returns void

    • get CommentPrefix(): string

      Gets or sets the string describing how a commented line starts.

      Returns string

      If this is left empty, the parser will not look for comments at all. Example: //comment line name,name2,name3 1,2,3 4,5,6 //another comment line. 7,8,9

      Here "//" will be good to set as CommentPrefix.

      2.0

    • set CommentPrefix(value: string): void

      Parameters

      • value: string

      Returns void

    • get ConstantFieldCount(): number

      Gets or sets the number of columns in the data set.

      Returns number

      2.0

    • set ConstantFieldCount(value: number): void

      Parameters

      • value: number

      Returns void

    • get CultureName(): string

      Gets or sets the name of the explicitly set culture. Example: "en-US" for English(United States) culture settings.

      Returns string

      2.0

    • set CultureName(value: string): void

      Parameters

      • value: string

      Returns void

    • get DefaultColumnName(): string

      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.

      Returns string

      This string may not include any strings like "{<any characters>}", other than "{0}".

      2.0

    • set DefaultColumnName(value: string): void

      Parameters

      • value: string

      Returns void

    • get HasQuoteChar(): boolean

      Gets or sets a value indicating whether the data set has quote characters. The quote character to use is set in Spotfire.Dxp.Data.Import.TextDataReaderSettings.QuoteChar.

      Returns boolean

      2.0

    • set HasQuoteChar(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get HasTrailingSeparator(): boolean

      Gets or sets a value indicating whether the data has trailing separator.

      Returns boolean

      For example, the Spotfire Text Data Format always ends with a ";".

      2.0

    • set HasTrailingSeparator(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get MinimumFieldCount(): number

      Gets or sets the minimum number of columns in the data set.

      Returns number

      If there are rows with less fields these will be ignored. Name and Type rows will not be ignored even if they have less fields.

      2.0

    • set MinimumFieldCount(value: number): void

      Parameters

      • value: number

      Returns void

    • get NullValueDescriptor(): string

      Gets or sets the string describing how a null value will be described in the data set.

      Returns string

      Leave this empty if there are no strings that describe null values in the data.

      2.0

    • set NullValueDescriptor(value: string): void

      Parameters

      • value: string

      Returns void

    • get QuoteCharEscape(): string

      Gets or sets the quote character escape sequence.

      Returns string

      For example the quote character could be "" or & for the quote character ".

      2.0

    • set QuoteCharEscape(value: string): void

      Parameters

      • value: string

      Returns void

    • get ReadOnly(): boolean

      Gets or sets a value indicating whether this instance is readonly.

      Returns boolean

      2.0

    • set ReadOnly(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get Separator(): string

      Gets or sets the separator string used to split the data set into fields.

      Returns string

      2.0

    • set Separator(value: string): void

      Parameters

      • value: string

      Returns void

    • get StartReadingRow(): number

      Gets or sets the row to start reading from.

      Returns number

      Note that all rows before this will be completely ignored.

      2.0

    • set StartReadingRow(value: number): void

      Parameters

      • value: number

      Returns void

    • get TypesRow(): number

      Gets or sets the types row.

      Returns number

      If no types row exists, this will return -1.

      2.0

    • set TypesRow(value: number): void

      Parameters

      • value: number

      Returns void

    • Adds the provided row to the list of column name rows.

      Parameters

      Returns void

      2.0

    • Adds the provided column to the list of ignored columns.

      Parameters

      Returns void

      2.0

    • Adds the provided row to the list of ignored rows.

      Parameters

      Returns void

      2.0

    • Adds a column to the list of percent columns.

      Parameters

      Returns void

      2.0

    • Clears the list of column name rows.

      Returns void

      2.0

    • Clears the list of column names. If the clearPersisted flag is false, the persisted names are kept.

      Parameters

      • clearPersisted: boolean | System.Boolean

        A value indicating whether the persisted column names should be cleared as well.

      Returns void

      2.0

    • Clears the list of data types. If the clearPersisted flag is false, the persisted data types are kept.

      Parameters

      • clearPersisted: boolean | System.Boolean

        A value indicating whether the persisted data types should be cleared as well.

      Returns void

      2.0

    • Clears the list of formatters. If the clearPersisted flag is false, the persisted formatters are kept.

      Parameters

      • clearPersisted: boolean | System.Boolean

        A flag to specify if the persisted formatters should be cleared as well.

      Returns void

      2.0

    • Clears the list of ignored columns.

      Returns void

      2.0

    • Clears the list of ignored rows.

      Returns void

      2.0

    • Clear the list of parsers.

      Returns void

      2.0

    • Clears the list of Percent columns.

      Returns void

      2.0

    • Gets the name for a specific column.

      Parameters

      • column: number | System.Int32

        The column to get the name for.

      Returns string

      The column name if found; otherwise null.

      2.0

    • 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 Spotfire.Dxp.Data.Import.TextDataReader.

      Parameters

      • column: number | System.Int32

        The column to get the offset for.

      Returns number

      The offset.

      2.0

    • Gets the Spotfire type for the specified column.

      Parameters

      Returns string

      The Spotfire type

      2.0

    • Gets the invariant currency symbol, if one exists.

      Parameters

      • column: number | System.Int32

        The column to get the invariant currency symbol for.

      Returns string

      The invariant currency symbol, or null if there was none..

      2.0

    • Returns true if there are any type or name rows with higher number than the provided row number.

      Parameters

      Returns boolean

      True if more headers exists.

      2.0

    • Returns true if the provided column is present in the list of percent columns.

      Parameters

      Returns boolean

      True if the column existed in the list.

      2.0

    • Removes the column name from the list of column names.

      Parameters

      • column: number | System.Int32

        The column to remove the name for.

      Returns void

      2.0

    • Removes the stored data type for the specified column.

      Parameters

      • column: number | System.Int32

        The column to remove the data type for.

      Returns void

      2.0

    • Removes the parser for the provided column from the list of parsers, if it exists.

      Parameters

      • column: number | System.Int32

        The column to remove the parser for.

      Returns void

      2.0

    • Removes the provided column from the list of percent columns, if it exists.

      Parameters

      Returns void

      2.0

    • Explicitly sets the name of a column.

      Parameters

      Returns void

      2.0

    • Sets the invariant currency symbol for the provided column index.

      Parameters

      • column: number | System.Int32

        The column to set the invariant currency symbol for.

      • symbol: string | System.String

        The symbol to set.

      Returns void

      2.0

    • A sanity check to make sure that no name rows, type row or ignored rows are the same.

      Returns boolean

      true if the combination of rows is valid.

      2.0

    • Validates the data type string, and if valid return the corresponding data type, otherwise returns Undefined.

      Parameters

      • type: string | System.String

        A string representation of a data type.

      Returns Spotfire.Dxp.Data.DataType

      Returns the data type if the input string is valid, otherwize; Undefined.

      2.0

    • Verifies if the string is a valid default column name string.

      Parameters

      Returns boolean

      true if the string is valid, otherwise false.

      2.0

    • Verifies if the string is a valid default column name string.

      Parameters

      Returns boolean

      true if the string is valid, otherwise false.

      2.0

    Settings

    Member Visibility

    On This Page

    Methods
    Default capability
    constructorAllowNewlinesInQuotedFieldsCodePageColumnNameConcatenationColumnNameNullValueReplacementColumnNameNullValueReplacementStringColumnNameRowsCommentPrefixConstantFieldCountCultureNameDataTypesGivenNameDefaultColumnNameHasQuoteCharHasTrailingSeparatorIgnoreColumnsIgnoreRowsMinimumFieldCountNullValueDescriptorQuoteCharQuoteCharEscapeReadOnlySeparatorStartReadingRowTypesRowAddColumnNameRowAddColumnNameRowsAddIgnoreColumnAddIgnoreColumnsAddIgnoreRowAddIgnoreRowsAddPercentColumnClearColumnNameRowsClearColumnNamesClearDataTypesClearFormattersClearIgnoreColumnsClearIgnoreRowsClearParsersClearPercentColumnsCloneGetColumnNameGetColumnOffsetGetDataTypeGetDataTypeNameGetFormatterGetInvariantCurrencySymbolGetParserHasMoreHeadersIsPercentColumnRemoveColumnNameRemoveColumnNameRowsRemoveDataTypeRemoveFormatterRemoveIgnoreColumnsRemoveIgnoreRowsRemoveParserRemovePercentColumnSetColumnNameSetDataTypeSetFormatterSetInvariantCurrencySymbolSetParserValidateUniqueLinesValidateColumnTypeVerifyDefaultColumnName