FieldedText TypeScript Library
    Preparing search index...

    Class FtSerializationWriter

    Writer for fielded text streams. Coordinates all writing logic.

    Hierarchy (View Summary)

    Index
    constructor
    _recordCount _tableCount onFieldHeadingReadReady? onFieldHeadingWriteReady? onFieldValueReadReady? onFieldValueWriteReady? onHeadingLineFinished? onHeadingLineStarted? onRecordFinished? onRecordStarted? onSequenceRedirected? CarriageReturnChar CarriageReturnLineFeedString LineFeedChar PrefixSpaceChar Signature VersionLabel VersionMajor VersionMinor VersionSeparator
    allowEndOfLineCharInQuotes allowIncompleteRecords baseWriter culture delimiterChar depth endOfLineAutoWriteType endOfLineChar endOfLineType fieldCount fieldDefinitionList fieldList headingAlwaysWriteOptionalQuote headingConstraint headingEndOfValueChar headingLineCount headingPadAlignment headingPadChar headingPadCharType headingQuotedType headingTruncateChar headingTruncateType headingWritePrefixSpace ignoreBlankLines ignoreExtraChars isClosed lastLineEndedType lineCommentChar mainHeadingLineIndex previousRecordSequenceInvokationList quoteChar recordCount rootFieldCount rootSequence rootSequenceInvokation seeking sequenceInvokationList sequenceList stuffedEmbeddedQuotes substitutionChar substitutionList substitutionsEnabled tableCount
    close fireFieldHeadingWriteReady fireFieldValueWriteReady fireHeadingLineFinished fireHeadingLineStarted fireRecordFinished fireRecordStarted fireSequenceRedirected flush getField getFieldByName getFieldIndexByName getFieldName getFieldNullableValue getFieldNullableValueByName getFieldValue getFieldValueByName getFieldValueType getName getOrdinal internalLoadMeta isDBNull isFieldNull loadMeta open redirect reset setBoolean setDateTime setDecimal setFieldValue setFieldValueByName setFloat setInteger setLineCommentChar setNull setNullByName setSeeking setString setValues tryGetSubstitutionValue unredirect write writeComment writeHeader

    Protected_recordCount

    _recordCount: number = 0

    Protected_tableCount

    _tableCount: number = 0
    onFieldHeadingReadReady?: (args: FtFieldHeadingReadyEventArgs) => void
    onFieldHeadingWriteReady?: (args: FtFieldHeadingReadyEventArgs) => void
    onFieldValueReadReady?: (args: FtFieldValueReadyEventArgs) => void
    onFieldValueWriteReady?: (args: FtFieldValueReadyEventArgs) => void
    onHeadingLineFinished?: (args: FtHeadingLineFinishedEventArgs) => void
    onHeadingLineStarted?: (args: FtHeadingLineStartedEventArgs) => void
    onRecordFinished?: (args: FtRecordFinishedEventArgs) => void
    onRecordStarted?: (args: FtRecordStartedEventArgs) => void
    onSequenceRedirected?: (args: FtSequenceRedirectedEventArgs) => void
    CarriageReturnChar: "\r" = CharReader.CarriageReturnChar
    CarriageReturnLineFeedString: "\r\n" = CharReader.CarriageReturnLineFeedString
    LineFeedChar: "\n" = CharReader.LineFeedChar
    PrefixSpaceChar: " " = ' '
    Signature: "|!Fielded Text^|" = CharReader.Signature
    VersionLabel: "Version" = 'Version'
    VersionMajor: 1
    VersionMinor: 1
    VersionSeparator: "." = '.'

    • Set a boolean field.

      Parameters

      • idx: number

        The 0-based index of the field to set.

      • value: boolean | null

        The value to set for the field. Can be null to set the field to null.

      Returns void

    • Set a DateTime field's value.

      Parameters

      • idx: number

        The 0-based index of the field to set.

      • value: Date | null

        The value to set for the field. Can be null to set the field to null.

      Returns void

    • Set a decimal field.

      Parameters

      • idx: number

        The 0-based index of the field to set.

      • value: number | null

        The value to set for the field. Can be null to set the field to null.

      Returns void

    • Set a field value by index. Accepts null to set the field to null.

      Parameters

      • idx: number

        The 0-based index of the field to set.

      • value: FtField.Value | null

        The value to set for the field. Can be null to set the field to null.

      Returns void

      FtTypeError if the value being set is not of the field's expected type.

    • Set a field value by name.

      Parameters

      • name: string

        The name of the field to set.

      • value: FtField.Value | null

        The value to set for the field. Can be null to set the field to null.

      Returns void

      FtTypeError if the value being set is not of the field's expected type.

    • Set a float field.

      Parameters

      • idx: number

        The 0-based index of the field to set.

      • value: number | null

        The value to set for the field. Can be null to set the field to null.

      Returns void

    • Set an integer field.

      Parameters

      • idx: number

        The 0-based index of the field to set.

      • value: number | bigint | null

        The value to set for the field. Can be null to set the field to null.

      Returns void

    • Set a string field.

      Parameters

      • idx: number

        The 0-based index of the field to set.

      • value: string | null

        The value to set for the field. Can be null to set the field to null.

      Returns void

    • Set multiple field values.

      Parameters

      • values: (FtField.Value | null)[]

        An array of values to set for the fields. The length of the array must not exceed the number of fields. Array elements can be null to set the corresponding field to null.

      Returns void

      FtTypeError if any of the values being set is not of the corresponding field's expected type.

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Accessors
    Methods