[.NET SDK] Adding the Order attribute to the FormFlow (#4236)

microsoft · Jun 29, 2018 · 4fbea59 · 4fbea59
1 parent 3f6da33
commit 4fbea59
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 2 deletions.
diff --git a/CSharp/Library/Microsoft.Bot.Builder.FormFlow.Json/FormBuilderJson.cs b/CSharp/Library/Microsoft.Bot.Builder.FormFlow.Json/FormBuilderJson.cs
@@ -395,7 +395,7 @@ private void Fields(JObject schema, string prefix, IList<string> fields)
         private void FieldPaths(Type type, string path, List<string> paths)
         {
             var newPath = (path == "" ? path : path + ".");
-            foreach (var field in type.GetFields(BindingFlags.Public | BindingFlags.Instance).Where(f => !f.IsDefined(typeof(IgnoreFieldAttribute))))
+            foreach (var field in type.GetFields(BindingFlags.Public | BindingFlags.Instance).Where(f => !f.IsDefined(typeof(IgnoreFieldAttribute))).OrderBy(f => f.GetCustomAttributes(typeof(OrderAttribute), true).Cast<OrderAttribute>().Select(a => a.Order).FirstOrDefault()))
             {
                 TypePaths(field.FieldType, newPath + field.Name, paths);
             }

diff --git a/CSharp/Library/Microsoft.Bot.Builder/FormFlow/Attributes.cs b/CSharp/Library/Microsoft.Bot.Builder/FormFlow/Attributes.cs
@@ -726,6 +726,30 @@ public class IgnoreFieldAttribute : Attribute
         public IgnoreFieldAttribute()
         { }
     }
+
+    /// <summary>
+    /// Define a order weight of the field or property.
+    /// </summary>
+    /// <remarks>
+    /// By default the order weight is 0.
+    /// </remarks>
+    [Serializable]
+    [AttributeUsage(AttributeTargets.Field | AttributeTargets.Property)]
+    public class OrderAttribute : Attribute
+    {
+        private readonly int _order;
+
+        /// <summary>
+        /// Sets the order weight of the field or property
+        /// </summary>
+        /// <param name="order">The order weight</param>
+        public OrderAttribute(int order = 0)
+        {
+            _order = order;
+        }
+
+        public int Order => _order;
+    }
 }
 
 namespace Microsoft.Bot.Builder.FormFlow.Advanced

diff --git a/CSharp/Library/Microsoft.Bot.Builder/FormFlow/FormBuilder.cs b/CSharp/Library/Microsoft.Bot.Builder/FormFlow/FormBuilder.cs
@@ -461,7 +461,7 @@ public override IFormBuilder<T> AddRemainingFields(IEnumerable<string> exclude =
         private void FieldPaths(Type type, string path, List<string> paths)
         {
             var newPath = (path == "" ? path : path + ".");
-            foreach (var field in type.GetFields(BindingFlags.Public | BindingFlags.Instance).Where(f => !f.IsDefined(typeof(IgnoreFieldAttribute))))
+            foreach (var field in type.GetFields(BindingFlags.Public | BindingFlags.Instance).Where(f => !f.IsDefined(typeof(IgnoreFieldAttribute))).OrderBy(f => f.GetCustomAttributes(typeof(OrderAttribute), true).Cast<OrderAttribute>().Select(a => a.Order).FirstOrDefault()))
             {
                 TypePaths(field.FieldType, newPath + field.Name, paths);
             }