Description Property

Applies to TestComplete 14.92, last modified on September 16, 2021

Description

The Description property returns the description of the Table project element that corresponds to the TableObj object. This is the same string that is displayed in the Description edit box of the Table Element editor.

Declaration

TableObj.Description

Read-Only Property String
TableObj An expression, variable or parameter that specifies a reference to a Table object

Applies To

The property is applied to the following object:

Property Value

String that specifies the element’s description.

Example

The following code snippet obtains the name and description of the Table element and posts them to the test log.

JavaScript, JScript

function Test()
{

  var Table, TableName, Description;
  // Obtains the Table object that corresponds to the Table element
  Table = Tables.OrdersTable;

  // Obtains the Table element’s name
  TableName = Table.Name;

  // Obtains the Table element description
  Description = Table.Description;

  // Posts the name and description to the test log
  Log.Message(TableName, Description);

}

Python

def Test():
  # Obtains the Table object that corresponds to the Table element
  Table = Tables.OrdersTable
  # Obtains the Table element's name
  TableName = Table.Name
  # Obtains the Table element description
  Description = Table.Description
  # Posts the name and description to the test log
  Log.Message(TableName, Description)

VBScript

Sub Test

  Dim Table, TableName, Description
  ' Obtains the Table object that corresponds to the Table element
  Set Table = Tables.OrdersTable

  ' Obtains the Table element’s name
  TableName = Table.Name

  ' Obtains the Table element description
  Description = Table.Description

  ' Posts the name and description to the test log
  Call Log.Message(TableName, Description)

End Sub

DelphiScript

procedure Test();
var Table, TableName, Description;
begin

  // Obtains the Table object that corresponds to the Table element
  Table := Tables.OrdersTable;

  // Obtains the Table element’s name
  TableName := Table.Name;

  // Obtains the Table element description
  Description := Table.Description;

  // Posts the name and description to the test log
  Log.Message(TableName, Description);

end;

C++Script, C#Script

function Test()
{

  var Table, TableName, Description;
  // Obtains the Table object that corresponds to the Table element
  Table = Tables["OrdersTable"];

  // Obtains the Table element’s name
  TableName = Table["Name"];

  // Obtains the Table element description
  Description = Table["Description"];

  // Posts the name and description to the test log
  Log["Message"](TableName, Description);

}

See Also

About Table Checkpoints
Name Property

Highlight search results