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 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

The following example uses the Name method to return the name of the newly created parameter in the run-time data table and writes it in the report.

Dim paramname 
paramname = DataTable.LocalSheet.AddParameter("Food", "pizza").Name 
Reporter.ReportEvent 1, "The New Parameter name is", paramname

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

The following example uses the RawValue property to find the formula used in the current row of the Date column in the ActionA sheet of the run-time data table. The statement below returns the value: =NOW()

FormulaVal=DataTable.GetSheet("ActionA").GetParameter("Date").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

The following example uses the Value property to set the value in the current row of the Destination parameter (column) in the "ActionA" sheet of the run-time data table.

DataTable.GetSheet("ActionA").GetParameter("Destination").Value="New York"

Note: You could omit the word Value in the statement above, because Value is the default property for the DTParameter object.

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.)

The following example uses the ValueByRow property to find the value in the 4th row of the Destination parameter (column) in the "ActionA" sheet of the run-time data table.

DataTable.GetSheet("ActionA").GetParameter("Destination").ValueByRow(4)

Back to top

See also: