ITsUserData.Data

Syntax

Data(Id: String): Variant;

Parameters

Id. Element identifier with user information.

Description

The Data property determines any user information and saves it to element with the specified identifier.

Comments

When setting up property to a value, if an element with the specified identifier is not listed, it will be created. If the element already exists, the user information will be updated in it.

When using a custom method for cyclic calculation, the calculation algorithms have the following reserved values as the value of the Id parameter:

Identifier Description
BREAK_CYCLE It determines whether custom method execution must be broken.
Available values:
  • True. Break execution.
  • False. Continue execution.
UNLIMITED_CYCLE It determines whether the number of iteration for custom method execution is not limited.
Available values:
  • True. The number of method execution iterations is not limited.
  • False. The number of iterations can be determined in element with the MAX_ITERATION identifier.
MAX_ITERATION The maximum number of method execution iterations.
CURRENT_ITERATION Number of the current iteration of method execution. On an attempt to change value in the application code cyclic calculation can be broken.
ITERATION_INTERVAL Time interval between iterations in seconds. On an attempt to change value in the application code cyclic calculation can be broken.

Example

The use is given in the example for ITsCalculationContext.UserData.

See also:

ITsUserData