Parameter.cs 7.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284
  1. using System;
  2. using System.ComponentModel;
  3. using FastReport.Utils;
  4. using System.Drawing.Design;
  5. namespace FastReport.Data
  6. {
  7. /// <summary>
  8. /// Represents a report parameter that is used to pass user data to a report.
  9. /// </summary>
  10. /// <remarks>
  11. /// See <see cref="Report.Parameters"/> for details about using parameters.
  12. /// </remarks>
  13. public class Parameter : Base, IParent
  14. {
  15. #region Fields
  16. private Type dataType;
  17. private object value;
  18. private string expression;
  19. private string description;
  20. private ParameterCollection parameters;
  21. #endregion
  22. #region Properties
  23. /// <summary>
  24. /// Gets or sets the name of parameter.
  25. /// </summary>
  26. [MergableProperty(false)]
  27. [DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)]
  28. [Category("Design")]
  29. [DisplayName("(Name)")]
  30. public new string Name
  31. {
  32. get { return (this as Base).Name; }
  33. set
  34. {
  35. if (value != "" && Report != null)
  36. {
  37. foreach (Parameter p in Report.Parameters)
  38. {
  39. if (p != null && p != this && p.Name == value)
  40. {
  41. return;
  42. }
  43. }
  44. }
  45. (this as Base).Name = value;
  46. }
  47. }
  48. /// <summary>
  49. /// Gets or sets the type of parameter.
  50. /// </summary>
  51. [TypeConverter(typeof(FastReport.TypeConverters.DataTypeConverter))]
  52. [Category("Data")]
  53. [Editor("FastReport.TypeEditors.DataTypeEditor, FastReport", typeof(UITypeEditor))]
  54. public Type DataType
  55. {
  56. get { return dataType; }
  57. set { dataType = value; }
  58. }
  59. /// <summary>
  60. /// Gets or sets the value of parameter.
  61. /// </summary>
  62. /// <remarks>
  63. /// You may specify the static value in this property. Note: if the <see cref="Expression"/>
  64. /// property is not empty, it will be calculated and its value will be returned.
  65. /// </remarks>
  66. [Browsable(false)]
  67. public virtual object Value
  68. {
  69. get
  70. {
  71. if (!String.IsNullOrEmpty(Expression) && Report != null && Report.IsRunning)
  72. value = Report.Calc(Expression);
  73. return value;
  74. }
  75. set
  76. {
  77. this.value = value;
  78. if (value != null)
  79. dataType = value.GetType();
  80. }
  81. }
  82. /// <summary>
  83. /// Gets or sets value of the parameter as a string.
  84. /// </summary>
  85. [Browsable(false)]
  86. public string AsString
  87. {
  88. get
  89. {
  90. object value = Value;
  91. return value == null ? "" : value.ToString();
  92. }
  93. set
  94. {
  95. Expression = "";
  96. this.value = Convert.ChangeType(value, DataType);
  97. }
  98. }
  99. /// <summary>
  100. /// Gets or sets an expression of the parameter.
  101. /// </summary>
  102. /// <remarks>
  103. /// This expression will be calculated each time you access a parameter's <b>Value</b>.
  104. /// </remarks>
  105. [Category("Data")]
  106. [Editor("FastReport.TypeEditors.ExpressionEditor, FastReport", typeof(UITypeEditor))]
  107. public string Expression
  108. {
  109. get { return expression; }
  110. set { expression = value; }
  111. }
  112. /// <summary>
  113. /// Gets or sets the description of a parameter.
  114. /// </summary>
  115. public string Description
  116. {
  117. get { return description; }
  118. set { description = value; }
  119. }
  120. /// <summary>
  121. /// Gets a collection of nested parameters.
  122. /// </summary>
  123. /// <remarks>
  124. /// Parameters can have child (nested) parameters. To get or set a nested
  125. /// parameter's value, use the <see cref="Report.GetParameter"/> method.
  126. /// </remarks>
  127. [Browsable(false)]
  128. public ParameterCollection Parameters
  129. {
  130. get { return parameters; }
  131. }
  132. /// <summary>
  133. /// Gets the full name of the parameter. This is useful to get the nested parameter's full name.
  134. /// </summary>
  135. [Browsable(false)]
  136. public string FullName
  137. {
  138. get
  139. {
  140. string result = Name;
  141. Parameter parent = Parent as Parameter;
  142. while (parent != null)
  143. {
  144. result = parent.Name + "." + result;
  145. parent = parent.Parent as Parameter;
  146. }
  147. return result;
  148. }
  149. }
  150. /// <summary>
  151. /// This property is not relevant to this class.
  152. /// </summary>
  153. [Browsable(false)]
  154. public new Restrictions Restrictions
  155. {
  156. get { return base.Restrictions; }
  157. set { base.Restrictions = value; }
  158. }
  159. #endregion
  160. #region Public Methods
  161. /// <inheritdoc/>
  162. public override void Assign(Base source)
  163. {
  164. BaseAssign(source);
  165. }
  166. /// <inheritdoc/>
  167. public override void Serialize(FRWriter writer)
  168. {
  169. base.Serialize(writer);
  170. writer.WriteValue("DataType", DataType);
  171. if (!String.IsNullOrEmpty(Expression))
  172. writer.WriteStr("Expression", Expression);
  173. if (!String.IsNullOrEmpty(Description))
  174. writer.WriteStr("Description", Description);
  175. }
  176. /// <inheritdoc/>
  177. public override string[] GetExpressions()
  178. {
  179. return new string[] { Expression };
  180. }
  181. internal Parameter Add(string name)
  182. {
  183. if (Parameters.FindByName(name) != null)
  184. throw new Exception("Parameter " + name + " already exists.");
  185. Parameter variable = new Parameter(name);
  186. Parameters.Add(variable);
  187. return variable;
  188. }
  189. #endregion
  190. #region IParent Members
  191. /// <inheritdoc/>
  192. public virtual bool CanContain(Base child)
  193. {
  194. return child is Parameter;
  195. }
  196. /// <inheritdoc/>
  197. public void GetChildObjects(ObjectCollection list)
  198. {
  199. foreach (Parameter v in Parameters)
  200. {
  201. list.Add(v);
  202. }
  203. }
  204. /// <inheritdoc/>
  205. public void AddChild(Base child)
  206. {
  207. Parameters.Add(child as Parameter);
  208. }
  209. /// <inheritdoc/>
  210. public void RemoveChild(Base child)
  211. {
  212. Parameters.Remove(child as Parameter);
  213. }
  214. /// <inheritdoc/>
  215. public int GetChildOrder(Base child)
  216. {
  217. return Parameters.IndexOf(child as Parameter);
  218. }
  219. /// <inheritdoc/>
  220. public void SetChildOrder(Base child, int order)
  221. {
  222. int oldOrder = child.ZOrder;
  223. if (oldOrder != -1 && order != -1 && oldOrder != order)
  224. {
  225. if (order > Parameters.Count)
  226. order = Parameters.Count;
  227. if (oldOrder <= order)
  228. order--;
  229. Parameters.Remove(child as Parameter);
  230. Parameters.Insert(order, child as Parameter);
  231. }
  232. }
  233. /// <inheritdoc/>
  234. public void UpdateLayout(float dx, float dy)
  235. {
  236. // do nothing
  237. }
  238. #endregion
  239. /// <summary>
  240. /// Initializes a new instance of the <see cref="Parameter"/> class with default settings.
  241. /// </summary>
  242. public Parameter() : this("")
  243. {
  244. }
  245. /// <summary>
  246. /// Initializes a new instance of the <see cref="Parameter"/> class with specified name.
  247. /// </summary>
  248. public Parameter(string name)
  249. {
  250. Name = name;
  251. DataType = typeof(string);
  252. expression = "";
  253. description = "";
  254. parameters = new ParameterCollection(this);
  255. SetFlags(Flags.CanCopy | Flags.CanEdit, false);
  256. }
  257. }
  258. }