Class FtSerializationCoreAbstract

OptionalonFieldHeadingReadReady

OptionalonFieldHeadingWriteReady

OptionalonFieldValueReadReady

OptionalonFieldValueWriteReady

OptionalonHeadingLineFinished

OptionalonHeadingLineStarted

OptionalonRecordFinished

OptionalonRecordStarted

OptionalonSequenceRedirected

Static ReadonlyPrefixSpaceChar

Static ReadonlyVersionMajor

Static ReadonlyVersionMinor

allowEndOfLineCharInQuotes

• get allowEndOfLineCharInQuotes(): boolean

  Returns boolean

allowIncompleteRecords

• get allowIncompleteRecords(): boolean

  Returns boolean

culture

• get culture(): DotNetLocaleSettings

  Returns DotNetLocaleSettings

delimiterChar

• get delimiterChar(): string

  Returns string

depth

• get depth(): number

  Number of sequences currently invoked (depth of sequence invokation stack).

  IDataReader member

  Returns number

endOfLineAutoWriteType

• get endOfLineAutoWriteType(): FtEndOfLineAutoWriteType

  Returns FtEndOfLineAutoWriteType

endOfLineChar

• get endOfLineChar(): string

  Returns string

endOfLineType

• get endOfLineType(): FtEndOfLineType

  Returns FtEndOfLineType

fieldCount

• get fieldCount(): number

  Number of fields in the current record.

  IDataReader member

  Returns number

fieldDefinitionList

• get fieldDefinitionList(): FtFieldDefinitionList

  Returns FtFieldDefinitionList

fieldList

• get fieldList(): FtFieldList

  Returns FtFieldList

headingAlwaysWriteOptionalQuote

• get headingAlwaysWriteOptionalQuote(): boolean

  Returns boolean

headingConstraint

• get headingConstraint(): FtHeadingConstraint

  Returns FtHeadingConstraint

headingEndOfValueChar

• get headingEndOfValueChar(): string

  Returns string

headingLineCount

• get headingLineCount(): number

  Returns number

headingPadAlignment

• get headingPadAlignment(): FtPadAlignment

  Returns FtPadAlignment

headingPadChar

• get headingPadChar(): string

  Returns string

headingPadCharType

• get headingPadCharType(): FtPadCharType

  Returns FtPadCharType

headingQuotedType

• get headingQuotedType(): FtQuotedType

  Returns FtQuotedType

headingTruncateChar

• get headingTruncateChar(): string

  Returns string

headingTruncateType

• get headingTruncateType(): FtTruncateType

  Returns FtTruncateType

headingWritePrefixSpace

• get headingWritePrefixSpace(): boolean

  Returns boolean

ignoreBlankLines

• get ignoreBlankLines(): boolean

  Returns boolean

ignoreExtraChars

• get ignoreExtraChars(): boolean

  Returns boolean

AbstractisClosed

• get isClosed(): boolean

  Whether the reader/writer is closed.

  IDataReader member

  Returns boolean

lastLineEndedType

• get lastLineEndedType(): FtLastLineEndedType

  Returns FtLastLineEndedType

lineCommentChar

• get lineCommentChar(): string

  Returns string

mainHeadingLineIndex

• get mainHeadingLineIndex(): number

  Returns number

previousRecordSequenceInvokationList

• get previousRecordSequenceInvokationList(): FtSequenceInvokationList

  Returns FtSequenceInvokationList

quoteChar

• get quoteChar(): string

  Returns string

recordCount

• get recordCount(): number

  Returns number

rootFieldCount

• get rootFieldCount(): number

  Returns number

rootSequence

• get rootSequence(): FtSequence | undefined

  Returns FtSequence | undefined

rootSequenceInvokation

• get rootSequenceInvokation(): FtSequenceInvokation | undefined

  Returns FtSequenceInvokation | undefined

seeking

• get seeking(): boolean

  Returns boolean

sequenceInvokationList

• get sequenceInvokationList(): FtSequenceInvokationList

  Returns FtSequenceInvokationList

sequenceList

• get sequenceList(): FtSequenceList

  Returns FtSequenceList

stuffedEmbeddedQuotes

• get stuffedEmbeddedQuotes(): boolean

  Returns boolean

substitutionChar

• get substitutionChar(): string

  Returns string

substitutionList

• get substitutionList(): FtSubstitutionList

  Returns FtSubstitutionList

substitutionsEnabled

• get substitutionsEnabled(): boolean

  Returns boolean

tableCount

• get tableCount(): number

  Returns number

Abstractclose

• close(): void

  Returns void

getField

• getField(idx: number): FtField

  Get a FtField object at index.

  Parameters

  • idx: number

  Returns FtField

getFieldByName

• getFieldByName(name: string): FtField | undefined

  Get a FtField object by name.

  Parameters

  • name: string

  Returns FtField | undefined

getFieldIndexByName

• getFieldIndexByName(name: string): number | undefined

  Get a index of field in record by its name.

  Parameters

  • name: string

  Returns number | undefined

  Throws

  Error if the field is not found.

getFieldName

• getFieldName(idx: number): string

  Get the name of the field at the given index.

  Parameters

  • idx: number

  Returns string

getFieldNullableValue

• getFieldNullableValue(idx: number): FtField.Value | null

  Get a field value by index. Returns null if the field value is null.

  Parameters

  • idx: number

  Returns FtField.Value | null

getFieldNullableValueByName

• getFieldNullableValueByName(name: string): FtField.Value | null

  Get a field value by name. Returns null if the field value is null.

  Parameters

  • name: string

  Returns FtField.Value | null

  Throws

  Error if the field is not found.

getFieldValue

• getFieldValue(idx: number): FtField.Value | null

  Get a field value by index.

  Parameters

  • idx: number

  Returns FtField.Value | null

  Throws

  FtFieldNullError if the field value is null.

getFieldValueByName

• getFieldValueByName(name: string): FtField.Value | null

  Get a field value by name.

  Parameters

  • name: string

  Returns FtField.Value | null

  Throws

  FtFieldNullError if the field value is null.

  Throws

  Error if the field is not found.

getFieldValueType

• getFieldValueType(idx: number): string

  Get the value type of the field at the given index.

  Parameters

  • idx: number

  Returns string

getName

• getName(idx: number): string

  Name of the field at the given index. Alias for getFieldName.

  IDataReader member

  Parameters

  • idx: number

  Returns string

getOrdinal

• getOrdinal(name: string): number

  Get a index of field in record by its name.

  IDataReader member

  Parameters

  • name: string

  Returns number

  Throws

  Error if the field is not found.

isDBNull

• isDBNull(idx: number): boolean

  Whether the field value at the given index is null. Alias for isFieldNull.

  IDataReader member

  Parameters

  • idx: number

  Returns boolean

isFieldNull

• isFieldNull(idx: number): boolean

  Whether the field value at the given index is null.

  Parameters

  • idx: number

  Returns boolean

loadMeta

• loadMeta(meta: FtMeta): void

  Load configuration from FtMeta.

  Parameters

  • meta: FtMeta

  Returns void

tryGetSubstitutionValue

• tryGetSubstitutionValue(token: string): { found: boolean; value: string }

  Parameters

  • token: string

  Returns { found: boolean; value: string }