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

F1 Help for addin only

Dale.Bartlett — Sun, 29 Oct 2017 11:50:10 GMT

I am adding Help to my addin and want the F1 key to call my help file (CHM) for the whole form, not just for the control that has focus. I am using the following code which is working fine. My problem is that F1 triggers Revit's online help after calling mine. Is there a way to prevent this keystroke going on to Revit? Many thanks. Dale

protected override bool ProcessCmdKey(ref Message msg, Keys keyData)
        {
            // F1 for help on any control
            if (keyData == (Keys.F1))
            {
                HelpClick();

                // This keystroke was handled, don't pass to the control with the focus
                return true;
            }
            return base.ProcessCmdKey(ref msg, keyData);
        }

Re: F1 Help for addin only

RPTHOMAS108 — Sun, 29 Oct 2017 12:16:50 GMT

If you were using KeyDown event then you could try setting e.Handled = True.

KeyDown also has KeyData to check for F1.

There is also a HelpRequested event which I'm not familiar with but again could try setting e.Handled = True. I presume it responds to F1 but the order in the call chain for this may be too late to prrvent subsequent event handlers.

I had a modeless form the other day and was pressing delete to delete something in the text box but the x icon in Revit was appearing to delete an element from the model. That was fixed by setting the parent, although I knew of the parent setting thing I wasn't that concerned about it for the form in question.

Re: F1 Help for addin only

Dale.Bartlett — Sun, 29 Oct 2017 12:45:31 GMT

Apologies for the double post. The alternative is to "set the form's KeyPreview to true. This will make sure the form get the keypress messages first and if you handle it, you can set e.Handled = true so it doesn't passed down to the controls." There is a bit of online discussion and dispute as to the correct method. Dale

Re: F1 Help for addin only

Dale.Bartlett — Sun, 05 Nov 2017 10:17:10 GMT

My original need was to ensure F1 was context-sensitive to the host form rather than the control-with-focus. I now find that in all addins that I test, F1 is either disabled, or calls Autodesk's online help default page. Autodesk's own addins have their pages in the on-line help, so they behave as expected. The code I provided initially is working perfectly with the exception that after calling my addin context help, it continues to open Autodesk's default page. I now realise that 3rd party addins should have some method to call their own F1 context-sensitive help independent of Autodesk's. Surely this has been addressed previously? Any advice very much appreciated. Regards, Dale

Re: F1 Help for addin only

Dale.Bartlett — Sun, 05 Nov 2017 10:24:24 GMT

This was in the duplicate post (cancelled)

hi,

We can use Revit UI API and autodesk AdWindows assembly to control the contextual help for ribbon item; please refer to code below FYI.

        /// <summary>
        /// Update ribbon item with given help uri, title, description, etc.
        /// </summary>
        private void UpdateRibbonContexualHelp(RibbonItem item, string helpUri, 
            string title, string description, string expandDescription, Uri expandVideo)
        {
            Type itemType = item.GetType();

            var mi = itemType.GetMethod("getRibbonItem",
              BindingFlags.NonPublic | BindingFlags.Instance);

            var windowRibbonItem = mi.Invoke(item, null);
            Autodesk.Windows.RibbonItem wndRibbonItem = windowRibbonItem as Autodesk.Windows.RibbonItem;
            item.SetContextualHelp(new ContextualHelp(ContextualHelpType.Url, helpUri));

            wndRibbonItem.ToolTip = new Autodesk.Windows.RibbonToolTip()
            {
                Title = title,
                Content = description,
                ExpandedContent = expandDescription,
                ExpandedVideo = expandVideo,
            };
        }

I haven't tried this, but does it mean that while the Ribbon item addin form is active, F1 will call the specified helpURL? Dale

Re: F1 Help for addin only

jeremytammik — Mon, 06 Nov 2017 19:58:08 GMT

Dear Dale,

Thank you for your query.

I used the contextual help functionality a couple of times in the past and never encountered the behaviour you describe:

Multi-Version Add-in -- http://thebuildingcoder.typepad.com/blog/2012/07/multi-version-add-in.html
What's New in the Revit 2013 API -- http://thebuildingcoder.typepad.com/blog/2013/03/whats-new-in-the-revit-2013-api.html > Contextual help support
Using Balloon Tips in Revit -- http://thebuildingcoder.typepad.com/blog/2014/03/using-balloon-tips-in-revit.html
From Hack to App - OBJ Mesh Import to DirectShape -- http://thebuildingcoder.typepad.com/blog/2015/02/from-hack-to-app-obj-mesh-import-to-directshape.html

Unfortunately, all of these date rather far back, so I cannot guarantee that they behave as expected nowadays.

If you are setting up and calling the contextual help properly, I would not expect the Autodesk help to pop up, or pop up as well, or afterwards, or at all.

You might want to submit a minimal reproducible case to demonstrate that, so we can ask the development team what they think about it, and whether that behaviour is intentional:

http://thebuildingcoder.typepad.com/blog/about-the-author.html#1b

I hope this helps.

Best regards,

Jeremy

Re: F1 Help for addin only

Dale.Bartlett — Tue, 07 Nov 2017 07:01:12 GMT

Thanks Jeremy, I will put together a sample for the team's testing. Dale

Re: F1 Help for addin only

jeremytammik — Thu, 08 Feb 2018 14:28:18 GMT

Following up on this issue in a new thread:

https://forums.autodesk.com/t5/revit-api-forum/contextual-help-not-working-from-within-a-command/m-p/6970171

Best regards,

Jeremy

Re: F1 Help for addin only

jeremytammik — Tue, 13 Mar 2018 11:06:34 GMT

Solved in the follow-up thread and preserved for posterity by The Building Coder:

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

Many thanks to Dragos for solving and explaining this there.

Cheers,

Jeremy