Class FtDateTimeField

Field for DateTime values.

Hierarchy (View Summary)

FtGenericField<Date>
- FtDateTimeField

Index

Constructors

constructor

new FtDateTimeField(
    sequenceInvokation: FtSequenceInvokation,
    sequenceItem: FtSequenceItem,
    definition: FtDateTimeFieldDefinition,
): FtDateTimeField
Parameters
- sequenceInvokation: FtSequenceInvokation
- sequenceItem: FtSequenceItem
- definition: FtDateTimeFieldDefinition
Returns FtDateTimeField
Overrides FtGenericField.constructor
- Defined in lib/src/fields/instances/ft-date-time-field.ts:13

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
Inherited from FtGenericField.asBigInt
- Defined in lib/src/fields/instances/ft-field.ts:324
set asBigInt(value: bigint): void
Parameters
- value: bigint
Returns void
Inherited from FtGenericField.asBigInt
- Defined in lib/src/fields/instances/ft-field.ts:328

asBoolean

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

asDateTime

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

asDecimal

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

asFloat

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

asInteger

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

asNullableBigInt

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

asNullableBoolean

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

asNullableDateTime

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

asNullableDecimal

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

asNullableFloat

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

asNullableInteger

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

asObject

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

asString

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

asValueText

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

constant

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

culture

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

dataType

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

definition

get definition(): FtDateTimeFieldDefinition
Returns FtDateTimeFieldDefinition
Overrides FtGenericField.definition
- Defined in lib/src/fields/instances/ft-date-time-field.ts:17

definition_

get definition_(): FtGenericFieldDefinition<T>
Returns FtGenericFieldDefinition<T>
Inherited from FtGenericField.definition_
- Defined in lib/src/fields/instances/ft-generic-field.ts:33

fixedWidth

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

format

get format(): string
Returns string
- Defined in lib/src/fields/instances/ft-date-time-field.ts:21

headingAlwaysWriteOptionalQuote

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

headingConstraint

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

headingCount

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

headingEndOfValueChar

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

headingPadAlignment

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

headingPadChar

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

headingPadCharType

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

headingQuotedType

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

headings

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

headingTruncateChar

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

headingTruncateType

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

headingWritePrefixSpace

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

id

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

index

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

loadedValueText

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

mainHeadingIndex

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

metaHeadings

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

name

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

nullableValue

get nullableValue(): Date | null
Returns Date | null
- Defined in lib/src/fields/instances/ft-date-time-field.ts:29
set nullableValue(value: Date | null): void
Parameters
- value: Date | null
Returns void
- Defined in lib/src/fields/instances/ft-date-time-field.ts:33

sequence

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

sequenceInvokation

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

sequenceItem

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

sequenceRedirectList

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

sidelined

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

styles

get styles(): number
Returns number
- Defined in lib/src/fields/instances/ft-date-time-field.ts:25

value

get value(): T
Returns T
Inherited from FtGenericField.value
- Defined in lib/src/fields/instances/ft-generic-field.ts:37
set value(val: T): void
Parameters
- val: T
Returns void
Inherited from FtGenericField.value
- Defined in lib/src/fields/instances/ft-generic-field.ts:41

valueAlwaysWriteOptionalQuote

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

valueAssigned_

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

valueEndOfValueChar

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

valueNullChar

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

valuePadAlignment

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

valuePadChar

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

valuePadCharType

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

valueQuotedType

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

valueTruncateChar

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

valueTruncateType

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

valueType

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

valueWritePrefixSpace

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

width

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

Methods

`Protected`clearNonConstantNull

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

`Protected`getAsBigInt

getAsBigInt(): bigint
Returns bigint
Inherited from FtGenericField.getAsBigInt
- Defined in lib/src/fields/instances/ft-generic-field.ts:81

`Protected`getAsBoolean

getAsBoolean(): boolean
Returns boolean
Inherited from FtGenericField.getAsBoolean
- Defined in lib/src/fields/instances/ft-generic-field.ts:73

`Protected`getAsDateTime

getAsDateTime(): Date
Returns Date
Inherited from FtGenericField.getAsDateTime
- Defined in lib/src/fields/instances/ft-generic-field.ts:92

`Protected`getAsDecimal

getAsDecimal(): number
Returns number
Inherited from FtGenericField.getAsDecimal
- Defined in lib/src/fields/instances/ft-generic-field.ts:99

`Protected`getAsFloat

getAsFloat(): number
Returns number
Inherited from FtGenericField.getAsFloat
- Defined in lib/src/fields/instances/ft-generic-field.ts:88

`Protected`getAsInteger

getAsInteger(): number
Returns number
Inherited from FtGenericField.getAsInteger
- Defined in lib/src/fields/instances/ft-generic-field.ts:77

`Protected`getAsNonNullObject

getAsNonNullObject(): unknown
Returns unknown
Inherited from FtGenericField.getAsNonNullObject
- Defined in lib/src/fields/instances/ft-generic-field.ts:65

`Protected`getAsNonNullString

getAsNonNullString(): string
Returns string
Inherited from FtGenericField.getAsNonNullString
- Defined in lib/src/fields/instances/ft-generic-field.ts:69

`Protected`getAsNonNullValueText

getAsNonNullValueText(): string
Returns string
Inherited from FtGenericField.getAsNonNullValueText
- Defined in lib/src/fields/instances/ft-generic-field.ts:56

`Protected`getAsRedirectBoolean

getAsRedirectBoolean(): boolean
Returns boolean
Inherited from FtGenericField.getAsRedirectBoolean
- Defined in lib/src/fields/instances/ft-generic-field.ts:135

`Protected`getAsRedirectDateTime

getAsRedirectDateTime(): Date
Returns Date
Inherited from FtGenericField.getAsRedirectDateTime
- Defined in lib/src/fields/instances/ft-generic-field.ts:150

`Protected`getAsRedirectDecimal

getAsRedirectDecimal(): number
Returns number
Inherited from FtGenericField.getAsRedirectDecimal
- Defined in lib/src/fields/instances/ft-generic-field.ts:157

`Protected`getAsRedirectFloat

getAsRedirectFloat(): number
Returns number
Inherited from FtGenericField.getAsRedirectFloat
- Defined in lib/src/fields/instances/ft-generic-field.ts:146

`Protected`getAsRedirectInteger

getAsRedirectInteger(): bigint
Returns bigint
Inherited from FtGenericField.getAsRedirectInteger
- Defined in lib/src/fields/instances/ft-generic-field.ts:139

isNull

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

`Protected`isValueEqual

isValueEqual(left: Date, right: Date): boolean
Check if two values are equal.
Parameters
- left: Date
  Left value
- right: Date
  Right value
Returns boolean
true if values are equal
Overrides FtGenericField.isValueEqual
- Defined in lib/src/fields/instances/ft-date-time-field.ts:41

loadHeading

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

loadHeadings

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

`Protected`loadNonNullValue

loadNonNullValue(valueText: string): void
Parameters
- valueText: string
Returns void
Inherited from FtGenericField.loadNonNullValue
- Defined in lib/src/fields/instances/ft-generic-field.ts:161

`Protected`onSequenceRedirect

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

`Protected`setAsBigInt

setAsBigInt(newValue: bigint): void
Parameters
- newValue: bigint
Returns void
Inherited from FtGenericField.setAsBigInt
- Defined in lib/src/fields/instances/ft-generic-field.ts:119

`Protected`setAsBoolean

setAsBoolean(newValue: boolean): void
Parameters
- newValue: boolean
Returns void
Inherited from FtGenericField.setAsBoolean
- Defined in lib/src/fields/instances/ft-generic-field.ts:111

`Protected`setAsDateTime

setAsDateTime(newValue: Date): void
Parameters
- newValue: Date
Returns void
Inherited from FtGenericField.setAsDateTime
- Defined in lib/src/fields/instances/ft-generic-field.ts:127

`Protected`setAsDecimal

setAsDecimal(newValue: number): void
Parameters
- newValue: number
Returns void
Inherited from FtGenericField.setAsDecimal
- Defined in lib/src/fields/instances/ft-generic-field.ts:131

`Protected`setAsFloat

setAsFloat(newValue: number): void
Parameters
- newValue: number
Returns void
Inherited from FtGenericField.setAsFloat
- Defined in lib/src/fields/instances/ft-generic-field.ts:123

`Protected`setAsInteger

setAsInteger(newValue: number): void
Parameters
- newValue: number
Returns void
Inherited from FtGenericField.setAsInteger
- Defined in lib/src/fields/instances/ft-generic-field.ts:115

`Protected`setAsNonNullObject

setAsNonNullObject(newValue: unknown): void
Parameters
- newValue: unknown
Returns void
Inherited from FtGenericField.setAsNonNullObject
- Defined in lib/src/fields/instances/ft-generic-field.ts:103

`Protected`setAsNonNullString

setAsNonNullString(newValue: string): void
Parameters
- newValue: string
Returns void
Inherited from FtGenericField.setAsNonNullString
- Defined in lib/src/fields/instances/ft-generic-field.ts:107

setNull

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

setValue

setValue(val: Date): number
Parameters
- val: Date
Returns number
Inherited from FtGenericField.setValue
- Defined in lib/src/fields/instances/ft-generic-field.ts:45

Class FtDateTimeField

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns FtDateTimeField

Properties

Protectedquoted

sequenceRedirectEvent

ProtectedvalueAssigned

Protected Static ReadonlyIGNORED_SEQUENCE_INVOKATION_DELAY

Static ReadonlyNO_FIELDS_AFFECTED_INDEX

Accessors

asBigInt

Returns bigint

Parameters

Returns void

asBoolean

Returns boolean

Parameters

Returns void

asDateTime

Returns Date

Parameters

Returns void

asDecimal

Returns number

Parameters

Returns void

asFloat

Returns number

Parameters

Returns void

asInteger

Returns number

Parameters

Returns void

asNullableBigInt

Returns bigint | null

Parameters

Returns void

asNullableBoolean

Returns boolean | null

Parameters

Returns void

asNullableDateTime

Returns Date | null

Parameters

Returns void

asNullableDecimal

Returns number | null

Parameters

Returns void

asNullableFloat

Returns number | null

Parameters

Returns void

asNullableInteger

Returns number | null

Parameters

Returns void

asObject

Returns unknown

Parameters

Returns void

asString

Returns string | null

Parameters

Returns void

asValueText

Returns string | null

Parameters

Returns void

constant

Returns boolean

`Protected`quoted

`Protected`valueAssigned

`Protected` `Static` `Readonly`IGNORED_SEQUENCE_INVOKATION_DELAY

`Static` `Readonly`NO_FIELDS_AFFECTED_INDEX