HelpTopic improvements, including relative paths

Author: govert

Source/ExcelDna.IntelliSense/Providers/IIntelliSenseProvider.cs

@@ -1,5 +1,6 @@
 using System;
 using System.Collections.Generic;
+using System.IO;
 using System.Xml.Serialization;
 
 namespace ExcelDna.IntelliSense
@@ -58,6 +59,28 @@ public class ArgumentInfo
         public List<ArgumentInfo> ArgumentList;
         [XmlIgnore]
         public string SourcePath; // XllPath for .xll, Workbook Name for Workbook, .xml file path for Xml file
+
+        // Not sure where to put this...
+        internal static string ExpandHelpTopic(string path, string helpTopic)
+        {
+            if (string.IsNullOrEmpty(helpTopic))
+                return helpTopic;
+
+            if (helpTopic.StartsWith("http://") || helpTopic.StartsWith("https://") || helpTopic.StartsWith("file://"))
+            {
+                if (helpTopic.EndsWith("!0"))
+                {
+                    helpTopic = helpTopic.Substring(0, helpTopic.Length - 2);
+                }
+            }
+            else if (!Path.IsPathRooted(helpTopic))
+            {
+                helpTopic = Path.Combine(path, helpTopic);
+            }
+            return helpTopic;
+        }
+
+
     }
 
 }

Source/ExcelDna.IntelliSense/Providers/WorkbookIntelliSenseProvider.cs

@@ -26,6 +26,7 @@ class WorkbookRegistrationInfo
             readonly string _name;
             DateTime _lastUpdate;               // Version indicator to enumerate from scratch
             object[,] _regInfo = null;          // Default value
+            string _path;
 
             public WorkbookRegistrationInfo(string name)
             {
@@ -37,6 +38,7 @@ public void Refresh()
             {
                 var app = (Application)ExcelDnaUtil.Application;
                 var wb = app.Workbooks[_name];
+                _path = wb.Path;
 
                 try
                 {
@@ -97,6 +99,8 @@ public IEnumerable<FunctionInfo> GetFunctionInfos()
                         }
                     }
 
+                    helpTopic = FunctionInfo.ExpandHelpTopic(_path, helpTopic);
+
                     yield return new FunctionInfo
                     {
                         Name = functionName,

Source/ExcelDna.IntelliSense/Providers/XmlIntelliSenseProvider.cs

@@ -19,11 +19,13 @@ public class XmlRegistrationInfo
             string _fileName;              // Might be .xml file or Workbook path. Use only if _xmlIntelliSense is null.
             string _xmlIntelliSense;       // Might be null
             XmlIntelliSense _intelliSense; // Might be null - lazy parsed
+            string _path;                  // Directory of file, used to expand HelpTopic
 
             public XmlRegistrationInfo(string fileName, string xmlIntelliSense)
             {
                 _fileName = fileName;
                 _xmlIntelliSense = xmlIntelliSense;
+                _path = Path.GetDirectoryName(fileName);
             }
 
             // Called in a macro context
@@ -43,10 +45,11 @@ public void Refresh()
                     _intelliSense = XmlIntelliSense.Parse(xml);
                     if (_intelliSense?.XmlFunctionInfo?.FunctionsList != null)
                     {
-                        // Fix up SourcePath (is this used?)
+                        // Fix up SourcePath (is this used?) and HelpTopic
                         foreach (var func in _intelliSense.XmlFunctionInfo.FunctionsList)
                         {
                             func.SourcePath = _fileName;
+                            func.HelpTopic = FunctionInfo.ExpandHelpTopic(_path, func.HelpTopic);
                         }
                     }
                 }
@@ -66,7 +69,6 @@ public IEnumerable<FunctionInfo> GetFunctionInfos()
                 return _intelliSense.XmlFunctionInfo.FunctionsList;
             }
 
-
         }
 
         ExcelSynchronizationContext _syncContextExcel;

Source/ExcelDna.IntelliSense/ToolTipForm.cs

@@ -3,6 +3,7 @@
 using System.Diagnostics;
 using System.Drawing;
 using System.Drawing.Drawing2D;
+using System.IO;
 using System.Linq;
 using System.Windows.Forms;
 
@@ -246,25 +247,49 @@ void MouseButtonUp(Point screenLocation)
 
         void LaunchLink(string address)
         {
-            if (address.StartsWith("http", StringComparison.OrdinalIgnoreCase))
-            {
-                Process.Start(address);
-            }
-            else
+            try
             {
-                var parts = address.Split('!');
-                if (parts.Length == 2)
+                if (address.StartsWith("http", StringComparison.OrdinalIgnoreCase))
                 {
-                    // (This is the expected case)
-                    // Assume we have a filename!topicid
-                    Help.ShowHelp(null, parts[0], HelpNavigator.TopicId, parts[1]);
+                    Process.Start(address);
                 }
                 else
                 {
-                    // Just show the file ...?
-                    Help.ShowHelp(null, address);
+                    var parts = address.Split('!');
+                    if (parts.Length == 2)
+                    {
+                        // (This is the expected case)
+                        // Assume we have a filename!topicid
+                        var fileName = parts[0];
+                        var topicId = parts[1];
+                        if (File.Exists(fileName))
+                        {
+                            Help.ShowHelp(null, fileName, HelpNavigator.TopicId, topicId);
+                        }
+                        else
+                        {
+                            MessageBox.Show($"The help link could not be activated:\r\n\r\nThe file {fileName} could not be located.", "IntelliSense by Excel-DNA", MessageBoxButtons.OK, MessageBoxIcon.Error);
+                        }
+                    }
+                    else
+                    {
+                        // Just show the file ...?
+                        if (File.Exists(address))
+                        {
+                            Help.ShowHelp(null, address, HelpNavigator.TableOfContents);
+                        }
+                        else
+                        {
+                            MessageBox.Show($"The help link could not be activated:\r\n\r\nThe file {address} could not be located.", "IntelliSense by Excel-DNA", MessageBoxButtons.OK, MessageBoxIcon.Error);
+                        }
+                    }
                 }
             }
+            catch (Exception ex)
+            {
+                MessageBox.Show($"The help link could not be activated:\r\n\r\n{ex.Message}", "IntelliSense by Excel-DNA", MessageBoxButtons.OK, MessageBoxIcon.Error);
+                // NOTE: In this case, the Excel process does not quit after closing Excel...
+            }
         }
 
         Point GetMouseLocation(IntPtr lParam)