Implement external Xml file IntelliSense provider

Author: govert

Source/ExcelDna.IntelliSense/Providers/IIntelliSenseProvider.cs

@@ -44,17 +44,22 @@ public class FunctionInfo
     {
         public class ArgumentInfo
         {
+            [XmlAttribute]
             public string Name;
+            [XmlAttribute]
             public string Description;
-            public string HelpTopic;
         }
 
+        [XmlAttribute]
         public string Name;
+        [XmlAttribute]
         public string Description;
+        [XmlAttribute]
         public string HelpTopic;
         [XmlElement("Argument", typeof(ArgumentInfo))]
         public List<ArgumentInfo> ArgumentList;
-        public string SourcePath; // XllPath for .xll, Workbook Name for Workbook
+        [XmlIgnore]
+        public string SourcePath; // XllPath for .xll, Workbook Name for Workbook, .xml file path for Xml file
     }
 
 }

Source/ExcelDna.IntelliSense/Providers/WorkbookIntelliSenseProvider.cs

@@ -204,10 +204,10 @@ void RegisterWithXmlProvider(Workbook wb)
             var xmlPath = GetXmlPath(path);
             _xmlProvider.RegisterXmlFunctionInfo(xmlPath);  // Will check if file exists
 
-            var customXmlParts = wb.CustomXMLParts.SelectByNamespace(XmlIntelliSenseProvider.XmlRegistrationInfo.XmlIntelliSense.Namespace);
+            var customXmlParts = wb.CustomXMLParts.SelectByNamespace(XmlIntelliSense.Namespace);
             if (customXmlParts.Count > 0)
             {
-                // We just take the first one - register against the workbook name
+                // We just take the first one - register against the Bworkbook name
                 _xmlProvider.RegisterXmlFunctionInfo(path, customXmlParts[1].XML);
             }
         }

Source/ExcelDna.IntelliSense/Providers/XmlIntelliSenseProvider.cs

@@ -39,6 +39,14 @@ public void Refresh()
                         xml = File.ReadAllText(_fileName);
                     }
                     _intelliSense = XmlIntelliSense.Parse(xml);
+                    if (_intelliSense?.XmlFunctionInfo?.FunctionsList != null)
+                    {
+                        // Fix up SourcePath (is this used?)
+                        foreach (var func in _intelliSense.XmlFunctionInfo.FunctionsList)
+                        {
+                            func.SourcePath = _fileName;
+                        }
+                    }
                 }
                 catch // (Exception ex)
                 {
@@ -55,50 +63,6 @@ public IEnumerable<FunctionInfo> GetFunctionInfos()
                 return _intelliSense.XmlFunctionInfo.FunctionsList;
             }
 
-            #region Serialized Xml structure
-            [Serializable]
-            [XmlType(AnonymousType = true)]
-            [XmlRoot("IntelliSense", Namespace = XmlIntelliSense.Namespace, IsNullable = false)]
-            public class XmlIntelliSense
-            {
-                [XmlElement("FunctionInfo")]
-                public XmlFunctionInfo XmlFunctionInfo;
-
-                // returns XmlIntelliSense.Empty on failure
-                public static XmlIntelliSense Parse(string xmlFunctionInfo)
-                {
-                    Initialize();
-                    try
-                    {
-                        using (var stringReader = new StringReader(xmlFunctionInfo))
-                        {
-                            return (XmlIntelliSense)_serializer.Deserialize(stringReader);
-                        }
-                    }
-                    catch // (Exception ex)
-                    {
-                        // TODO: Log errors
-                        return Empty;
-                    }
-                }
-
-                public static void Initialize()
-                {
-                    if (_serializer == null)
-                        _serializer = new XmlSerializer(typeof(XmlIntelliSense));
-                }
-                static XmlSerializer _serializer;
-                public static XmlIntelliSense Empty { get; } = new XmlIntelliSense { XmlFunctionInfo = new XmlFunctionInfo { FunctionsList = new List<FunctionInfo>() } };
-                public const string Namespace = "http://schemas.excel-dna.net/intellisense/";
-            }
-
-            public class XmlFunctionInfo
-            {
-                [XmlElement("Function", typeof(FunctionInfo))]
-                public List<FunctionInfo> FunctionsList;
-            }
-
-            #endregion
 
         }
 
@@ -134,11 +98,12 @@ public void RegisterXmlFunctionInfo(string fileName, string xmlIntelliSense = nu
             }
         }
 
-        // Safe to call it wasn't registered
+        // Safe to call even if it wasn't registered
         public void UnregisterXmlFunctionInfo(string fileName)
         {
             if (_xmlRegistrationInfos.Remove(fileName))
                 _isDirty = true;
+            // Not Invalidating - we're not really worried about keeping the extra information around a bit longer
         }
 
         public void Initialize()
@@ -188,4 +153,49 @@ public void Dispose()
         }
     }
 
+    #region Serialized Xml structure
+    [Serializable]
+    [XmlType(AnonymousType = true)]
+    [XmlRoot("IntelliSense", Namespace = XmlIntelliSense.Namespace, IsNullable = false)]
+    public class XmlIntelliSense
+    {
+        [XmlElement("FunctionInfo")]
+        public XmlFunctionInfo XmlFunctionInfo;
+
+        // returns XmlIntelliSense.Empty on failure
+        public static XmlIntelliSense Parse(string xmlFunctionInfo)
+        {
+            Initialize();
+            try
+            {
+                using (var stringReader = new StringReader(xmlFunctionInfo))
+                {
+                    return (XmlIntelliSense)_serializer.Deserialize(stringReader);
+                }
+            }
+            catch // (Exception ex)
+            {
+                // TODO: Log errors
+                return Empty;
+            }
+        }
+
+        public static void Initialize()
+        {
+            if (_serializer == null)
+                _serializer = new XmlSerializer(typeof(XmlIntelliSense));
+        }
+        static XmlSerializer _serializer;
+        public static XmlIntelliSense Empty { get; } = new XmlIntelliSense { XmlFunctionInfo = new XmlFunctionInfo { FunctionsList = new List<FunctionInfo>() } };
+        public const string Namespace = "http://schemas.excel-dna.net/intellisense/1.0";
+    }
+
+    [Serializable]
+    public class XmlFunctionInfo
+    {
+        [XmlElement("Function", typeof(FunctionInfo))]
+        public List<FunctionInfo> FunctionsList;
+    }
+
+    #endregion
 }

VBASamples/VBAFunctions.IntelliSense.xml

@@ -1,8 +1,9 @@
 <IntelliSense xmlns="http://excel-dna.net/intellisense/1.0/">
   <FunctionInfo>
-    <Function Name="" Description="" HelpTopic="" >
-      <Argument Name="" Description="" />
-      <Argument Name="" Description="" />
+    <Function Name="MyVBAFunction" Description="A function described by an external XML file"
+              HelpTopic="http://www.bing.com" >
+      <Argument Name="FirstArg" Description="Whatever you want to put in here" />
+      <Argument Name="AnotherArg" Description="Actually the second arg" />
     </Function>
   </FunctionInfo>
 </IntelliSense>

VBASamples/VBAFunctionsNoIS.IntelliSense.xml

@@ -0,0 +1,9 @@
+<IntelliSense xmlns="http://schemas.excel-dna.net/intellisense/1.0">
+  <FunctionInfo>
+    <Function Name="MyVBAFunction" Description="A function described by an external XML file"
+              HelpTopic="http://www.bing.com" >
+      <Argument Name="FirstArg" Description="Whatever you want to put in here" />
+      <Argument Name="AnotherArg" Description="Actually the second arg" />
+    </Function>
+  </FunctionInfo>
+</IntelliSense>