如何创建只读的ObservableCollection属性?

时间:2009-11-19 14:33:38

标签: c# .net wpf observablecollection

我想在包含对象列表的视图模型上公开一个属性(来自数据库)。

我需要这个集合是只读的。也就是说,我想阻止添加/删除等。但是允许foreach和indexers工作。我的目的是声明一个包含可编辑集合的私有字段,并使用只读公共属性引用它。如下

public ObservableCollection<foo> CollectionOfFoo { 
     get { 
         return _CollectionOfFoo;
     }
}

但是,该语法只会阻止更改对集合的引用。它不会阻止添加/删除等。

实现这一目标的正确方法是什么?

5 个答案:

答案 0 :(得分:60)

[previous] 接受的答案实际上会在每次访问ReadOnlyFoo时返回不同的 ReadOnlyObservableCollection。这很浪费,可能导致细微的错误。

一个更好的解决方案是:

public class Source
{
    Source()
    {
        m_collection = new ObservableCollection<int>();
        m_collectionReadOnly = new ReadOnlyObservableCollection<int>(m_collection);
    }

    public ReadOnlyObservableCollection<int> Items
    {
        get { return m_collectionReadOnly; }
    }

    readonly ObservableCollection<int> m_collection;
    readonly ReadOnlyObservableCollection<int> m_collectionReadOnly;
}

请参阅ReadOnlyObservableCollection anti-pattern进行完整讨论。

答案 1 :(得分:8)

我不喜欢使用ReadOnlyObservableCollection<T>,因为它似乎是一个错误/破坏的类;我更喜欢基于合同的方法。

以下是我使用的允许共变的内容:

public interface INotifyCollection<T> 
       : ICollection<T>, 
         INotifyCollectionChanged
{}

public interface IReadOnlyNotifyCollection<out T> 
       : IReadOnlyCollection<T>, 
         INotifyCollectionChanged
{}

public class NotifyCollection<T> 
       : ObservableCollection<T>, 
         INotifyCollection<T>, 
         IReadOnlyNotifyCollection<T>
{}

public class Program
{
    private static void Main(string[] args)
    {
        var full = new NotifyCollection<string>();
        var readOnlyAccess = (IReadOnlyCollection<string>) full;
        var readOnlyNotifyOfChange = (IReadOnlyNotifyCollection<string>) full;


        //Covarience
        var readOnlyListWithChanges = 
            new List<IReadOnlyNotifyCollection<object>>()
                {
                    new NotifyCollection<object>(),
                    new NotifyCollection<string>(),
                };
    }
}

答案 2 :(得分:0)

您可以将属性的类型更改为IEnumerable:

public IEnumerable<foo> CollectionOfFoo { 
     get { 
         return _CollectionOfFoo;
     }
}

我不相信有一个标准接口可以公开索引器。如果需要,可以编写一个接口并扩展ObservableCollection来实现它:

public interface IIndexerCollection<T> : IEnumerable<T>
{
    T this[int i]
    {
        get;
    }
}

public class IndexCollection<T> : ObservableCollection<T>, IIndexerCollection<T>
{
}

答案 3 :(得分:0)

使用ReadOnlyObservableCollection< T >

public ReadOnlyObservableCollection<T> ReadOnlyFoo
{
    get { return new ReadOnlyObservableCollection<T> (_CollectionOfFoo); }
}

正如已经指出的那样,请使用Eric J的答案,因为这个错误地每次都会返回一个新实例。

答案 4 :(得分:-1)

您还可以覆盖正在使用的列表类,并在其中一个构造函数中放置一个不可变标志,以便在将immutable标志设置为true的情况下构造它时不会添加/删除。