Description
Project, project suite and keyword test variables of the Table type store two-dimensional arrays. The ColumnName property returns the name of a column belonging to the array TableVariable provides access to.
Declaration
TableVariableObj.ColumnName(Index)
| Read-Only Property | Integer |
| TableVariableObj | An expression, variable or parameter that specifies a reference to a TableVariable object | |||
| Index | [in] | Required | Integer | |
Applies To
The property is applied to the following object:
Parameters
The property has the following parameter:
Index
Specifies the index of the column whose name you want to obtain. The index is zero-based, that is, the first column has index 0, the second - 1, the third - 2, and so on. The total number of columns is specified by the ColumnCount property.
If the specified column does not exist, an error occurs.
Property Value
A string which is the name of the specified column.
Example
The code below demonstrates how you can iterate through the rows of an array stored in a Table variable.
JavaScript, JScript
{
var MyVar, Iterator, ColName, value;
MyVar = Project.Variables.MyTableVar;
Iterator = MyVar.Iterator;
// Initializes the iterator
Iterator.Reset();
// Iterates through the rows
while (!Iterator.IsEOF())
{
// Returns the column name by its index
ColName = MyVar.ColumnName(1);
// Retrieves values and posts them to the log
value = Iterator.Value(ColName);
Log.Message(value);
// Forwards the iterator to the next row
Iterator.Next();
}
}
Python
def Test1():
MyVar = Project.Variables.MyTableVar
Iterator = MyVar.Iterator
# Initializes the iterator
Iterator.Reset()
# Iterates through the rows
while not Iterator.IsEOF():
# Returns the column name by its index
ColName = MyVar.ColumnName[1]
# Retrieves values and posts them to the log
value = Iterator.Value[ColName]
Log.Message(value)
# Forwards the iterator to the next row
Iterator.Next()VBScript
Set MyVar = Project.Variables.MyTableVar
Set Iterator = MyVar.Iterator
' Initializes the iterator
Call Iterator.Reset
' Iterates through the rows
While Not Iterator.IsEOF
' Returns the column name by its index
Set ColName = MyVar.ColumnName(1)
' Retrieves values and posts them to the log
value = Iterator.Value(ColName)
Log.Message(value)
' Forwards the iterator to the next row
Iterator.Next
WEnd
End Sub
DelphiScript
var
MyVar, Iterator, ColName, value: OleVariant;
begin
MyVar := Project.Variables.MyTableVar;
Iterator := MyVar.Iterator;
// Initializes the iterator
Iterator.Reset();
// Iterates through the rows
while not Iterator.IsEOF()do
begin
//Returns the column name by its index
ColName := MyVar.ColumnName(1);
// Retrieves values and posts them to the log
value := Iterator.Value[ColName];
Log.Message(value);
// Forwards the iterator to the next row
Iterator.Next();
end;
end;
C++Script, C#Script
{
var MyVar, Iterator, ColName, value;
MyVar = Project["Variables"]["MyTableVar"];
Iterator = MyVar["Iterator"];
// Initializes the iterator
Iterator["Reset"]();
// Iterates through the rows
while (!Iterator["IsEOF"]())
{
// Returns the column name by its index
ColName = MyVar["ColumnName"](1);
// Retrieves values and posts them to the log
value = Iterator["Value"](ColName);
Log["Message"](value);
// Forwards the iterator to the next row
Iterator["Next"]();
}
}
See Also
Variables of the Table Type
AddColumn Method
RemoveColumn Method
ColumnCount Property