Реализация шаблона наблюдателя с winforms

Question

У меня есть одна коллекция объектов, с которой многие из моих форм (использующие WeifenLuo.WinFormsUI.Docking) должны взаимодействовать.

, т. Е. Если коллекция имеет добавление (или удаление), выполненное в одной форме, тодругие формы отвечают обновлением своих представлений.

Очевидно, что образец наблюдателя был бы хорошим кандидатом здесь.Однако у меня возникают проблемы при попытке реализовать это в моей программе.

Сначала казалось, что лучше всего создать класс наблюдателя для моей коллекции следующим образом:

public class DataCollectionObserver : Form
{
    internal static void DataCollectionRegister(DataCollection dataCollection)
    {
        dataCollection.ImageAdded += new EventHandler(dataAdded);
        dataCollection.ImageRemoved += new EventHandler(dataRemoved);
        dataCollection.ImageIndexChanged += new EventHandler(dataIndexChanged);
        dataCollection.ImageListCleared += new EventHandler(dataListCleared);
    }

    internal static void DataCollectionUnRegister(DataCollection dataCollection)
    {
        dataCollection.ImageAdded -= new EventHandler(dataAdded);
        dataCollection.ImageRemoved -= new EventHandler(dataRemoved);
        dataCollection.ImageIndexChanged -= new EventHandler(dataIndexChanged);
        dataCollection.ImageListCleared -= new EventHandler(dataListCleared);
    }

    internal static void dataAdded(object sender, EventArgs e) {}
    internal static void dataRemoved(object sender, EventArgs e) {}
    internal static void dataIndexChanged(object sender, EventArgs e) {}
    internal static void dataListCleared(object sender, EventArgs e) {}
}

Затем переопределить базовое событие.обработчики в подклассах?

Но я не могу сделать это и использовать библиотеку WeifenLuo.WinFormsUI.Docking ...

Что ж, я мог бы заставить DataCollectionObserver наследовать DockContent от WeifenLuo.WinFormsUI.Docking., но это создает ситуацию, когда мне нужно иметь два класса DataCollectionObserver - один, который наследует Form, и другой, который наследует DockContent: - [, или я мог бы сделать DataCollectionObserver интерфейсом, но это все равно оставляет меня с дублирующимся кодом, лежащим около ...

Итак, у кого-нибудь есть предложение?Я упускаю что-то очевидное или это ситуация, когда ради простоты дублирование кода должно быть сделано?

---

Редактировать: //

У меня нет проблем с получением уведомлений в моих формах.На самом деле, все это работает прямо сейчас.Причина, по которой я спрашиваю, состоит в том, что все это «пахнет» из-за блочного копирования и вставки кода в этих четырех различных формах, которые у меня есть, которые подписываются на события коллекции и отписываются от Form.Closing ().

То, что я хотел бы сделать, это реализовать поведение, которое я скопировал и вставил в эти четыре формы в одном месте, и чтобы формы, которые должны получать уведомления об изменениях в коллекции, реализовывали это поведение по мере необходимости.

Надеюсь, что это делаетвсе понятно?

FWIW, это мой класс коллекции:

using System;
using System.Collections;
using System.Reflection;

namespace MyNameSpace.Collections
{
    /// <summary>
    /// Generic Collection of Objects with Events
    /// </summary>
    public class CollectionWithEvents<T> : CollectionBase
    {
        public bool SuppressEventNotification
        {
            get;
            set;
        }

        public CollectionWithEvents()
        {
            SuppressEventNotification = false;
        }

        #region Events
        /// <summary>
        /// Raises before an item is added to the list.
        /// </summary>
        public event EventHandler<ItemEventArgs<T>> BeforeItemAdded;

        /// <summary>
        /// Raises when an item is added to the list.
        /// </summary>
        public event EventHandler<ItemEventArgs<T>> ItemAdded;

        /// <summary>
        /// Raises before a collection of items is added to the list.
        /// </summary>
        public event EventHandler<ItemsEventArgs<T>> BeforeItemsAdded;

        /// <summary>
        /// Raises when a collection of items is added to the list.
        /// </summary>
        public event EventHandler<ItemsEventArgs<T>> ItemsAdded;

        /// <summary>
        /// Raises before an item is changed in the list.
        /// </summary>
        public event EventHandler<ItemEventArgs<T>> BeforeItemChanged;

        /// <summary>
        /// Raises when an item is changed in the list.
        /// </summary>
        public event EventHandler<ItemEventArgs<T>> ItemChanged;

        /// <summary>
        /// Raises before an item is removed from the list.
        /// </summary>
        public event EventHandler<ItemEventArgs<T>> BeforeItemRemoved;

        /// <summary>
        /// Raises when an item is removed from the list.
        /// </summary>
        public event EventHandler<ItemEventArgs<T>> ItemRemoved;

        /// <summary>
        /// Raises when the items are cleared from the list.
        /// </summary>
        public event EventHandler<EventArgs> ItemsCleared;
        #endregion

        public T this[int index]
        {
            get { return (T)this.List[index]; }
            set
            {
                if (!SuppressEventNotification)
                {
                    OnBeforeItemChanged(this, new ItemEventArgs<T>(value));
                }

                this.List[index] = value;

                if (!SuppressEventNotification)
                {
                    OnItemChanged(this, new ItemEventArgs<T>(value));
                }
            }
        }

        public int Add(T item)
        {
            if (!SuppressEventNotification)
            {
                OnBeforeItemAdded(this, new ItemEventArgs<T>(item));
            }

            int retValue = this.List.Add(item);

            if (!SuppressEventNotification)
            {
                OnItemAdded(this, new ItemEventArgs<T>(item));
            }

            return retValue;
        }

        public void AddRange(Collection<T> collection)
        {
            T[] tmp = new T[collection.Count];

            collection.CopyTo(tmp, 0);

            AddRange(tmp);
        }

        public void AddRange(T[] collection)
        {
            if (!SuppressEventNotification)
            {
                OnBeforeItemsAdded(this, new ItemsEventArgs<T>(collection));
            }

            this.AddRange(collection);

            if (!SuppressEventNotification)
            {
                OnItemsAdded(this, new ItemsEventArgs<T>(collection));
            }
        }

        public bool Contains(T item)
        {
            return this.List.Contains(item);
        }

        public void CopyTo(Array array, int index)
        {
            this.List.CopyTo(array, index);
        }

        public int IndexOf(T item)
        {
            return this.List.IndexOf(item);
        }

        public void Insert(int index, T item)
        {
            this.List.Insert(index, item);
        }

        public void Remove(T item)
        {
            if (!SuppressEventNotification)
            {
                OnBeforeItemRemoved(this, new ItemEventArgs<T>(item));
            }

            T tmp = (T)item;

            this.List.Remove(item);

            if (!SuppressEventNotification)
            {
                OnItemRemoved(this, new ItemEventArgs<T>(tmp));
            }

            tmp = default(T);
        }

        public void Sort(string Property, Common.SortOrder Order)
        {
            Common.GenericComparer genericComparer = new Common.GenericComparer(Property, Order);
            this.InnerList.Sort(genericComparer);
        }

        #region Event Methods
        /// <summary>
        /// Raised before an Item is added to the list.
        /// </summary>
        /// <param name="sender">object</param>
        /// <param name="e">ItemEventArgs</param>
        protected virtual void OnBeforeItemAdded(object sender, ItemEventArgs<T> e)
        {
            if (BeforeItemAdded != null)
            {
                BeforeItemAdded(sender, e);
            }
        }

        /// <summary>
        /// Raised when an Item is added to the list.
        /// </summary>
        /// <param name="sender"></param>
        /// <param name="e">ItemEventArgs</param>
        protected virtual void OnItemAdded(object sender, ItemEventArgs<T> e)
        {
            if (ItemAdded != null)
            {
                ItemAdded(sender, e);
            }
        }

        /// <summary>
        /// Raised before a collection of Items is added to the list.
        /// </summary>
        /// <param name="sender">object</param>
        /// <param name="e">ItemEventArgs</param>
        protected virtual void OnBeforeItemsAdded(object sender, ItemsEventArgs<T> e)
        {
            if (BeforeItemsAdded != null)
            {
                BeforeItemsAdded(sender, e);
            }
        }

        /// <summary>
        /// Raised when a collection of Items is added to the list.
        /// </summary>
        /// <param name="sender"></param>
        /// <param name="e">ItemEventArgs</param>
        protected virtual void OnItemsAdded(object sender, ItemsEventArgs<T> e)
        {
            if (ItemsAdded != null)
            {
                ItemsAdded(sender, e);
            }
        }

        /// <summary>
        /// Raised before an Item is changed to the list.
        /// </summary>
        /// <param name="sender"></param>
        /// <param name="e">GenericItemEventArgs</param>
        protected virtual void OnBeforeItemChanged(object sender, ItemEventArgs<T> e)
        {
            if (BeforeItemChanged != null)
            {
                BeforeItemChanged(sender, e);
            }
        }

        /// <summary>
        /// Raised when an Item is changed to the list.
        /// </summary>
        /// <param name="sender"></param>
        /// <param name="e">ItemEventArgs</param>
        protected virtual void OnItemChanged(object sender, ItemEventArgs<T> e)
        {
            if (ItemChanged != null)
            {
                ItemChanged(sender, e);
            }
        }

        /// <summary>
        /// Raised before an Item is removed from the list.
        /// </summary>
        /// <param name="sender"></param>
        /// <param name="e">ItemEventArgs</param>
        protected virtual void OnBeforeItemRemoved(object sender, ItemEventArgs<T> e)
        {
            if (BeforeItemRemoved != null)
            {
                BeforeItemRemoved(sender, e);
            }
        }

        /// <summary>
        /// Raised when an Item is removed from the list.
        /// </summary>
        /// <param name="sender">object</param>
        /// <param name="e">ItemEventsArgs</param>
        protected virtual void OnItemRemoved(object sender, ItemEventArgs<T> e)
        {
            if (ItemRemoved != null)
            {
                ItemRemoved(sender, e);
            }
        }

        /// <summary>
        /// Raised when the Items are cleared from this list.
        /// </summary>
        /// <param name="sender">object</param>
        /// <param name="e">EventArgs</param>
        protected virtual void OnItemsCleared(object sender, EventArgs e)
        {
            if (ItemsCleared != null)
            {
                ItemsCleared(sender, e);
            }
        }
        #endregion
    }

    public class ItemEventArgs<T> : EventArgs
    {
        /// <summary>
        /// Item
        /// </summary>
        public T Item { get; private set; }

        /// <summary>
        /// Default constructor
        /// </summary>
        /// <param name="Item"></param>
        public ItemEventArgs(T Item)
        {
            this.Item = Item;
        }
    }

    public class ItemsEventArgs<T> : EventArgs
    {
        /// <summary>
        /// Items
        /// </summary>
        public T[] Items { get; private set; }

        /// <summary>
        /// Default constructor
        /// </summary>
        /// <param name="Items"></param>
        public ItemsEventArgs(T[] Items)
        {
            this.Items = Items;
        }
    }
}

Answer 1

Я могу ошибаться. Но вы могли бы сделать это таким образом, и ваша проблема наследования не будет присутствовать. Я постараюсь привести простой пример:

Класс вашей коллекции может быть такого рода:

public class MyCollection
    {
        IList<string> MyList { get; set; }

        public event EventHandler<StringEventArgs> OnAdded;
        public event EventHandler<StringEventArgs> OnRemoved;

        public MyCollection()
        {
            MyList = new List<string>();
        }

        public void Add(string s)
        {
            MyList.Add(s);

            if (OnAdded != null)
                OnAdded(this, new StringEventArgs() { StringAddedOrRemoved = s });
        }

        public void Remove(string s)
        {
            MyList.Remove(s);
            if (OnRemoved != null)
                OnRemoved(this, new StringEventArgs() { StringAddedOrRemoved = s });
        }
    }

Действительно простой класс с двумя настроенными EventHandlers:

public class StringEventArgs : EventArgs
    {
        public string StringAddedOrRemoved;


        public override string ToString()
        {
            return StringAddedOrRemoved;
        }
    }

Ничего сложного для понимания здесь и тогда, основываясь на трех формах, вы можете использовать свои формы таким образом.

Первая содержит две кнопки для взаимодействия с коллекцией и создает две формы, которые будут наблюдать за вашей коллекцией:

public partial class Form1 : Form
    {
        public static MyCollection collection;


        public Form1()
        {

            InitializeComponent();

            collection = new MyCollection();

            Form2 form2 = new Form2();
            form2.Show();

            Form3 form3 = new Form3();
            form3.Show();

            collection.OnAdded += form2.MyCollectionAdded;
            collection.OnRemoved += form2.MyCollectionRemoved;

            collection.OnAdded += form3.MyCollectionAdded;
            collection.OnRemoved += form3.MyCollectionRemoved;

        }

        private void Add_Click(object sender, EventArgs e)
        {
            collection.Add("test add");
        }

        private void button1_Click(object sender, EventArgs e)
        {
            collection.Remove("test add");
        }


    }

Коллекция связывается с каждой из функций форм, которые будут здесь наблюдаться:

collection.OnAdded += form2.MyCollectionAdded;
                collection.OnRemoved += form2.MyCollectionRemoved;

                collection.OnAdded += form3.MyCollectionAdded;
                collection.OnRemoved += form3.MyCollectionRemoved;

И поэтому нам нужно реализовать эти формы:

public partial class Form2 : Form
    {


        public string Name { get; set; }
        public bool Flag { get; set; }

        public Form2()
        {
            InitializeComponent();
        }

        public void MyCollectionAdded(object sender, StringEventArgs e)
        {
            //Some action
            Flag = true;
            label1.Text = string.Format("{0} has added {1} to its list, flag={2}", Name, e.StringAddedOrRemoved, Flag);
        }

        public void MyCollectionRemoved(object sender, StringEventArgs e)
        {
            //Some action
            Flag = false;
            label1.Text = string.Format("{0} has removed {1} from its list, flag={2}", Name, e.StringAddedOrRemoved, Flag);
        }
    }

Я наследую свои вещи от Формы, но они могут быть унаследованы от той формы, которая вам нужна. Если вы хотите разделить некоторый код между различными формами, подумайте о вспомогательных функциях в статическом классе или о любом шаблоне, который может удовлетворить ваши потребности.

Надеюсь, это немного поможет, и что я не совсем вне поля зрения!

[EDIT] Упс не видел Edit, извините, приятель! [/ EDIT]

Answer 2

В Framework есть «ObservableCollection» только для этого типа вещей.См. здесь .

Answer 3

Какую версию .net вы используете, если она> = 3.5, вы можете использовать ObservableCollection для достижения того, что вы делаете