Changeset 737 for trunk/sources/HeuristicLab.Data/ConstrainedItemListView.cs

Timestamp:

11/12/08 13:10:09 (16 years ago)

Author:

vdorfer

Message:

Created API documentation for HeuristLab.Data namespace (#331)

File:

• trunk/sources/HeuristicLab.Data/ConstrainedItemListView.cs (modified) (6 diffs)

trunk/sources/HeuristicLab.Data/ConstrainedItemListView.cs

@@ -30 +30 @@
 
 namespace HeuristicLab.Data {
+  /// <summary>
+  /// The visual representation of the class <see cref="ConstrainedItemList"/>.
+  /// </summary>
   public partial class ConstrainedItemListView : ViewBase {
     private ChooseItemDialog chooseItemDialog;
 
+
+    /// <summary>
+    /// Gets or sets the item list to represent.
+    /// </summary>
+    /// <remarks>Uses property <see cref="HeuristicLab.Core.ViewBase.Item"/> of base class <see cref="ViewBase"/>.</remarks>
     public ConstrainedItemList ConstrainedItemList {
       get { return (ConstrainedItemList)base.Item; }
@@ -38 +46 @@
     }
 
+    /// <summary>
+    /// Initializes a new instance of the class <see cref="ConstrainedItemListView"/>.
+    /// </summary>
     public ConstrainedItemListView() {
       InitializeComponent();
@@ -43 +54 @@
     }
 
+    /// <summary>
+    /// Initializes a new instance of the class <see cref="ConstrainedItemListView"/> with the given
+    /// <paramref name="constrainedItemList"/>.
+    /// <note type="caution"> No CopyConstructor! <paramref name="constrainedItemList"/> is not copied!</note>
+    /// </summary>
+    /// <param name="constrainedItemList">The item list to represent visually.</param>
     public ConstrainedItemListView(ConstrainedItemList constrainedItemList)
       : this() {
@@ -48 +65 @@
     }
 
+    /// <summary>
+    /// Removes the eventhandlers from the underlying <see cref="ConstrainedItemList"/>.
+    /// </summary>
+    /// <remarks>Calls <see cref="HeuristicLab.Core.ViewBase.RemoveItemEvents"/> of base class <see cref="ViewBase"/>.
+    /// </remarks>
     protected override void RemoveItemEvents() {
       ConstrainedItemList.ItemAdded -= new EventHandler<ItemIndexEventArgs>(ConstrainedItemList_ItemAdded);
@@ -54 +76 @@
       base.RemoveItemEvents();
     }
-
+    
+    /// <summary>
+    /// Adds eventhandlers to the underlying <see cref="ConstrainedItemList"/>.
+    /// </summary>
+    /// <remarks>Calls <see cref="HeuristicLab.Core.ViewBase.AddItemEvents"/> of base class <see cref="ViewBase"/>.
+    /// </remarks>
     protected override void AddItemEvents() {
       base.AddItemEvents();
@@ -62 +89 @@
     }
 
+    /// <summary>
+    /// Updates all controls with the latest elements in the list.
+    /// </summary>
     protected override void UpdateControls() {
       base.UpdateControls();