Description
The EnableStackOnImage
property specifies whether TestComplete will track and save the call stack information for each image posted to the test log with the Post Screenshot keyword test operation or Log.Picture
method. The collected data is shown in the Call Stack panel of the test log. Using this information, you can determine the sequence of tests and script routines that led to the execution of the test (or routine) in which the image was posted.
Declaration
CallStackSettingsObj.EnableStackOnImage
Read-Write Property | Boolean |
CallStackSettingsObj | An expression, variable or parameter that specifies a reference to a CallStackSettings object |
Applies To
The property is applied to the following object:
Property Value
True, if TestComplete should collect the call stack information for each image message posted to the log, or false otherwise.
Remarks
By default, the property’s value is false
.
The changes that you make to the call stack settings have effect only during the execution of one test item or one test (if you run the test from the test editor or the Project Explorer panel). When the next test item starts or when you run the test for the next time, the default settings will be used. |
Example
The code below obtains information about the call stack settings, enables collecting the call stack information for the period when an image is being posted to the test log, posts the image to the test log and then disables collecting the call stack information.
JavaScript, JScript
function CallStackSet()
{
// Obtains the call stack settings
var StackSet = Log.CallStackSettings;
// Enables collecting the call stack information for the period
// when an image is being posted to the test log
StackSet.EnableStackOnImage = true;
// ...
var PicObj = Utils.Picture;
PicObj.LoadFromFile("C:\\MyPicture.bmp");
Log.Picture(PicObj);
// ...
// Disables collecting the call stack information
StackSet.EnableStackOnImage = false;
}
Python
def CallStackSet():
# Obtains the call stack settings
StackSet = Log.CallStackSettings
# Enables collecting the call stack information for the period
# when an image is being posted to the test log
StackSet.EnableStackOnImage = True
# ...
PicObj = Utils.Picture
PicObj.LoadFromFile("C:\\MyFiles\\MyPicture.bmp")
Log.Picture(PicObj)
# ...
# Disables collecting the call stack information
StackSet.EnableStackOnImage = False
VBScript
Sub CallStackSet
' Obtains the call stack settings
Set StackSet = Log.CallStackSettings
' Enables collecting the call stack information for the period
' when an image is being posted to the test log
StackSet.EnableStackOnImage = True
' ...
Set PicObj = Utils.Picture
PicObj.LoadFromFile("C:\MyPicture.bmp")
Log.Picture(PicObj)
' ...
' Disables collecting the call stack information
StackSet.EnableStackOnImage = False
End Sub
DelphiScript
function CallStackSet;
var StackSet, PicObj;
begin
// Obtains the call stack settings
StackSet := Log.CallStackSettings;
// Enables collecting the call stack information for the period
// when an image is being posted to the test log
StackSet.EnableStackOnImage := true;
// ...
PicObj := Utils.Picture;
PicObj.LoadFromFile('C:\MyPicture.bmp');
Log.Picture(PicObj);
// ...
// Disables collecting the call stack information
StackSet.EnableStackOnImage := false;
end;
C++Script, C#Script
function CallStackSet()
{
// Obtains the call stack settings
var StackSet = Log["CallStackSettings"];
// Enables collecting the call stack information for the period
// when an image is being posted to the test log
StackSet["EnableStackOnImage"] = true;
// ...
var PicObj = Utils["Picture"];
PicObj["LoadFromFile"]( "C:\\MyPicture.bmp" );
Log["Picture"]( PicObj );
// ...
// Disables collecting the call stack information
StackSet["EnableStackOnImage"] = false;
}
See Also
Post Screenshot Operation
Log.Picture Method
Test Results
Generic Test Log - Call Stack Panel