Class FtField`Abstract`

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

Hierarchy (View Summary)

FtField
- FtGenericField

Index

Constructors

Properties

quoted sequenceRedirectEvent valueAssigned IGNORED_SEQUENCE_INVOKATION_DELAY NO_FIELDS_AFFECTED_INDEX

Accessors

Constructors

`Protected`constructor

new FtField(
    sequenceInvokation: FtSequenceInvokation,
    sequenceItem: FtSequenceItem,
    valueTextNullTrimmable: boolean,
): FtField
Parameters
- sequenceInvokation: FtSequenceInvokation
- sequenceItem: FtSequenceItem
- valueTextNullTrimmable: boolean
Returns FtField
- Defined in lib/src/fields/instances/ft-field.ts:53

Properties

`Protected`quoted

quoted: boolean = false

sequenceRedirectEvent

sequenceRedirectEvent: FtSequenceRedirectDelegate | undefined

`Protected`valueAssigned

valueAssigned: boolean = false

`Protected` `Static` `Readonly`IGNORED_SEQUENCE_INVOKATION_DELAY

IGNORED_SEQUENCE_INVOKATION_DELAY: "AfterSequence" = FtSequenceInvokationDelay.AfterSequence

`Static` `Readonly`NO_FIELDS_AFFECTED_INDEX

NO_FIELDS_AFFECTED_INDEX: -1

Accessors

asBigInt

get asBigInt(): bigint
Returns bigint
- Defined in lib/src/fields/instances/ft-field.ts:324
set asBigInt(value: bigint): void
Parameters
- value: bigint
Returns void
- Defined in lib/src/fields/instances/ft-field.ts:328

asBoolean

get asBoolean(): boolean
Returns boolean
- Defined in lib/src/fields/instances/ft-field.ts:308
set asBoolean(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in lib/src/fields/instances/ft-field.ts:312

asDateTime

get asDateTime(): Date
Returns Date
- Defined in lib/src/fields/instances/ft-field.ts:340
set asDateTime(value: Date): void
Parameters
- value: Date
Returns void
- Defined in lib/src/fields/instances/ft-field.ts:344

asDecimal

get asDecimal(): number
Returns number
- Defined in lib/src/fields/instances/ft-field.ts:348
set asDecimal(value: number): void
Parameters
- value: number
Returns void
- Defined in lib/src/fields/instances/ft-field.ts:352

asFloat

get asFloat(): number
Returns number
- Defined in lib/src/fields/instances/ft-field.ts:332
set asFloat(value: number): void
Parameters
- value: number
Returns void
- Defined in lib/src/fields/instances/ft-field.ts:336

asInteger

get asInteger(): number
Returns number
- Defined in lib/src/fields/instances/ft-field.ts:316
set asInteger(value: number): void
Parameters
- value: number
Returns void
- Defined in lib/src/fields/instances/ft-field.ts:320

asNullableBigInt

get asNullableBigInt(): bigint | null
Returns bigint | null
- Defined in lib/src/fields/instances/ft-field.ts:381
set asNullableBigInt(value: bigint | null): void
Parameters
- value: bigint | null
Returns void
- Defined in lib/src/fields/instances/ft-field.ts:385

asNullableBoolean

get asNullableBoolean(): boolean | null
Returns boolean | null
- Defined in lib/src/fields/instances/ft-field.ts:357
set asNullableBoolean(value: boolean | null): void
Parameters
- value: boolean | null
Returns void
- Defined in lib/src/fields/instances/ft-field.ts:361

asNullableDateTime

get asNullableDateTime(): Date | null
Returns Date | null
- Defined in lib/src/fields/instances/ft-field.ts:405
set asNullableDateTime(value: Date | null): void
Parameters
- value: Date | null
Returns void
- Defined in lib/src/fields/instances/ft-field.ts:409

asNullableDecimal

get asNullableDecimal(): number | null
Returns number | null
- Defined in lib/src/fields/instances/ft-field.ts:417
set asNullableDecimal(value: number | null): void
Parameters
- value: number | null
Returns void
- Defined in lib/src/fields/instances/ft-field.ts:421

asNullableFloat

get asNullableFloat(): number | null
Returns number | null
- Defined in lib/src/fields/instances/ft-field.ts:393
set asNullableFloat(value: number | null): void
Parameters
- value: number | null
Returns void
- Defined in lib/src/fields/instances/ft-field.ts:397

asNullableInteger

get asNullableInteger(): number | null
Returns number | null
- Defined in lib/src/fields/instances/ft-field.ts:369
set asNullableInteger(value: number | null): void
Parameters
- value: number | null
Returns void
- Defined in lib/src/fields/instances/ft-field.ts:373

asObject

get asObject(): unknown
Returns unknown
- Defined in lib/src/fields/instances/ft-field.ts:292
set asObject(value: unknown): void
Parameters
- value: unknown
Returns void
- Defined in lib/src/fields/instances/ft-field.ts:296

asString

get asString(): string | null
Returns string | null
- Defined in lib/src/fields/instances/ft-field.ts:300
set asString(value: string | null): void
Parameters
- value: string | null
Returns void
- Defined in lib/src/fields/instances/ft-field.ts:304

asValueText

get asValueText(): string | null
Returns string | null
- Defined in lib/src/fields/instances/ft-field.ts:284
set asValueText(value: string | null): void
Parameters
- value: string | null
Returns void
- Defined in lib/src/fields/instances/ft-field.ts:288

constant

get constant(): boolean
Returns boolean
- Defined in lib/src/fields/instances/ft-field.ts:165

culture

get culture(): DotNetLocaleSettings | undefined
Returns DotNetLocaleSettings | undefined
- Defined in lib/src/fields/instances/ft-field.ts:153

dataType

get dataType(): FtDataType
Returns FtDataType
- Defined in lib/src/fields/instances/ft-field.ts:133

definition

get definition(): FtFieldDefinition
Returns FtFieldDefinition
- Defined in lib/src/fields/instances/ft-field.ts:96

definition_

get definition_(): FtFieldDefinition
Returns FtFieldDefinition
- Defined in lib/src/fields/instances/ft-field.ts:76

fixedWidth

get fixedWidth(): boolean
Returns boolean
- Defined in lib/src/fields/instances/ft-field.ts:157

headingAlwaysWriteOptionalQuote

get headingAlwaysWriteOptionalQuote(): boolean
Returns boolean
- Defined in lib/src/fields/instances/ft-field.ts:217

headingConstraint

get headingConstraint(): FtHeadingConstraint
Returns FtHeadingConstraint
- Defined in lib/src/fields/instances/ft-field.ts:209

headingCount

get headingCount(): number
Returns number
- Defined in lib/src/fields/instances/ft-field.ts:116

headingEndOfValueChar

get headingEndOfValueChar(): string
Returns string
- Defined in lib/src/fields/instances/ft-field.ts:245

headingPadAlignment

get headingPadAlignment(): FtPadAlignment
Returns FtPadAlignment
- Defined in lib/src/fields/instances/ft-field.ts:225

headingPadChar

get headingPadChar(): string
Returns string
- Defined in lib/src/fields/instances/ft-field.ts:233

headingPadCharType

get headingPadCharType(): FtPadCharType
Returns FtPadCharType
- Defined in lib/src/fields/instances/ft-field.ts:229

headingQuotedType

get headingQuotedType(): FtQuotedType
Returns FtQuotedType
- Defined in lib/src/fields/instances/ft-field.ts:213

headings

get headings(): string[]
Returns string[]
- Defined in lib/src/fields/instances/ft-field.ts:120

headingTruncateChar

get headingTruncateChar(): string
Returns string
- Defined in lib/src/fields/instances/ft-field.ts:241

headingTruncateType

get headingTruncateType(): FtTruncateType
Returns FtTruncateType
- Defined in lib/src/fields/instances/ft-field.ts:237

headingWritePrefixSpace

get headingWritePrefixSpace(): boolean
Returns boolean
- Defined in lib/src/fields/instances/ft-field.ts:221

id

get id(): number | undefined
Returns number | undefined
- Defined in lib/src/fields/instances/ft-field.ts:137

index

get index(): number
Returns number
- Defined in lib/src/fields/instances/ft-field.ts:80
set index(value: number): void
Parameters
- value: number
Returns void
- Defined in lib/src/fields/instances/ft-field.ts:84

loadedValueText

get loadedValueText(): string
Returns string
- Defined in lib/src/fields/instances/ft-field.ts:128

mainHeadingIndex

get mainHeadingIndex(): number
Returns number
- Defined in lib/src/fields/instances/ft-field.ts:149

metaHeadings

get metaHeadings(): string[]
Returns string[]
- Defined in lib/src/fields/instances/ft-field.ts:145

name

get name(): string
Returns string
- Defined in lib/src/fields/instances/ft-field.ts:141

sequence

get sequence(): FtSequence
Returns FtSequence
- Defined in lib/src/fields/instances/ft-field.ts:100

sequenceInvokation

get sequenceInvokation(): FtSequenceInvokation
Returns FtSequenceInvokation
- Defined in lib/src/fields/instances/ft-field.ts:112

sequenceItem

get sequenceItem(): FtSequenceItem
Returns FtSequenceItem
- Defined in lib/src/fields/instances/ft-field.ts:104

sequenceRedirectList

get sequenceRedirectList(): FtSequenceRedirectList
Returns FtSequenceRedirectList
- Defined in lib/src/fields/instances/ft-field.ts:108

sidelined

get sidelined(): boolean
Returns boolean
- Defined in lib/src/fields/instances/ft-field.ts:88
set sidelined(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in lib/src/fields/instances/ft-field.ts:92

valueAlwaysWriteOptionalQuote

get valueAlwaysWriteOptionalQuote(): boolean
Returns boolean
- Defined in lib/src/fields/instances/ft-field.ts:173

valueAssigned_

get valueAssigned_(): boolean
Returns boolean
- Defined in lib/src/fields/instances/ft-field.ts:124

valueEndOfValueChar

get valueEndOfValueChar(): string
Returns string
- Defined in lib/src/fields/instances/ft-field.ts:201

valueNullChar

get valueNullChar(): string
Returns string
- Defined in lib/src/fields/instances/ft-field.ts:205

valuePadAlignment

get valuePadAlignment(): FtPadAlignment
Returns FtPadAlignment
- Defined in lib/src/fields/instances/ft-field.ts:181

valuePadChar

get valuePadChar(): string
Returns string
- Defined in lib/src/fields/instances/ft-field.ts:189

valuePadCharType

get valuePadCharType(): FtPadCharType
Returns FtPadCharType
- Defined in lib/src/fields/instances/ft-field.ts:185

valueQuotedType

get valueQuotedType(): FtQuotedType
Returns FtQuotedType
- Defined in lib/src/fields/instances/ft-field.ts:169

valueTruncateChar

get valueTruncateChar(): string
Returns string
- Defined in lib/src/fields/instances/ft-field.ts:197

valueTruncateType

get valueTruncateType(): FtTruncateType
Returns FtTruncateType
- Defined in lib/src/fields/instances/ft-field.ts:193

valueType

get valueType(): string
Returns string
- Defined in lib/src/fields/instances/ft-field.ts:249

valueWritePrefixSpace

get valueWritePrefixSpace(): boolean
Returns boolean
- Defined in lib/src/fields/instances/ft-field.ts:177

width

get width(): number
Returns number
- Defined in lib/src/fields/instances/ft-field.ts:161

Methods

`Protected`clearNonConstantNull

clearNonConstantNull(): void
Returns void
- Defined in lib/src/fields/instances/ft-field.ts:627

`Protected` `Abstract`getAsBigInt

getAsBigInt(): bigint
Returns bigint
- Defined in lib/src/fields/instances/ft-field.ts:672

`Protected` `Abstract`getAsBoolean

getAsBoolean(): boolean
Returns boolean
- Defined in lib/src/fields/instances/ft-field.ts:670

`Protected` `Abstract`getAsDateTime

getAsDateTime(): Date
Returns Date
- Defined in lib/src/fields/instances/ft-field.ts:674

`Protected` `Abstract`getAsDecimal

getAsDecimal(): number
Returns number
- Defined in lib/src/fields/instances/ft-field.ts:675

`Protected` `Abstract`getAsFloat

getAsFloat(): number
Returns number
- Defined in lib/src/fields/instances/ft-field.ts:673

`Protected` `Abstract`getAsInteger

getAsInteger(): number
Returns number
- Defined in lib/src/fields/instances/ft-field.ts:671

`Protected` `Abstract`getAsNonNullObject

getAsNonNullObject(): unknown
Returns unknown
- Defined in lib/src/fields/instances/ft-field.ts:668

`Protected` `Abstract`getAsNonNullString

getAsNonNullString(): string
Returns string
- Defined in lib/src/fields/instances/ft-field.ts:669

`Protected` `Abstract`getAsNonNullValueText

getAsNonNullValueText(): string
Returns string
- Defined in lib/src/fields/instances/ft-field.ts:665

`Protected` `Abstract`getAsRedirectBoolean

getAsRedirectBoolean(): boolean
Returns boolean
- Defined in lib/src/fields/instances/ft-field.ts:686

`Protected` `Abstract`getAsRedirectDateTime

getAsRedirectDateTime(): Date
Returns Date
- Defined in lib/src/fields/instances/ft-field.ts:689

`Protected` `Abstract`getAsRedirectDecimal

getAsRedirectDecimal(): number
Returns number
- Defined in lib/src/fields/instances/ft-field.ts:690

`Protected` `Abstract`getAsRedirectFloat

getAsRedirectFloat(): number
Returns number
- Defined in lib/src/fields/instances/ft-field.ts:688

`Protected` `Abstract`getAsRedirectInteger

getAsRedirectInteger(): bigint
Returns bigint
- Defined in lib/src/fields/instances/ft-field.ts:687

isNull

isNull(): boolean
Returns boolean
- Defined in lib/src/fields/instances/ft-field.ts:430

loadHeading

loadHeading(idx: number, headingText: string): void
Parameters
- idx: number
- headingText: string
Returns void
- Defined in lib/src/fields/instances/ft-field.ts:451

loadHeadings

loadHeadings(value: string[]): void
Parameters
- value: string[]
Returns void
- Defined in lib/src/fields/instances/ft-field.ts:445

`Protected` `Abstract`loadNonNullValue

loadNonNullValue(valueText: string): void
Parameters
- valueText: string
Returns void
- Defined in lib/src/fields/instances/ft-field.ts:666

`Protected`onSequenceRedirect

onSequenceRedirect(
sequence: FtSequence | undefined,
delay: FtSequenceInvokationDelay,
): number
Parameters
- sequence: FtSequence | undefined
- delay: FtSequenceInvokationDelay
Returns number
- Defined in lib/src/fields/instances/ft-field.ts:619

`Protected` `Abstract`setAsBigInt

setAsBigInt(newValue: bigint): void
Parameters
- newValue: bigint
Returns void
- Defined in lib/src/fields/instances/ft-field.ts:681

`Protected` `Abstract`setAsBoolean

setAsBoolean(newValue: boolean): void
Parameters
- newValue: boolean
Returns void
- Defined in lib/src/fields/instances/ft-field.ts:679

`Protected` `Abstract`setAsDateTime

setAsDateTime(newValue: Date): void
Parameters
- newValue: Date
Returns void
- Defined in lib/src/fields/instances/ft-field.ts:683

`Protected` `Abstract`setAsDecimal

setAsDecimal(newValue: number): void
Parameters
- newValue: number
Returns void
- Defined in lib/src/fields/instances/ft-field.ts:684

`Protected` `Abstract`setAsFloat

setAsFloat(newValue: number): void
Parameters
- newValue: number
Returns void
- Defined in lib/src/fields/instances/ft-field.ts:682

`Protected` `Abstract`setAsInteger

setAsInteger(newValue: number): void
Parameters
- newValue: number
Returns void
- Defined in lib/src/fields/instances/ft-field.ts:680

`Protected` `Abstract`setAsNonNullObject

setAsNonNullObject(newValue: unknown): void
Parameters
- newValue: unknown
Returns void
- Defined in lib/src/fields/instances/ft-field.ts:677

`Protected` `Abstract`setAsNonNullString

setAsNonNullString(newValue: string): void
Parameters
- newValue: string
Returns void
- Defined in lib/src/fields/instances/ft-field.ts:678

setNull

setNull(): number
Returns number
- Defined in lib/src/fields/instances/ft-field.ts:434