PageSubmitArgs type

Important

The finance and operations (Dynamics 365) mobile app and platform are no longer supported. The platform components supporting the mobile app will be removed in a future update. The mobile app has also been removed from app stores. Previously installed instances of the app will continue to work. For more information, see Removed or deprecated platform features.

Args supplied to the OnSubmit event of the page.

Hierarchy

PageSubmitArgs

Index

Properties

• dataValues
• sender

Methods

• addMessage
• cancel
• getMessages
• isCancelled
• wait

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