Salesforce

SortAdd (Magic xpa 4.x)

« Go Back

Information

 
Created BySalesforce Service User
Approval Process StatusPublished
Objective
Description

SortAdd (Magic xpa 4.x)

Adds sorting criteria, so that the next time the view is refreshed, the new criteria will be used instead of the sort defined in the task.

Syntax:

SortAdd (variable,ascending)

Parameters:

variable – variable reference. Blob, OLE, Vector, and .NET variables are not supported.

ascending – Logical

Returns:

  • True – the sort criteria were updated.

  • False – illegal sort criteria (such as illegal var index).

Note:

  • When this function is used to add some criteria to the sort, then whenever the view is refreshed, the sort will be done according to these criteria only (instead of the one defined at the task logic or the user clicking on a table).

  • If there are sort criteria added by the SortAdd function, the value of the Keep User Sort parameter in the View Refresh event will be ignored.

  • The variable names should be unique in the data view.

  • The variable sent can be of parent tasks, so the relevant task criteria will be updated.

  • This function can be used several times in order to perform the sort on multiple variables.

See also:

SortReset

The Online and Rich Client Samples projects (program DV15 and RDV15)

Since version: 1.9

Local data source support – Since version: 2.5

Reference
Attachment 
Attachment