FieldedText TypeScript Library
    Preparing search index...

    Class FtFieldAbstract

    Abstract base class for all field instances. Fields represent runtime field values during reading or writing.

    Hierarchy (View Summary)

    Index
    constructor
    _valueAssigned quoted sequenceRedirectEvent IGNORED_SEQUENCE_INVOKATION_DELAY NO_FIELDS_AFFECTED_INDEX
    asBigInt asBoolean asDateTime asDecimal asFloat asInteger asNullableBigInt asNullableBoolean asNullableDateTime asNullableDecimal asNullableFloat asNullableInteger asNullableString asString constant culture dataType definition definition_ fixedWidth headingAlwaysWriteOptionalQuote headingConstraint headingCount headingEndOfValueChar headingPadAlignment headingPadChar headingPadCharType headingQuotedType headings headingTruncateChar headingTruncateType headingWritePrefixSpace id index mainHeadingIndex metaHeadings name nullableValue sequence sequenceInvokation sequenceItem sequenceRedirectList sidelined value valueAlwaysWriteOptionalQuote valueAssigned valueEndOfValueChar valueNullChar valuePadAlignment valuePadChar valuePadCharType valueQuotedType valueText valueTruncateChar valueTruncateType valueType valueWritePrefixSpace width
    clearNonConstantNull formatValue getAsBigInt getAsBoolean getAsDateTime getAsDecimal getAsFloat getAsInteger getAsRedirectBoolean getAsRedirectDateTime getAsRedirectDecimal getAsRedirectFloat getAsRedirectInteger getAsString getValue isNull loadHeading loadHeadings loadValueFromText loadValueText onSequenceRedirect setAsBigInt setAsBoolean setAsDateTime setAsDecimal setAsFloat setAsInteger setAsString setNull setValue

    Protected_valueAssigned

    _valueAssigned: boolean = false
    quoted: boolean = false
    sequenceRedirectEvent: FtSequenceRedirectDelegate | undefined
    IGNORED_SEQUENCE_INVOKATION_DELAY: "AfterSequence" = FtSequenceInvokationDelay.AfterSequence
    NO_FIELDS_AFFECTED_INDEX: -1

    definition_

    • Formats the field value to a string.

      The formatting includes data type formatting but not text formatting such as quoting, padding, truncating etc. This formatted string typically is identical to the string value in the field's valueText property (unless the field value has been modified after loading).

      Returns string

    • Loads a heading into one of the field's heading lines.

      The heading is loaded according to the field's heading constraint.

      Parameters

      • idx: number

        Index of the heading to load.

      • headingText: string

        Text of the heading.

      Returns void

    • Loads the field headings from an array of strings.

      The headings are loaded according to the field's heading constraint. See loadHeading for more information.

      Parameters

      • value: string[]

        An array of headings. The length of the array should be equal to headingCount. Extra headings are ignored and missing headings are set to empty strings.

      Returns void

    • Loads the field value from its formatted text representation.

      Parameters

      • valueText: string

        Formatted text representation of field value. Formatting only includes data type formatting and not text formatting such as quoting, padding, truncating etc.

      Returns void

    • Sets the field value to null.

      Checks for sequence redirects that may be triggered by setting the field to null.

      Returns number

      If this setting of field to null caused a sequence redirect, returns the index of the first field affected by the redirect. If no redirect occurred, returns FtField.NO_FIELDS_AFFECTED_INDEX.

      Error if the field is constant and cannot be set to null.

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Accessors
    Methods