Hide

YetaWF.Core Package Documentation

Display
Print

YetaWF.Core.Controllers.ControllerImpl.FormProcessed Method

The page/form was successfully processed. This handles returning to a parent page or displaying a popup if a return page is not available.

Class: YetaWF.Core.Controllers.ControllerImpl
Namespace: YetaWF.Core.Controllers
Assembly: YetaWF.Core

Syntax

protected ActionResult FormProcessed(
    object? model,
    string? popupText = null,
    string? popupTitle = null,
    OnCloseEnum OnClose = OnCloseEnum.Return,
    OnPopupCloseEnum OnPopupClose = OnPopupCloseEnum.ReloadParentPage,
    OnApplyEnum OnApply = OnApplyEnum.ReloadModule,
    string? NextPage = null,
    bool PreserveOriginList = false,
    string? ExtraData = null,
    string? PreSaveJavaScript = null,
    string? PostSaveJavaScript = null,
    bool ForceRedirect = false,
    string? PopupOptions = null,
    bool ForceApply = false,
    bool? PageChanged = null,
    bool ForcePopup = false );

Parameters

model

The model to display.

popupText

A message displayed in a popup. Specify null to suppress the popup.

popupTitle

The title for the popup if a message (popupText) is specified. If null is specified, a default title indicating success is supplied.

OnClose

The action to take when the page is closed. This is only used if a page is closed (as opposed to a popup or when the Apply button was processed).

OnPopupClose

The action to take when a popup is closed. This is only used if a popup is closed (as opposed to a page or when the Apply button was processed).

OnApply

The action to take when the Apply button was processed.

NextPage

The URL where the page is redirected (OnClose or OnPopupClose must request a matching action, otherwise this is ignored).

PreserveOriginList

Preserves the URL origin list. Only supported when NextPage is used.

ExtraData

Additional data added to URL as _extraData argument. Length should be minimal, otherwise URL and Referer header may grow too large.

PreSaveJavaScript

Optional additional Javascript code that is returned as part of the ActionResult and runs before the form is saved.

PostSaveJavaScript

Optional additional Javascript code that is returned as part of the ActionResult and runs after the form is saved.

ForceRedirect

Force a real redirect bypassing Unified Page Set handling.

PopupOptions

TODO: This is not a good option, passes JavaScript/JSON to the client side for the popup window.

ForceApply

Force handling as Apply.

PageChanged

The new page changed status.

ForcePopup

The message is shown as a popup even if toasts are enabled.

Return Value

An ActionResult to be returned by the controller.

See Also YetaWF.Core.Controllers.ControllerImpl ClassYetaWF.Core Overview