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 NameThe name of the parameter (column) in the run-time data table.
Method NumberFormatThe format in which the parameter value is expressed.
Method RawValueThe raw value of the cell in the current row of the parameter in the run-time data table
ValueRetrieves or sets the value of the cell in the current (active) row of the parameter in the run-time data table.
ValueByRowRetrieves 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

NumberFormat Property

Description

The format in which the parameter value is expressed. The values of this property are all formats supported by Excel.

Syntax

DTParameter.NumberFormat

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.

Syntax

To find the value:

DTParameter.Value or DTParameter

To set the value:

DTParameter.Value=newvalue or DTParameter=newvalue

IMPORTANT

The values returned by this property follow the rules below:

  • If the cell contains a formula, this property returns the computed value of the formula.

  • For a Boolean value, the property returns True or False, similar to Excel.

    For large numbers stored in scientific notation, the actual value of the number is returned, similar to Excel.

    Note: In releases earlier than 2021, Boolean values were returned as TRUE or FALSE, and large numbers stored in scientific notation were returned in their scientific notation.

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: