ReadOnlyBindingList.cs

Go to the documentation of this file.

//-----------------------------------------------------------------------
// <copyright file="ReadOnlyBindingList.cs" company="Marimer LLC">
//     Copyright (c) Marimer LLC. All rights reserved.
//     Website: https://cslanet.com
// </copyright>
// <summary>A readonly version of BindingList(Of T)</summary>
//-----------------------------------------------------------------------
using System;
using Csla.Properties;
 
namespace Csla.Core
{
  [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Naming", 
    "CA1710:IdentifiersShouldHaveCorrectSuffix")]
  [Serializable()]
  public abstract class ReadOnlyBindingList<C> :
    Core.ExtendedBindingList<C>, Core.IBusinessObject, Core.IReadOnlyBindingList
  {
    #region Identity
 
    int IBusinessObject.Identity
    {
      get { return 0; }
    }
 
    #endregion
 
    private bool _isReadOnly = true;
 
    public bool IsReadOnly
    {
      get { return IsReadOnlyCore; }
      protected set { IsReadOnlyCore = value; }
    }
 
    protected virtual bool IsReadOnlyCore
    {
      get { return _isReadOnly; }
      set { _isReadOnly = value; }
    }
 
    bool Core.IReadOnlyBindingList.IsReadOnly
    {
      get { return IsReadOnly; }
      set { IsReadOnly = value; }
    }
 
    protected override void SetLoadListMode(bool enabled)
    {
      IsReadOnly = !enabled;
      base.SetLoadListMode(enabled);
    }
 
    protected ReadOnlyBindingList()
    {
      this.RaiseListChangedEvents = false;
      AllowEdit = false;
      AllowRemove = false;
      AllowNew = false;
      this.RaiseListChangedEvents = true;
    }
 
    protected override void ClearItems()
    {
      if (!IsReadOnly)
      {
        bool oldValue = AllowRemove;
        AllowRemove = true;
        base.ClearItems();
        AllowRemove = oldValue;
      }
      else
        throw new NotSupportedException(Resources.ClearInvalidException);
    }
 
#if NETFX_CORE || (ANDROID || IOS)
    protected override void AddNewCore()
    {
      if (!IsReadOnly)
        base.AddNewCore();
      else
        throw new NotSupportedException(Resources.InsertInvalidException);
    }
#else
    protected override object AddNewCore()
    {
      if (!IsReadOnly)
        return base.AddNewCore();
      else
        throw new NotSupportedException(Resources.InsertInvalidException);
    }
#endif
 
    protected override void InsertItem(int index, C item)
    {
      if (!IsReadOnly)
      {
        base.InsertItem(index, item);
      }
      else
        throw new NotSupportedException(Resources.InsertInvalidException);
    }
 
    protected override void RemoveItem(int index)
    {
      if (!IsReadOnly)
      {
        bool oldValue = AllowRemove;
        AllowRemove = true;
        base.RemoveItem(index);
        AllowRemove = oldValue;
      }
      else
        throw new NotSupportedException(Resources.RemoveInvalidException);
    }
 
    protected override void SetItem(int index, C item)
    {
      if (!IsReadOnly)
      {
        base.SetItem(index, item);
      }
      else
        throw new NotSupportedException(Resources.ChangeInvalidException);
    }
 
#region ITrackStatus
 
    public override bool IsBusy
    {
      get
      {
        // run through all the child objects
        // and if any are dirty then then
        // collection is dirty
        foreach (C child in this)
        {
          INotifyBusy busy = child as INotifyBusy;
          if (busy != null && busy.IsBusy)
            return true;
        }
 
        return false;
      }
    }
 
#endregion
 
#region MobileFormatter
 
    protected override void OnGetState(Csla.Serialization.Mobile.SerializationInfo info)
    {
      base.OnGetState(info);
      info.AddValue("Csla.Core.ReadOnlyBindingList._isReadOnly", _isReadOnly);
    }
 
    protected override void OnSetState(Csla.Serialization.Mobile.SerializationInfo info)
    {
      base.OnSetState(info);
      _isReadOnly = info.GetValue<bool>("Csla.Core.ReadOnlyBindingList._isReadOnly");
    }
 
    protected override void OnSetChildren(Csla.Serialization.Mobile.SerializationInfo info, Csla.Serialization.Mobile.MobileFormatter formatter)
    {
      var old = IsReadOnly;
      IsReadOnly = false;
      base.OnSetChildren(info, formatter);
      IsReadOnly = old;
    }
 
#endregion
  }
}