Salesforce

Task Events (Magic xpa 3.x)

« Go Back

Information

 
Created ByKnowledge Migration User
Approval Process StatusPublished
Objective
Description

Task Events (Magic xpa 3.x)

Event Name

Trigger

Action

Default Keyboard Mapping

Samples Projects

Mobile Support

Browser Status Text Change

Change in the value of the Browser control's status bar text

See also Browser Status Text Change.

None

Cancel

Cancels the editing of the current record (undo) and restores all variables to their original values.

The Cancel event will not cancel a record after it is synced, that is, written to the deferred transaction cache.

In Rich Client tasks, when the Cancel event is raised, the Control Verification and Control Suffix logic units are not executed, but the Control Prefix is executed.

Performing Cancel in a task which is not the task in which the transaction starts will cancel that task only.

Canceling a record will re-enter the record and hence perform the Record Prefix logic unit.

Ctrl+F2

EN32, SQ06, REN32, RSQ06

All

Close

Saves the data and exits the current task.

Ctrl+F4

EN17, EN18, REN17, REN18

All

Close Context

Closes the current context or an open context. When this internal event is raised, the normal close task procedure will be executed. This internal event will attempt to close all tasks in the context.

If the context that is to be closed is the “main” context, this will be ignored and an entry will be written to the Activity Monitor.

ES16, RES16

Column Click

The column's title is clicked

If the handler is defined with Propagate=No, then after a user clicks on a column title, the column will not be sorted.

If there are several Column Click event handlers with Propagate=Yes, all are handled.

This event has no effect when raised manually.

HG33, RHG33

Column Filter

Raised when clicking on the filtering icon of a column.

Since version: 3.1

None

When the End User Functionality component is used, a Filter window is opened.

Context Got Focus

A context receives focus

None

EN20

Context Lost Focus

A context loses focus

None

EN20

Control Hit

A control is left-clicked or a Button control is parked on and the Spacebar key is pressed

This event is not supported for Browser Client tasks.

EN16, REN16

Android, iOS

Create Line

Creates a new record.

F4

EN23, REN23

All

Create Records

Changes the task mode to Create mode.

Ctrl+E

EN23, REN23

All

DblClick

Double clicking on a control

EN16, REN16

Delete Line

Deletes the current record.

F3

EN23, REN23

All

Drag Begin

Dragging of a control begins (when the left mouse button is clicked and held down on a control that has the Allow Drag property set to Yes)

For controls where the data is not set automatically, a user-defined handler can be defined to handle the Drag Begin event so that you can handle the task data and affect the drag operation in the following ways:

  • Control the drag operation data by using the DragSetData function

  • Control the drag operation icon by using the DragSetCrsr function

When performing a drag operation on a Table control where the records are marked, a handler written for the Drag Begin event is executed for every marked record.

Note: As of version 1.9, drag-and-drop events are supported for Rich Client form controls.

See also:

How Do I Copy Data Within an Application by Dragging It?

How Do I Drag Data from Magic xpa to External Applications?

HG05, HG40, RHG05, RHG40

Drop

A dragged control is released (where the Allow Drop property has been set to Yes)

A user-defined handler can be defined so that you can handle the task data and affect the drop operation in the following ways:

  • Check if a certain format is supported by the current drag and drop operation using the DropFormat function.

  • Retrieve the data of a defined format using the DropGetData function.

  • Retrieve the Mouse coordinates at the time of the Drop operation using the DropMouseX and DropMouseY functions.

Note: As of version 1.9, drag-and-drop events are supported for Rich Client form controls.

HG05, HG40, RHG05, RHG40

Empty Dataview

Raised when the range of the task does not contain any records.

The event is raised “instead” of the Record Prefix execution. See also EmptyDataview function and Allow Empty Dataview task property.

DV16, RDV16

All

Exit

Saves the data and exits the current task.

Platform specific: On Android devices, this refers to the back key.

Esc

EN17, REN17

All

Help

Opens the Help defined for the current item.

This event is raised implicitly upon activating the Help internal event, by pressing F1 or accessing Help from the Help menu.

F1

EN30, REN30

Index Change

Changes the index of the main data source in a task. Since version: 3.2

Locate a Record

None

When the End User Functionality component is used, a Locate window is opened.

Ctrl+L

Locate Next

Locates the Next Row matching the current locate criteria.

Modify Records

Changes the task mode to Modify mode.

Ctrl+M

EN23, REN23

All

Post Refresh by Parent

Raised in a subform task when the subform is refreshed by the parent. See also Post Refresh by Parent.

RRC12

Program Recall

Raised when a single instance parallel program is called for the second time. When you set a Parallel Execution program to be a Single Instance, this means that when this program is called for the second time, the focus will be set on the already running instance. However, there will be no initialization steps (such as preparing the data view).

The Program Recall internal event will be invoked indicating that the focus was set on the task.

You can raise the View Refresh event within the Program Recall event in order to refresh the called program.

Since version: 2.1

MT10

Query Records

Changes the task mode to Query mode.

Ctrl+Q

EN23, REN23

All

Quit

Cancels the editing of the current record (undo), restores all variables to their original values and exits the task.

The Quit event combines both the Cancel and Exit event and provides an easy way to undo the record updates and close the task.

EN28, REN28

iOS

Range of Records

None

When the End User Functionality component is used, a Range window is opened.

Ctrl+R

Record Flush

Forces writing of the current record to the database. See Record Flush.

SQ05, DV20, RSQ05, RDV20

All

Screen Refresh

Re-reads the data of the visible records. The Runtime engine completely exits the current record, and re-fetches all records according to their positions displayed on the screen. The cursor remains on the current record. See also Data Refresh Events.

This event is currently not supported for local data sources.

Note: If some records that exist on the screen were deleted from the database then:

  • In Online – These records will be removed from the screen.

  • In Rich Client – These records will not be removed from the screen.

If you need to refresh the screen after deleting some records in another process (say by calling a Batch task), it is advised to use the View Refresh event instead.

DV19, RDV19

All

Sort Records

None

When the End User Functionality component is used, a Sort window is opened.

Ctrl+T

Subform Refresh

Performs a view refresh on a subform task. See Subform Refresh.

SB02, RSB02

View Refresh

Re-reads the task data view. See View Refresh.

DV18, RDV18

All

View by Key

Opens the Index list.

Note: This event was deprecated up until version 3.2.

Crl+K

Window Hit

A window is clicked

EH12, REH12

Window Reposition

A window is repositioned

EH12, REH12

Window Resize

A window is resized

EH12, REH12

All

Zoom

When clicking on a push button with no variable that raises the Zoom event, the Zoom event will not be raised.

F5

EN01, EN07, TS16, REN01, REN07, RTS16

Reference
Attachment 
Attachment