Difference between revisions of "OtfWatchWindow"

From emotive
Jump to navigation Jump to search
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
 
{{DISPLAYTITLE:Open Test Framework - Watch Window}}[[Category:OTF]]
 
{{DISPLAYTITLE:Open Test Framework - Watch Window}}[[Category:OTF]]
−
==Overview==
 
−
The '''Watch window''' allows for tracking and changing the values of declarations during runtime in the debug mode. This makes debugging some of the complex data types easier. To track and change the value of a declaration when running in debug mode, you first have to add the declaration into the Watch window, see [[#Tracking and changing the value of a declaration|guideline below]]. The Watch window stores all the monitored declarations of the solution. Depending on which procedure is being executed, the corresponding declarations are available for changing or not. The Watch window also allows you to copy the current value of the declaration during debugging.
 
  
−
The Watch is a tool window, so it can be docked, floating, opened, closed, resized or set to auto hide. When starting the OTF the first time, the Watch window is already opened and docked under the [[OtfWorkflowDesigner|Workflow Designer]]. You can open or close it via the "'''Watch window'''" button ("[[File:Watch.png]]") in the [[OtfMenuBar|Ribbon]].
+
== Overview ==
 +
The '''Watch''' window allows for tracking and changing the values of declarations during runtime in the debug mode. This makes debugging some of the complex data types easier. To track and change the value of a declaration when running in debug mode, you first have to add the declaration into the Watch window, see [[#Tracking and changing the value of a declaration|guideline below]]. The Watch window stores all the monitored declarations of the current OTX Solution. Depending on which procedure is being executed, the corresponding declarations are available for being changed or not. The Watch window also allows you to copy the current value of the declaration during debugging.
  
−
{{ImageStyleCenter|WatchWindow.PNG|900|Watch Window allows for monitoring and changing the value of a declaration during debugging.}}
+
The Watch is a tool window, so it can be docked, floating, opened, closed, resized or set to auto hide. When starting the OTF the first time, the Watch window is already opened and docked at the right of the [[OtfSearchResultsWindow|Search Result tool window]] under the [[OtfWorkflowDesigner|Workflow Designer]]. You can open or close it via the "'''Watch window'''" button ("[[File:Watch.png]]") in the [[OtfMenuBar|Ribbon]].
  
−
==Tracking and changing the value of a declaration==
+
 
 +
{{ImageStyleCenter|WatchWindow.PNG|1000|Watch Window allows for monitoring and changing the value of a declaration during debugging.}}
 +
 
 +
== Tracking and Changing the Value of a Declaration ==
 
To track and change the value of a declaration, please proceed as follows:
 
To track and change the value of a declaration, please proceed as follows:
  
−
# Right-click on the declaration in the [[OtfDeclarationExplorer|Declaration Explorer]] tool window and select the menu "'''Add to Watch window'''".
+
# Right-click on the declaration in the [[OtfSolutionExplorer|solution Explorer]] or the [[OtfDeclarationExplorer|Declaration Explorer]] tool window, and select the menu "'''Add to Watch window'''".
−
# Run the current procedure in debug mode (you can use "'''F11'''" key to step into each activity or use "'''F5'''" key to stop at each breakpoint).
+
# Run the current procedure in debug mode (you can use "'''F11'''" or "'''F10'''" key to step at each activity or use "'''F5'''" key to stop at each breakpoint).
−
# When the workflow is halted by stepping into an activity or by a breakpoint, double-click on the "'''Value'''" cell in the row of the corresponding declaration in the Watch window (or select the row and click on the "'''Change value'''" command).
+
# When the workflow is halted by stepping at an activity or by a breakpoint, double-click on the "'''Value'''" cell in the row of the corresponding declaration in the Watch window (or select the row and click on the "'''Change value'''" command).
 
# Input the new value for the declaration.
 
# Input the new value for the declaration.
 
# Press "'''ENTER'''" key or "'''TAB'''" key to set the changes.
 
# Press "'''ENTER'''" key or "'''TAB'''" key to set the changes.
−
# Continue the workflow (with "'''F11'''" key or "'''F5'''" key).
+
# Continue the workflow (with "'''F11'''" or "'''F10'''" or "'''F5'''" key).
−
# When the workflow is halted by stepping into another activity or by another breakpoint again, you can changes the value again or you can copy the current value of the declaration in the "'''Value'''" cell.
+
# When the workflow is halted by stepping at another activity or by another breakpoint again, you can changes the value again or you can copy the current value of the declaration in the corresponding cell in the "'''Value'''" column.
 +
 
 +
{{Note|You can only change the value of the monitored declaration only if the workflow is halted by stepping at an activity or by a breakpoint. The new input value must be correct to the type of the monitored declaration; otherwise, a warning will occur and the changes will have no effect. You can add watch for a constant but you can not change its value during debugging.}}
 +
 
 +
== Watch Window Features ==
 +
 
 +
The Watch window consists of a command bar above and a gridview below. All the monitored declarations (added to Watch window) will be displayed in the
 +
gridview, here you can select one or more declarations using mouse and '''CTRL / SHIFT''' key or using '''CTRL + A'''. The selected declaration can be managed with the buttons in the command bar or with the '''DEL''' key.
 +
 
 +
Below are the buttons on the command bar with their descriptions (according to their positions from left-to-right):
 +
 
 +
{|{{TableHeader}}
 +
|- style="background: gray; color: white; vertical-align:top;'''"
 +
| '''Button''' || '''Description'''
 +
|-{{TableRow2}}
 +
| '''Change value'''{{TooltipIcon2|This button is only enabled when you select at least one changeable declaration.}} || Enables to edit the value of the selected declaration. If you select many declarations, the bottom changeable declaration will be editable.
 +
|-{{TableRow1}}
 +
| '''Up'''{{TooltipIcon2|This button is only enabled when the highest selected declaration is not in the top row.}} || Moves the selected declarations up one row (according to the highest selected declaration).
 +
|-{{TableRow2}}
 +
| '''Down'''{{TooltipIcon2|This button is only enabled when the lowest selected declaration is not in the bottom row.}} ||  Moves the selected declarations down one row (according to the lowest selected declaration).
 +
|-{{TableRow1}}
 +
| '''Select all''' || Selects all the declarations in the gridview (Keyboard shortcut: '''CTRL + A''').
 +
|-{{TableRow2}}
 +
| '''Copy''' || Copies the content in all the cells of the selected declarations to the clipboard (Keyboard shortcut: '''CTRL + C''').
 +
|-{{TableRow1}}
 +
| '''Delete''' || Deletes all the selected declarations (Keyboard shortcut: '''DEL''').
 +
|-{{TableRow2}}
 +
| '''Clear all''' || Deletes all the declarations in the gridview.
 +
|-{{TableRow1}}
 +
| '''Display as Hex''' || Converts and displays the Integer value of the declarations of Integer type in Hexadecimal.
 +
|}
  
−
{{Note|You can only change the value of the monitored declaration only if the workflow is halted by stepping into an activity or by a breakpoint. The changed value must be correct to the type of the monitored declaration; otherwise, a warning will occur and the changes will have no effect. You can add watch for a constant but you can not change its value during debugging.}}
+
{{Note|NOTE: All the changes in the Watch window can not be Undone or Redone. If you rename a declaration or its document / package / project, it will not be updated in the Watch window, you have to delete the old obsolete one and re-add the declaration into the Watch window.}}

Latest revision as of 02:24, 5 October 2018


Overview

The Watch window allows for tracking and changing the values of declarations during runtime in the debug mode. This makes debugging some of the complex data types easier. To track and change the value of a declaration when running in debug mode, you first have to add the declaration into the Watch window, see guideline below. The Watch window stores all the monitored declarations of the current OTX Solution. Depending on which procedure is being executed, the corresponding declarations are available for being changed or not. The Watch window also allows you to copy the current value of the declaration during debugging.

The Watch is a tool window, so it can be docked, floating, opened, closed, resized or set to auto hide. When starting the OTF the first time, the Watch window is already opened and docked at the right of the Search Result tool window under the Workflow Designer. You can open or close it via the "Watch window" button ("Watch.png") in the Ribbon.


WatchWindow.png
Watch Window allows for monitoring and changing the value of a declaration during debugging.

Tracking and Changing the Value of a Declaration

To track and change the value of a declaration, please proceed as follows:

  1. Right-click on the declaration in the solution Explorer or the Declaration Explorer tool window, and select the menu "Add to Watch window".
  2. Run the current procedure in debug mode (you can use "F11" or "F10" key to step at each activity or use "F5" key to stop at each breakpoint).
  3. When the workflow is halted by stepping at an activity or by a breakpoint, double-click on the "Value" cell in the row of the corresponding declaration in the Watch window (or select the row and click on the "Change value" command).
  4. Input the new value for the declaration.
  5. Press "ENTER" key or "TAB" key to set the changes.
  6. Continue the workflow (with "F11" or "F10" or "F5" key).
  7. When the workflow is halted by stepping at another activity or by another breakpoint again, you can changes the value again or you can copy the current value of the declaration in the corresponding cell in the "Value" column.
Icons Note.png You can only change the value of the monitored declaration only if the workflow is halted by stepping at an activity or by a breakpoint. The new input value must be correct to the type of the monitored declaration; otherwise, a warning will occur and the changes will have no effect. You can add watch for a constant but you can not change its value during debugging.

Watch Window Features

The Watch window consists of a command bar above and a gridview below. All the monitored declarations (added to Watch window) will be displayed in the gridview, here you can select one or more declarations using mouse and CTRL / SHIFT key or using CTRL + A. The selected declaration can be managed with the buttons in the command bar or with the DEL key.

Below are the buttons on the command bar with their descriptions (according to their positions from left-to-right):

Button Description
Change valueExclamation.png Enables to edit the value of the selected declaration. If you select many declarations, the bottom changeable declaration will be editable.
UpExclamation.png Moves the selected declarations up one row (according to the highest selected declaration).
DownExclamation.png Moves the selected declarations down one row (according to the lowest selected declaration).
Select all Selects all the declarations in the gridview (Keyboard shortcut: CTRL + A).
Copy Copies the content in all the cells of the selected declarations to the clipboard (Keyboard shortcut: CTRL + C).
Delete Deletes all the selected declarations (Keyboard shortcut: DEL).
Clear all Deletes all the declarations in the gridview.
Display as Hex Converts and displays the Integer value of the declarations of Integer type in Hexadecimal.
Icons Note.png NOTE: All the changes in the Watch window can not be Undone or Redone. If you rename a declaration or its document / package / project, it will not be updated in the Watch window, you have to delete the old obsolete one and re-add the declaration into the Watch window.
Retrieved from "http://emotive.de/wiki/index.php?title=OtfWatchWindow&oldid=7525"