PageSubmitArgs Type

Args supplied to the OnSubmit event of the page.

Hierarchy

PageSubmitArgs

Index

Properties

Methods

Properties

dataValues

dataValues: any

Get the payload of the submit action.

sender

sender: Page

Get the sender page instance of the submit action.

Methods

addMessage

addMessage(message: string, type: any): any

Add a validation/error message to be displayed.

Parameters

Name Type Description
message string
type any

Returns any

cancel

cancel(): any

Prevent the action from submitting.

Returns any

getMessages

getMessages(): string [ ]

Get all previously added messages

Returns string [ ]

isCancelled

isCancelled(): boolean

Check if the submit action is cancelled.

Returns boolean

wait

wait(promise: Promise <any>): any

Wait on a given promise before continuing with the submission. All promises attached via wait must resolve before the submit action is performed.

Parameters

Name Type Description
promise Promise <any>

Returns any