DFLayoutFieldProperties.cs 9.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260
  1. using System;
  2. using System.Collections.Generic;
  3. using System.Linq;
  4. namespace InABox.Core
  5. {
  6. // When creating a new field with properties, make sure to override LoadProperties() and SaveProperties()
  7. public abstract class DFLayoutFieldProperties : DFLayoutObject
  8. {
  9. [EditorSequence(-999)]
  10. [CodeEditor(Editable = Editable.Enabled, ValidChars = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz_0123456789")]
  11. public string Code { get; set; }
  12. [EditorSequence(-998)]
  13. [TextBoxEditor]
  14. public string Description { get; set; }
  15. [EditorSequence(-997)]
  16. [ComboLookupEditor(typeof(PropertyLookupGenerator))]
  17. public string Property { get; set; }
  18. [Caption("Read Only?")]
  19. [EditorSequence(-997)]
  20. [CheckBoxEditor]
  21. public bool ReadOnlyProperty { get; set; }
  22. [CheckBoxEditor]
  23. [EditorSequence(4)]
  24. public bool Required { get; set; }
  25. [CheckBoxEditor]
  26. [EditorSequence(5)]
  27. public bool Secure { get; set; }
  28. [CheckBoxEditor]
  29. [EditorSequence(6)]
  30. public bool Retain { get; set; }
  31. [CheckBoxEditor]
  32. [EditorSequence(7)]
  33. public bool Hidden { get; set; }
  34. [ExpressionEditor(null)]
  35. [EditorSequence(8)]
  36. public string Expression { get; set; }
  37. /// <summary>
  38. /// An expression that sets the field to have a background colour of its result.
  39. /// The result of the expression should be either a hex code like #rrggbb or #aarrggbb, or the string name of a <see cref="System.Drawing.KnownColor"/>,
  40. /// like 'Yellow'.
  41. /// </summary>
  42. [ExpressionEditor(null, ToolTip = "Evalutes to either a hex code (#RRGGBB or #AARRGGBB) or a colour name (like 'Red' or 'Yellow'), which sets the background colour for this variable.")]
  43. [EditorSequence(9)]
  44. public string ColourExpression { get; set; }
  45. public abstract string FormatValue(object? value);
  46. public abstract void Serialize(DFSaveStorageEntry entry, object? value);
  47. public abstract object? Deserialize(DFLoadStorageEntry entry);
  48. public abstract object? GetValue(object? value);
  49. public virtual IEnumerable<CoreColumn> GetAdditionalColumns()
  50. {
  51. return Enumerable.Empty<CoreColumn>();
  52. }
  53. public virtual IEnumerable<KeyValuePair<string, object?>> GetAdditionalValues(object? value)
  54. {
  55. return Enumerable.Empty<KeyValuePair<string, object?>>();
  56. }
  57. public abstract IEnumerable<CoreColumn> GetDisplayColumns();
  58. public abstract IEnumerable<KeyValuePair<string, object?>> GetDisplayValues(object? value);
  59. protected override void LoadProperties()
  60. {
  61. Description = GetProperty(nameof(Description), "");
  62. Property = GetProperty(nameof(Property), "");
  63. ReadOnlyProperty = GetProperty(nameof(ReadOnlyProperty), true);
  64. Required = GetProperty(nameof(Required), false);
  65. Secure = GetProperty(nameof(Secure), false);
  66. Retain = GetProperty(nameof(Retain), false);
  67. Expression = GetProperty(nameof(Expression), "");
  68. ColourExpression = GetProperty(nameof(ColourExpression), "");
  69. }
  70. protected override void SaveProperties()
  71. {
  72. SetProperty(nameof(Description), Description);
  73. SetProperty(nameof(Property), Property);
  74. SetProperty(nameof(ReadOnlyProperty), ReadOnlyProperty);
  75. SetProperty(nameof(Required), Required);
  76. SetProperty(nameof(Secure), Secure);
  77. SetProperty(nameof(Retain), Retain);
  78. SetProperty(nameof(Expression), Expression);
  79. SetProperty(nameof(ColourExpression), ColourExpression);
  80. }
  81. private class PropertyLookupGenerator : LookupGenerator<object>
  82. {
  83. public PropertyLookupGenerator(object[] items) : base(items)
  84. {
  85. }
  86. protected override void DoGenerateLookups()
  87. {
  88. var form = Items?.FirstOrDefault() as DigitalForm;
  89. if (form != null)
  90. {
  91. var type = DFUtils.FormEntityType(form);
  92. if (type != null)
  93. {
  94. var props = CoreUtils.PropertyList(type, x => true, true);
  95. foreach (var prop in props.Keys)
  96. {
  97. var info = CoreUtils.GetProperty(type, prop);
  98. var editor = info.GetEditor();
  99. if (editor != null && editor.Editable.IsEditable())
  100. {
  101. var bOK = true;
  102. if (prop.Contains("."))
  103. {
  104. var comps = prop.Split('.').Reverse().Skip(1).Reverse().ToList();
  105. while (comps.Count > 0)
  106. {
  107. var parent = string.Join(".", comps);
  108. comps.Remove(comps.Last());
  109. try
  110. {
  111. var parentinfo = CoreUtils.GetProperty(type, parent);
  112. var parenteditor = parentinfo.GetEditor();
  113. if (parenteditor is NullEditor)
  114. bOK = false;
  115. }
  116. catch (Exception e)
  117. {
  118. bOK = false;
  119. }
  120. }
  121. }
  122. if (bOK)
  123. AddValue(prop, prop);
  124. }
  125. }
  126. }
  127. }
  128. }
  129. }
  130. }
  131. public abstract class DFLayoutFieldProperties<TValue, TSerialized> : DFLayoutFieldProperties
  132. {
  133. public DFLayoutFieldProperties()
  134. {
  135. Default = default;
  136. }
  137. [EditorSequence(-995)]
  138. public TValue Default { get; set; }
  139. protected override void LoadProperties()
  140. {
  141. base.LoadProperties();
  142. Default = GetProperty("Default", default(TValue));
  143. }
  144. protected override void SaveProperties()
  145. {
  146. base.SaveProperties();
  147. SetProperty("Default", Default);
  148. }
  149. public sealed override void Serialize(DFSaveStorageEntry entry, object? value)
  150. {
  151. if(value is TSerialized ser)
  152. {
  153. SerializeValue(entry, ser);
  154. }
  155. }
  156. public sealed override object? Deserialize(DFLoadStorageEntry entry)
  157. {
  158. return DeserializeValue(entry);
  159. }
  160. public abstract void SerializeValue(DFSaveStorageEntry entry, TSerialized value);
  161. public abstract TSerialized DeserializeValue(DFLoadStorageEntry entry);
  162. public sealed override string FormatValue(object? value)
  163. {
  164. if (value is TSerialized ser)
  165. {
  166. return FormatValue(ser);
  167. }
  168. else
  169. {
  170. return "";
  171. }
  172. }
  173. public abstract string FormatValue(TSerialized value);
  174. public sealed override object? GetValue(object? value)
  175. {
  176. if (value is TSerialized ser)
  177. {
  178. return GetValue(ser);
  179. }
  180. else
  181. {
  182. return null;
  183. }
  184. }
  185. public abstract TValue GetValue(TSerialized value);
  186. public sealed override IEnumerable<KeyValuePair<string, object?>> GetAdditionalValues(object? value)
  187. {
  188. if(value is TSerialized ser)
  189. {
  190. return GetAdditionalValues(ser);
  191. }
  192. return Enumerable.Empty<KeyValuePair<string, object?>>();
  193. }
  194. public virtual IEnumerable<KeyValuePair<string, object?>> GetAdditionalValues(TSerialized value)
  195. {
  196. return Enumerable.Empty<KeyValuePair<string, object?>>();
  197. }
  198. public override IEnumerable<CoreColumn> GetDisplayColumns()
  199. {
  200. yield return new CoreColumn
  201. {
  202. ColumnName = Code,
  203. DataType = typeof(TValue)
  204. };
  205. foreach(var col in GetAdditionalColumns())
  206. {
  207. yield return col;
  208. }
  209. }
  210. public sealed override IEnumerable<KeyValuePair<string, object?>> GetDisplayValues(object? value)
  211. {
  212. if (value is TSerialized ser)
  213. {
  214. return GetDisplayValues(ser);
  215. }
  216. return Enumerable.Empty<KeyValuePair<string, object?>>();
  217. }
  218. public virtual IEnumerable<KeyValuePair<string, object?>> GetDisplayValues(TSerialized value)
  219. {
  220. yield return new KeyValuePair<string, object?>(Code, value);
  221. foreach (var pair in GetAdditionalValues(value))
  222. {
  223. yield return pair;
  224. }
  225. }
  226. }
  227. }