BBjAPI::setClientProperty

Description

In BBj 7.0 and higher, this method sets a property's value in the interpreter to the specified java.lang.Object.

Syntax

Return Value

Method

void

setClientProperty(string propertyName, object value)

Parameters

Variable

Description

property name

The name of the property.

value

The java.lang.Object value for the property.

Return Value

None.

Remarks

Property names are case sensitive. Puts the object into the client properties so that it can be retrieved later using getClientProperty(). This is most commonly used for passing information from one type of trigger to another. For example, use setClientProperty and getClientProperty to set a property in the before write trigger and later retrieve that value during the after write trigger.

Example

rem 'Set a property in the interpreter.

BBjAPI.setClientProperty("myApp.myProperty", "The Value")

rem 'Now retrieve the value
myObj! = BBjAPI.getClientProperty("myApp.myProperty")

See Also

BBjAPI

Object Variables

See the BBj Object Diagram for an illustration of the relationship between BBj Objects.