Skip to main content

Events

The plug-in exposes 6 events that can be bound using Oracle APEX dynamic actions.

Event nameEvent nameTarget
Validation startvalidationstartdocument
Validation endvalidationenddocument
Validation item is validvalidationitemisvalidAPEX item
Validation item is invalidvalidationitemisinvalidAPEX item
Validation column is validvalidationcolumnisvalidInteractive Grid region
Validation column is invalidvalidationcolumnisinvalidInteractive Grid region

Event Data

Each validation event has access to data describing validation state.

Validation start

VariableDescriptionScope
this.data.columnsAn array of column names to be validatedColumn
this.data.recordIdInteractive grid column record idColumn
this.data.regionReference to an interactive grid DOM elementColumn
this.data.itemsAn array of item names to be validatedItem
this.data.affectedElementsAffected elements of the dynamic action responsible for validationItem & Column
this.data.browserEventAn event that executed the dynamic action responsible for validationItem & Column
this.data.triggeringElementTriggering element of the dynamic action responsible for validationItem & Column

Validation end

VariableDescriptionScope
this.data.columnsAn array of column names to be validatedColumn
this.data.recordIdInteractive grid column record idColumn
this.data.regionReference to an interactive grid DOM elementColumn
this.data.itemsAn array of item names to be validatedItem
this.data.affectedElementsAffected elements of the dynamic action responsible for validationItem & Column
this.data.browserEventAn event that executed the dynamic action responsible for validationItem & Column
this.data.errorsAn array of errors returned by a validationItem & Column
this.data.triggeringElementTriggering element of the dynamic action responsible for validationItem & Column

Validation item is valid

This event doesn't expose any data through this.data.

Validation item is invalid

The variable this.data has only the errors property. Errors is an array of validation errors and each entry is described below:

VariableDescription
this.data.errors[i].displayLocationValidation message display location code. Possible values are:

- INLINE_WITH_FIELD_AND_NOTIFICATION,
- INLINE_WITH_FIELD,
- INLINE_IN_NOTIFICATION,
- ON_ERROR_PAGE
this.data.errors[i].itemItem name of the validation that failed
this.data.errors[i].messageValidation failure message

Validation column is valid

VariableDescription
this.data.columnInteractive grid validated column name
this.data.recordIdInteractive grid validated column record ID (PK)

Validation column is invalid

VariableDescription
this.data.columnInteractive grid validated column name
this.data.errorsJavaScript array of column validation errors
this.data.recordIdRecord id (primary key) of the validated column

Each entry of this.data.errors has the properties described below:

VariableDescription
this.data.errors[i].columnInteractive grid validated column name
this.data.errors[i].displayLocationValidation message display location code. Possible values are:

- INLINE_WITH_FIELD_AND_NOTIFICATION,
- INLINE_WITH_FIELD,
- INLINE_IN_NOTIFICATION,
- ON_ERROR_PAGE
this.data.errors[i].messageValidation failure message
this.data.errors[i].recordIdRecord id (primary key) of the validated column