topic Re: F1 Help for addin only, using WPF in Revit API Forum

F1 Help for addin only, using WPF

hsaATnti_dk — Thu, 05 Aug 2021 08:44:03 GMT

I'm implementing a custom context dependent help in our Revit addins (based on WPF, using C#). I catch the user pressing 'F1' and react on that, but face the problem that Revit always starts my internet browser showing the Revit help page when 'F1' is pressed. This happens even if i catch the KeyDown and PreviewKeyDown events and set 'Handled' to true and even if the active window is shown using ShowDialog().

I am aware of the solution working for Windows Forms:

https://thebuildingcoder.typepad.com/blog/2018/03/contextual-help-best-practice.html.

but I have not found a working solution for WPF. (Wouldn't it be nice if Revit just respected the event 'Handled' property?)

Regards Henrik

Re: F1 Help for addin only, using WPF

Chuong.Ho — Tue, 10 Aug 2021 02:59:32 GMT

some thing like that, same same .Use it with previewkeydown in wpf

private void HandleEsc(object sender, KeyEventArgs e) { if (e.Key == Key.Escape) Close(); } #Event Hander this.PreviewKeyDown += new KeyEventHandler(HandleEsc);

Re: F1 Help for addin only, using WPF

hsaATnti_dk — Tue, 10 Aug 2021 07:28:54 GMT

Hi, thanks for your reply.

The question is not about catching the keydown event. My eventhandler looks like this:

private void ConnectWindow_PreviewKeyDown(object sender, KeyEventArgs e) { switch (e.Key) { case Key.F1: e.Handled = true; ShowHelp(); break; default: break; } }

The problem is that Revit always opens its own help-page in my browser when user presses F1 even though I set 'handled' to true.

Regards

/Henrik

Re: F1 Help for addin only, using WPF

Chuong.Ho — Tue, 10 Aug 2021 07:36:59 GMT

I'm used ContextualHelp in RevitAPIUI, but it's working with when you drag to button and click f1.

Re: F1 Help for addin only, using WPF

hsaATnti_dk — Tue, 10 Aug 2021 07:43:11 GMT

We use that too. Still we also want to offer help pressing F1 inside our own windows.

Re: F1 Help for addin only, using WPF

Chuong.Ho — Tue, 10 Aug 2021 07:47:47 GMT

You need to set owner form that prior set event previewkeydown

https://github.com/chuongmep/RevitElementBipChecker/blob/ba885c6b04bda5fd147107759aa7aca5ecd83d1f/Command/Command.cs#L26

Re: F1 Help for addin only, using WPF

RPTHOMAS108 — Tue, 10 Aug 2021 11:09:28 GMT

I tried pressing F1 in a WPF windows Revit 2022 but nothing happened (I didn't create any contextual help implementation for the ribbon item).

Is this an issue specific to using the ContextualHelp class i.e. did you use it for a ribbon item and you find it caries through to the Window being shown?

The ContextualHelp.HelpType is either None/ContextId/Url/ChmFile setting to None probably provides default behaviour perhaps. ContextualHelp.Launch can be called anytime.

Re: F1 Help for addin only, using WPF

hsaATnti_dk — Tue, 10 Aug 2021 11:16:45 GMT

My question has nothing to do with the ribbon or the ContextualHelp class. Put simple:

Open a WPF window with ShowDialog()
Press F1: Revit opens its 'Help Home' page in my default browser. I don't want that to happen.

I'm surprised that you did not experience this when pressing F1. I se it in all Revit versions 2017 - 2022.

Re: F1 Help for addin only, using WPF

RPTHOMAS108 — Tue, 10 Aug 2021 11:29:10 GMT

That's odd the F1 key does nothing when I show a WPF window (Revit 22.0.10.28, 2022.0.1).

Re: F1 Help for addin only, using WPF

landis.mark — Mon, 24 Oct 2022 21:09:15 GMT

Has anyone solved this problem? I am working on my first Revit add-in and need to implement Contextual Help.

Re: F1 Help for addin only, using WPF

hsaATnti_dk — Thu, 27 Oct 2022 07:58:33 GMT

Unfortunately we never found a solution for this. 😞

Regards Henrik

Re: F1 Help for addin only, using WPF

jeff_stuyvesantAO — Sun, 28 Jun 2026 04:09:35 GMT

I've not seen a solution listed - have I missed this? I have been able to do this with the help of google's AI. I am interested is seeing an alternate solution - if this exists. If not, I can post.