# Is there any API Doc for Keysight.OpenTap.Wpf

**URL:** <https://forum.opentap.io/t/is-there-any-api-doc-for-keysight-opentap-wpf/2563>\
**Category:** General\
**Tags:** faq\
**Created:** [August 28, 2025, 7:48am UTC](https://forum.opentap.io/t/is-there-any-api-doc-for-keysight-opentap-wpf/2563 "2025-08-28T07:48:28Z")\
**Posts on this page:** 9\
**Page:** 1

<div class="post-metadata">

**Author:** ![laihesheng](https://avatars.discourse-cdn.com/v4/letter/l/e99b99/32.png) [@laihesheng](https://forum.opentap.io/u/laihesheng)\
**Post date:** [August 28, 2025, 7:48am UTC](https://forum.opentap.io/t/is-there-any-api-doc-for-keysight-opentap-wpf/2563/1 "2025-08-28T07:48:28Z")

</div>

Is there any API documentation for Keysight.OpenTap.Wpf.dll other than the examples in SDK\Examples?

---

<div class="post-metadata">

**Author:** ![rolf\_madsen](https://avatars.discourse-cdn.com/v4/letter/r/43a26b/32.png) [@rolf\_madsen](https://forum.opentap.io/u/rolf_madsen)\
**Post date:** [September 3, 2025, 9:02am UTC](https://forum.opentap.io/t/is-there-any-api-doc-for-keysight-opentap-wpf/2563/2 "2025-09-03T09:02:49Z")

</div>

Hi @laihesheng,

Unfortunately, there is currently no documentation apart from the examples.

Do you have any specific topics you’d like to know about?

---

<div class="post-metadata">

**Author:** ![laihesheng](https://avatars.discourse-cdn.com/v4/letter/l/e99b99/32.png) [@laihesheng](https://forum.opentap.io/u/laihesheng)\
**Post date:** [September 3, 2025, 9:30am UTC](https://forum.opentap.io/t/is-there-any-api-doc-for-keysight-opentap-wpf/2563/3 "2025-09-03T09:30:31Z")

</div>

Thank you for your reply.

I originally intended to use this dll to build a GUI, but now I am learning the code examples of OpenTAP.TUI

---

<div class="post-metadata">

**Author:** ![rolf\_madsen](https://avatars.discourse-cdn.com/v4/letter/r/43a26b/32.png) [@rolf\_madsen](https://forum.opentap.io/u/rolf_madsen)\
**Post date:** [September 3, 2025, 10:45am UTC](https://forum.opentap.io/t/is-there-any-api-doc-for-keysight-opentap-wpf/2563/4 "2025-09-03T10:45:09Z")

</div>

Got it. Looking at TUI is definitely a good way to learn about everything related to writing a GUI for OpenTAP.

For increased ease of development I’d suggest making it a plugin for tap.exe is so you can start it by writing

`tap.exe myGui`

This way you don’t need to initialize logging, plugin discovery etc.

---

<div class="post-metadata">

**Author:** ![laihesheng](https://avatars.discourse-cdn.com/v4/letter/l/e99b99/32.png) [@laihesheng](https://forum.opentap.io/u/laihesheng)\
**Post date:** [September 4, 2025, 1:54am UTC](https://forum.opentap.io/t/is-there-any-api-doc-for-keysight-opentap-wpf/2563/5 "2025-09-04T01:54:46Z")

</div>

Well, I have a new question: how to debug TUI code in VS? The breakpoints I set don’t take effect after launching the program.

---

<div class="post-metadata">

**Author:** ![rolf\_madsen](https://avatars.discourse-cdn.com/v4/letter/r/43a26b/32.png) [@rolf\_madsen](https://forum.opentap.io/u/rolf_madsen)\
**Post date:** [September 4, 2025, 5:26am UTC](https://forum.opentap.io/t/is-there-any-api-doc-for-keysight-opentap-wpf/2563/6 "2025-09-04T05:26:43Z")

</div>

I don’t have any problems debugging the TUI project myself in vs code:

 ![image](https://us1.discourse-cdn.com/flex020/uploads/opentap/original/2X/1/1377fe214bba8dae5932b85dd727070b818e01f9.png)

Did you make any changes to the code? What platform are you on?

---

<div class="post-metadata">

**Author:** ![laihesheng](https://avatars.discourse-cdn.com/v4/letter/l/e99b99/32.png) [@laihesheng](https://forum.opentap.io/u/laihesheng)\
**Post date:** [September 4, 2025, 6:50am UTC](https://forum.opentap.io/t/is-there-any-api-doc-for-keysight-opentap-wpf/2563/7 "2025-09-04T06:50:35Z")

</div>

The code I downloaded from GitHub showed a “Terminal.Gui project not found” prompt. Therefore, I found and referenced Terminal.Gui.dll on my own, with no other modifications made beyond this.

 ![image](https://us1.discourse-cdn.com/flex020/uploads/opentap/original/2X/2/2ecc51c4fd03134917b5911ccb75b301aac277c0.png)

 ![image](https://us1.discourse-cdn.com/flex020/uploads/opentap/original/2X/2/2ae43b6c4952c22f93e4608fa6398747ee1d7b5f.png)

---

<div class="post-metadata">

**Author:** ![rolf\_madsen](https://avatars.discourse-cdn.com/v4/letter/r/43a26b/32.png) [@rolf\_madsen](https://forum.opentap.io/u/rolf_madsen)\
**Post date:** [September 4, 2025, 7:24am UTC](https://forum.opentap.io/t/is-there-any-api-doc-for-keysight-opentap-wpf/2563/8 "2025-09-04T07:24:49Z")

</div>

Ok, I get it now. I though you were using VS Code.

That is probably because you are compiling a .netstandard project, so VS does not correctly detect that it should be using the .net framework debugger and instead uses the .net core debugger. If you change the project to target framework “net48”, it should work.

**Regarding Terminal.Gui**

That is because Terminal.Gui comes from the gui.cs submodule folder.

I believe you have to run:

git submodule update --init --recursive

from the TUI source folder.

---

<div class="post-metadata">

**Author:** ![laihesheng](https://avatars.discourse-cdn.com/v4/letter/l/e99b99/32.png) [@laihesheng](https://forum.opentap.io/u/laihesheng)\
**Post date:** [September 4, 2025, 7:53am UTC](https://forum.opentap.io/t/is-there-any-api-doc-for-keysight-opentap-wpf/2563/9 "2025-09-04T07:53:50Z")

</div>

Thanks a lot, it works normally now.
