ObjProperty

You can use this function for Optiva Workflows, Copy Methods, and Equations.

Purpose

Retrieves a field from the database and places it in a local variable. You can also use this function to retrieve an array of data.

Syntax for ObjProperty is more complex than other functions. To clarify the documentation, the syntax and examples are identical in Workflow, Copy Method and Equations. Therefore, only the Workflow instance is shown unless an example is specific to Copy Method or Equation.

Syntax for header data


Dim variable As Object = ObjProperty(PropertyName,[Symbol,Object,RowKey, ColumnKey])

Arguments

You can use the Validation form to find the arguments for this function.

  • Identify the property by looking at the VALIDATION_CODE, VALIDATION_SUBCODE, and FIELD_NAME columns.
  • Look at the VALIDATION_SUBCODE column for the selected property to determine the arguments of this function.

Description

ObjProperty retrieves the value of an object and places it in a local variable. Use this function to gather values for other statements.

You can also use it in conjunction with IsBlank to check if a field value is null before retrieving it.

To use Option Strict On and Option Strict Off with ObjProperty, see Data type returns with Strict On and Strict Off.

Workflow examples that follow also apply to copy methods and equations.