Salesforce

LocateAdd (Magic xpa 2.x)

« Go Back

Information

 
Created ByKnowledge Migration User
Approval Process StatusPublished
Objective
Description

LocateAdd (Magic xpa 2.x)

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

Syntax:

LocateAdd (variable, from, [to])

Parameters:

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

from – From value, according to the variable type.

The string of '' is allowed for all types of variables and indicates that the From value will be ignored.

to – Optional. To value, according to the variable type.

Returns:

  • True – The locate criteria were updated.

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

Note:

  • When this function is used to add some criteria to the locate, then whenever the view is refreshed, the locate will be done according to these criteria.

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

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

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

  • The NULL function can be used as a value. In this case, a null value will be sent.

  • If there are locate criteria added by the LocateAdd function, the value of the Relocate Mode parameter in the View Refresh event will be ignored.

  • The asterisk (*) or question mark (?) characters used in the main source's range or locate is used as a wildcard character. It represents a string of characters. The asterisk and question mark can only be used as the last character in a string.

  • To use the asterisk or question mark as a value in the range or locate, precede the asterisk or question mark with a backslash (\). Since version: 1.9h

Examples:

Examples of range and locate syntax:

  • a* will do the range or locate on a* (where * is a wildcard character)

  • a\* will do the range or locate on a* (where * is a string)

  • a\\ will be a\

  • a\\* will do the range or locate on a\* (where * is a wildcard character)

  • a\b will remain a\b

See also:

LocateReset, RangeAdd

The Online and Rich Client Samples projects (program DV14 and RDV14)

 

Since version:

1.9

 

 

Local data source support – since 2.5

 

Reference
Attachment 
Attachment