Fixed #12 - NullReferenceException in MacroFeatureRebuildResult.FromBody

Implemented #13 - Provide a reason for the macro feature handler destroy Implemented #14 - Need to have support for more types in macro feature parameters (DateTime, decimal) Updated the header for all files Removed obsolete members Added the readme to nuget
codestackdev · Aug 5, 2019 · 54c5232 · 54c5232
1 parent 4133c09
commit 54c5232
Show file tree

Hide file tree

Showing 51 changed files with 299 additions and 259 deletions.
diff --git a/AddInExample/LifecycleMacroFeature.cs b/AddInExample/LifecycleMacroFeature.cs
@@ -29,9 +29,9 @@ public void Init(ISldWorks app, IModelDoc2 model, IFeature feat)
             m_App.SendMsgToUser($"{m_Model.GetTitle()}\\{m_Feat.Name} loaded");
         }
 
-        public void Unload()
+        public void Unload(MacroFeatureUnloadReason_e reason)
         {
-            m_App.SendMsgToUser($"{m_Model.GetTitle()}\\{m_Feat.Name} unloaded");
+            m_App.SendMsgToUser($"{m_Model.GetTitle()}\\{m_Feat.Name} unloaded: {reason}");
         }
 
         public void Rebuild()

diff --git a/AddInExample/ParamsMacroFeature.cs b/AddInExample/ParamsMacroFeature.cs
@@ -42,6 +42,8 @@ public class ParamsMacroFeatureParams
     {
         public string Param2 { get; set; }
         public int EditDefinitionsCount { get; set; }
+        public DateTime DateTime { get; set; }
+        public decimal Decimal { get; set; }
     }
 
     [ComVisible(true)]
@@ -57,6 +59,8 @@ protected override bool OnEditDefinition(ISldWorks app, IModelDoc2 model, IFeatu
 
             var featParams = GetParameters(feature, featData, model);
 
+            featParams.DateTime = DateTime.Now;
+            featParams.Decimal = (featParams.Decimal + 1M) * 1.002M;
             app.SendMsgToUser($"{nameof(featParams.Param2)} = {featParams.Param2}; {nameof(featParams.EditDefinitionsCount)} = {featParams.EditDefinitionsCount}");
             featParams.EditDefinitionsCount = featParams.EditDefinitionsCount + 1;
 

diff --git a/Base/Attributes/FeatureIconAttribute.cs b/Base/Attributes/FeatureIconAttribute.cs
@@ -1,7 +1,7 @@
 //**********************
 //SwEx.MacroFeature - framework for developing macro features in SOLIDWORKS
-//Copyright(C) 2018 www.codestack.net
-//License: https://github.com/codestack-net-dev/swex-macrofeature/blob/master/LICENSE
+//Copyright(C) 2019 www.codestack.net
+//License: https://github.com/codestackdev/swex-macrofeature/blob/master/LICENSE
 //Product URL: https://www.codestack.net/labs/solidworks/swex/macro-feature
 //**********************
 
@@ -12,21 +12,6 @@
 
 namespace CodeStack.SwEx.MacroFeature.Attributes
 {
-    [Obsolete("Deprecated. Use FeatureIconAttribute or Common.Attributes.IconAttribute instead")]
-    public class IconAttribute : FeatureIconAttribute
-    {
-        public IconAttribute(Type resType, string resName, string iconFolderName = "")
-            : base(resType, resName, iconFolderName)
-        {
-        }
-
-        public IconAttribute(Type resType, string smallResName, string mediumResName,
-            string largeResName, string iconFolderName = "")
-            : base(resType, smallResName, mediumResName, largeResName, iconFolderName)
-        {
-        }
-    }
-
     /// <summary>
     /// Specifies the icon for macro feature to be displayed in the Feature Manager Tree
     /// </summary>
@@ -56,7 +41,7 @@ public FeatureIconAttribute(Type resType, string resName, string iconFolderName
             IconFolderName = iconFolderName;
         }
 
-        ///<inheritdoc cref="IconAttribute(Type, string, string)"/>
+        ///<inheritdoc cref="FeatureIconAttribute(Type, string, string)"/>
         /// <param name="smallResName">Name of the resource representing the small size icon</param>
         /// <param name="mediumResName">Name of the resource representing the medium size icon</param>
         /// <param name="largeResName">Name of the resource representing the large size icon</param>

diff --git a/Base/Attributes/OptionsAttribute.cs b/Base/Attributes/OptionsAttribute.cs
@@ -1,7 +1,7 @@
 //**********************
 //SwEx.MacroFeature - framework for developing macro features in SOLIDWORKS
-//Copyright(C) 2018 www.codestack.net
-//License: https://github.com/codestack-net-dev/swex-macrofeature/blob/master/LICENSE
+//Copyright(C) 2019 www.codestack.net
+//License: https://github.com/codestackdev/swex-macrofeature/blob/master/LICENSE
 //Product URL: https://www.codestack.net/labs/solidworks/swex/macro-feature
 //**********************
 

diff --git a/Base/Attributes/ParameterDimensionAttribute.cs b/Base/Attributes/ParameterDimensionAttribute.cs
@@ -1,7 +1,7 @@
 //**********************
 //SwEx.MacroFeature - framework for developing macro features in SOLIDWORKS
-//Copyright(C) 2018 www.codestack.net
-//License: https://github.com/codestack-net-dev/swex-macrofeature/blob/master/LICENSE
+//Copyright(C) 2019 www.codestack.net
+//License: https://github.com/codestackdev/swex-macrofeature/blob/master/LICENSE
 //Product URL: https://www.codestack.net/labs/solidworks/swex/macro-feature
 //**********************
 
@@ -32,10 +32,7 @@ public class ParameterDimensionAttribute : Attribute
             swDimensionType_e.swLinearDimension,
             swDimensionType_e.swRadialDimension
         };
-
-        [Obsolete("This property is deprecated")]
-        internal int DimensionIndex { get; private set; } = -1;
-
+
         internal swDimensionType_e DimensionType { get; private set; }
 
         /// <summary>
@@ -51,13 +48,5 @@ public ParameterDimensionAttribute(swDimensionType_e dimType)
 
             DimensionType = dimType;
         }
-
-        [Obsolete("This constructor is deprecated")]
-        [Browsable(false), EditorBrowsable(EditorBrowsableState.Never)]
-        public ParameterDimensionAttribute(swDimensionType_e dimType, int dimIndex) 
-            : this(dimType)
-        {
-            DimensionIndex = dimIndex;
-        }
     }
 }
diff --git a/Base/Attributes/ParameterEditBodyAttribute.cs b/Base/Attributes/ParameterEditBodyAttribute.cs
@@ -1,7 +1,7 @@
 //**********************
 //SwEx.MacroFeature - framework for developing macro features in SOLIDWORKS
-//Copyright(C) 2018 www.codestack.net
-//License: https://github.com/codestack-net-dev/swex-macrofeature/blob/master/LICENSE
+//Copyright(C) 2019 www.codestack.net
+//License: https://github.com/codestackdev/swex-macrofeature/blob/master/LICENSE
 //Product URL: https://www.codestack.net/labs/solidworks/swex/macro-feature
 //**********************
 
@@ -22,21 +22,5 @@ namespace CodeStack.SwEx.MacroFeature.Attributes
     [AttributeUsage(AttributeTargets.Property)]
     public class ParameterEditBodyAttribute : Attribute
     {
-        [Obsolete("This property is deprecated")]
-        internal int BodyIndex { get; private set; } = -1;
-
-        /// <summary>
-        /// Marks this property as a container for edit bodies
-        /// </summary>
-        public ParameterEditBodyAttribute()
-        {
-        }
-
-        [Obsolete("This constructor is deprecated")]
-        [Browsable(false), EditorBrowsable(EditorBrowsableState.Never)]
-        public ParameterEditBodyAttribute(int bodyIndex)
-        {
-            BodyIndex = bodyIndex;
-        }
     }
 }
diff --git a/Base/Attributes/ParameterSelectionAttribute.cs b/Base/Attributes/ParameterSelectionAttribute.cs
@@ -1,7 +1,7 @@
 //**********************
 //SwEx.MacroFeature - framework for developing macro features in SOLIDWORKS
-//Copyright(C) 2018 www.codestack.net
-//License: https://github.com/codestack-net-dev/swex-macrofeature/blob/master/LICENSE
+//Copyright(C) 2019 www.codestack.net
+//License: https://github.com/codestackdev/swex-macrofeature/blob/master/LICENSE
 //Product URL: https://www.codestack.net/labs/solidworks/swex/macro-feature
 //**********************
 
@@ -23,24 +23,5 @@ namespace CodeStack.SwEx.MacroFeature.Attributes
     [AttributeUsage(AttributeTargets.Property)]
     public class ParameterSelectionAttribute : System.Attribute
     {
-        /// <summary>
-        /// Index of the selection in the selection array
-        /// </summary>
-        [Obsolete("This property is deprecated")]
-        internal int SelectionIndex { get; private set; } = -1;
-
-        /// <summary>
-        /// Marks this property as a selection
-        /// </summary>
-        public ParameterSelectionAttribute()
-        {
-        }
-
-        [Obsolete("This constructor is deprecated")]
-        [Browsable(false), EditorBrowsable(EditorBrowsableState.Never)]
-        public ParameterSelectionAttribute(int selIndex)
-        {
-            SelectionIndex = selIndex;
-        }
     }
 }
diff --git a/Base/Attributes/ParametersVersionAttribute.cs b/Base/Attributes/ParametersVersionAttribute.cs
@@ -1,7 +1,7 @@
 //**********************
 //SwEx.MacroFeature - framework for developing macro features in SOLIDWORKS
-//Copyright(C) 2018 www.codestack.net
-//License: https://github.com/codestack-net-dev/swex-macrofeature/blob/master/LICENSE
+//Copyright(C) 2019 www.codestack.net
+//License: https://github.com/codestackdev/swex-macrofeature/blob/master/LICENSE
 //Product URL: https://www.codestack.net/labs/solidworks/swex/macro-feature
 //**********************
 

diff --git a/Base/Base.csproj b/Base/Base.csproj
@@ -76,7 +76,6 @@
     <Compile Include="Base\IParametersVersionConverter.cs" />
     <Compile Include="Base\MacroFeatureOutdateState.cs" />
     <Compile Include="Base\MacroFeatureRebuildBodyResult.cs" />
-    <Compile Include="Base\MacroFeatureRebuildPatternResult.cs" />
     <Compile Include="Base\MacroFeatureRebuildResult.cs" />
     <Compile Include="Base\MacroFeatureRebuldStatusResult.cs" />
     <Compile Include="Core\MacroFeatureExOfTParams.cs" />

diff --git a/Base/Base.nuspec b/Base/Base.nuspec
@@ -2,11 +2,11 @@
 <package >
   <metadata>
     <id>CodeStack.SwEx.MacroFeature</id>
-    <version>0.4.4</version>
+    <version>0.5.0</version>
     <title>Framework for developing custom macro features in SOLIDWORKS</title>
     <authors>CodeStack</authors>
     <owners>CodeStack</owners>
-    <licenseUrl>https://github.com/codestack-net-dev/swex-macrofeature/blob/master/LICENSE</licenseUrl>
+    <licenseUrl>https://github.com/codestackdev/swex-macrofeature/blob/master/LICENSE</licenseUrl>
     <projectUrl>https://www.codestack.net/labs/solidworks/swex/macro-feature</projectUrl>
 	<iconUrl>https://www.codestack.net/labs/solidworks/swex/macro-feature/logo.png</iconUrl>
     <requireLicenseAcceptance>false</requireLicenseAcceptance>
@@ -15,4 +15,7 @@
     <copyright>Copyright © CodeStack 2019</copyright>
     <tags>MacroFeature SOLIDWORKS</tags>
   </metadata>
+  <files>
+    <file src="readme.txt" target="" />
+  </files>
 </package>
diff --git a/Base/Base/IMacroFeatureHandler.cs b/Base/Base/IMacroFeatureHandler.cs
@@ -1,14 +1,31 @@
 //**********************
 //SwEx.MacroFeature - framework for developing macro features in SOLIDWORKS
-//Copyright(C) 2018 www.codestack.net
-//License: https://github.com/codestack-net-dev/swex-macrofeature/blob/master/LICENSE
+//Copyright(C) 2019 www.codestack.net
+//License: https://github.com/codestackdev/swex-macrofeature/blob/master/LICENSE
 //Product URL: https://www.codestack.net/labs/solidworks/swex/macro-feature
 //**********************
 
 using SolidWorks.Interop.sldworks;
+using System;
 
 namespace CodeStack.SwEx.MacroFeature.Base
 {
+    /// <summary>
+    /// Reason of macro feature handler unloading. Used in <see cref="IMacroFeatureHandler.Unload(MacroFeatureUnloadReason_e)"/>
+    /// </summary>
+    public enum MacroFeatureUnloadReason_e
+    {
+        /// <summary>
+        /// Model containing this macro feature is closed
+        /// </summary>
+        ModelClosed,
+
+        /// <summary>
+        /// This macro feature is deleted
+        /// </summary>
+        Deleted
+    }
+
     /// <summary>
     /// Handler of each macro feature used in <see cref="MacroFeatureEx{TParams, THandler}"/>
     /// </summary>
@@ -22,10 +39,11 @@ public interface IMacroFeatureHandler
         /// <param name="model">Pointer to model</param>
         /// <param name="feat">Pointer to feature</param>
         void Init(ISldWorks app, IModelDoc2 model, IFeature feat);
-
+        
         /// <summary>
         /// Called when macro feature is deleted or model is closed
         /// </summary>
-        void Unload();
+        /// <param name="reason">Reason of macro feature unload</param>
+        void Unload(MacroFeatureUnloadReason_e reason);
     }
 }
diff --git a/Base/Base/IParametersVersionConverter.cs b/Base/Base/IParametersVersionConverter.cs
@@ -1,7 +1,7 @@
 //**********************
 //SwEx.MacroFeature - framework for developing macro features in SOLIDWORKS
-//Copyright(C) 2018 www.codestack.net
-//License: https://github.com/codestack-net-dev/swex-macrofeature/blob/master/LICENSE
+//Copyright(C) 2019 www.codestack.net
+//License: https://github.com/codestackdev/swex-macrofeature/blob/master/LICENSE
 //Product URL: https://www.codestack.net/labs/solidworks/swex/macro-feature
 //**********************
 

diff --git a/Base/Base/MacroFeatureOutdateState.cs b/Base/Base/MacroFeatureOutdateState.cs
@@ -1,7 +1,7 @@
 //**********************
 //SwEx.MacroFeature - framework for developing macro features in SOLIDWORKS
-//Copyright(C) 2018 www.codestack.net
-//License: https://github.com/codestack-net-dev/swex-macrofeature/blob/master/LICENSE
+//Copyright(C) 2019 www.codestack.net
+//License: https://github.com/codestackdev/swex-macrofeature/blob/master/LICENSE
 //Product URL: https://www.codestack.net/labs/solidworks/swex/macro-feature
 //**********************
 

diff --git a/Base/Base/MacroFeatureRebuildBodyResult.cs b/Base/Base/MacroFeatureRebuildBodyResult.cs
@@ -1,13 +1,14 @@
 //**********************
 //SwEx.MacroFeature - framework for developing macro features in SOLIDWORKS
-//Copyright(C) 2018 www.codestack.net
-//License: https://github.com/codestack-net-dev/swex-macrofeature/blob/master/LICENSE
+//Copyright(C) 2019 www.codestack.net
+//License: https://github.com/codestackdev/swex-macrofeature/blob/master/LICENSE
 //Product URL: https://www.codestack.net/labs/solidworks/swex/macro-feature
 //**********************
 
 using SolidWorks.Interop.sldworks;
 using System;
 using System.Collections.Generic;
+using System.ComponentModel;
 using System.Linq;
 using System.Text;
 
@@ -18,6 +19,7 @@ namespace CodeStack.SwEx.MacroFeature.Base
     /// </summary>
     public class MacroFeatureRebuildBodyResult : MacroFeatureRebuildResult
     {
+        [Obsolete, Browsable(false), EditorBrowsable(EditorBrowsableState.Never)]
         internal protected MacroFeatureRebuildBodyResult(params IBody2[] bodies) : this(null, false, bodies)
         {
         }

diff --git a/Base/Base/MacroFeatureRebuildPatternResult.cs b/Base/Base/MacroFeatureRebuildPatternResult.cs
diff --git a/Base/Base/MacroFeatureRebuildResult.cs b/Base/Base/MacroFeatureRebuildResult.cs
@@ -1,7 +1,7 @@
 //**********************
 //SwEx.MacroFeature - framework for developing macro features in SOLIDWORKS
-//Copyright(C) 2018 www.codestack.net
-//License: https://github.com/codestack-net-dev/swex-macrofeature/blob/master/LICENSE
+//Copyright(C) 2019 www.codestack.net
+//License: https://github.com/codestackdev/swex-macrofeature/blob/master/LICENSE
 //Product URL: https://www.codestack.net/labs/solidworks/swex/macro-feature
 //**********************
 
@@ -26,6 +26,7 @@ public abstract class MacroFeatureRebuildResult
         /// <param name="body">Body to return</param>
         /// <returns>Result</returns>
         /// <remarks>Use this result if you need to macro feature to generate a single body (solid or surface)</remarks>
+        [Obsolete ("Obsolete method, use another overload"), Browsable(false), EditorBrowsable(EditorBrowsableState.Never)]
         public static MacroFeatureRebuildResult FromBody(IBody2 body)
         {
             return new MacroFeatureRebuildBodyResult(body);
@@ -50,13 +51,6 @@ public static MacroFeatureRebuildResult FromBodies(IBody2[] bodies, IMacroFeatur
             return new MacroFeatureRebuildBodyResult(featData, updateEntityIds, bodies);
         }
 
-        [Obsolete("Deprecated. Use FromBodies method instead")]
-        [Browsable(false), EditorBrowsable(EditorBrowsableState.Never)]
-        public static MacroFeatureRebuildResult FromPattern(IBody2[] bodiesPattern)
-        {
-            return new MacroFeatureRebuildPatternResult(bodiesPattern);
-        }
-
         /// <summary>
         /// Returns the status of the rebuild operation
         /// </summary>

diff --git a/Base/Base/MacroFeatureRebuldStatusResult.cs b/Base/Base/MacroFeatureRebuldStatusResult.cs
@@ -1,7 +1,7 @@
 //**********************
 //SwEx.MacroFeature - framework for developing macro features in SOLIDWORKS
-//Copyright(C) 2018 www.codestack.net
-//License: https://github.com/codestack-net-dev/swex-macrofeature/blob/master/LICENSE
+//Copyright(C) 2019 www.codestack.net
+//License: https://github.com/codestackdev/swex-macrofeature/blob/master/LICENSE
 //Product URL: https://www.codestack.net/labs/solidworks/swex/macro-feature
 //**********************
 

diff --git a/Base/Core/MacroFeatureEx.cs b/Base/Core/MacroFeatureEx.cs
@@ -1,7 +1,7 @@
 //**********************
 //SwEx.MacroFeature - framework for developing macro features in SOLIDWORKS
-//Copyright(C) 2018 www.codestack.net
-//License: https://github.com/codestack-net-dev/swex-macrofeature/blob/master/LICENSE
+//Copyright(C) 2019 www.codestack.net
+//License: https://github.com/codestackdev/swex-macrofeature/blob/master/LICENSE
 //Product URL: https://www.codestack.net/labs/solidworks/swex/macro-feature
 //**********************