DTParameter Object

Description

A parameter (column) in a sheet in the run-time data table. This object is not a built-in utility object, but can be accessed using one of the following methods:

Note: All methods performed on this object apply to the run-time DataTable object only. Changes to the run-time DataTable object are reflected in the run results, but the design-time data table is not affected.

Properties

Method Name The name of the parameter (column) in the run-time data table.
Method RawValue The raw value of the cell in the current row of the parameter in the run-time data table
Value Retrieves or sets the value of the cell in the current (active) row of the parameter in the run-time data table.
ValueByRow Retrieves the value of the cell in the specified row of the parameter in the run-time data table.

Back to top

Name Property

Description

The name of the parameter (column) in the run-time data table.

Syntax

DTParameter.Name

Back to top

RawValue Property

Description

The raw value of the cell in the current row of the parameter in the run-time data table. The raw value is the actual string written in a cell before the cell has been computed, such as the actual text from a formula.

Syntax

DTParameter.RawValue

Back to top

Value Property

Description

Parameter default property. Retrieves or sets the value of the cell in the current (active) row of the parameter in the run-time data table.

Note: This method returns the computed value of the cell. For example, if the cell contains a formula, the method returns True or False.

Syntax

To find the value:

DTParameter.Value or DTParameter

To set the value:

DTParameter.Value=newvalue or DTParameter=newvalue

Back to top

ValueByRow Property

Description

Retrieves the value of the cell in the specified row of the parameter in the run-time data table.

Syntax

DTParameter.ValueByRow(RowNum)

Argument

Type

Description

RowNum

Number

Indicates the row of the parameter that should be returned. (Row numbers start with 1.)

Back to top

See also: