CommandifiedList(T) Class

CommandifiedListT Class

Generic list class which is command-aware: it performs its actions through commands, so all actions on this list are undoable.

Inheritance Hierarchy

SystemObject
  System.Collections.ObjectModelCollectionT
    SD.Tools.Algorithmia.GeneralDataStructuresCommandifiedListT
      More...

Namespace: SD.Tools.Algorithmia.GeneralDataStructures
Assembly: SD.Tools.Algorithmia (in SD.Tools.Algorithmia.dll) Version: 1.3.0.0 (1.3.17.0314)

Syntax

Copy

public class CommandifiedList<T> : Collection<T>, 
	IBindingList, IList, ICollection, IEnumerable

Public Class CommandifiedList(Of T)
	Inherits Collection(Of T)
	Implements IBindingList, IList, ICollection, IEnumerable

Type Parameters

T: The type of the element inside the list.

The CommandifiedListT type exposes the following members.

Constructors

	Name	Description
	CommandifiedListT	Initializes a new instance of the CommandifiedListT class. This instance is not synchronized.
	CommandifiedListT(Boolean)	Initializes a new instance of the CommandifiedListT class.

Top

Properties

	Name	Description
	AllowEdit	Gets whether you can update items in the list.
	AllowNew	Gets whether you can add items to the list using AddNew.
	AllowRemove	Gets whether you can remove items from the list, using Remove(Object) or RemoveAt(Int32).
	Count	Gets the number of elements actually contained in the CollectionT. (Inherited from CollectionT.)
	IsSorted	Gets whether the items in the list are sorted.
	IsSynchronized	Gets a value indicating whether access to the ICollection is synchronized (thread safe). Default: false. Set to true in the ctor to make sure the operations on this object are using locks. Use SyncRoot to lock on the same object as this class' internal operations.
	Item	Gets or sets the instance at the specified index. This is a redefinition, so the get can be synchronized if needed.
	Items	Gets a IListT wrapper around the CollectionT. (Inherited from CollectionT.)
	SortDirection	Gets the direction of the sort.
	SortProperty	Gets the PropertyDescriptor that is being used for sorting.
	SupportsChangeNotification	Gets whether a ListChanged event is raised when the list changes or an item in the list changes.
	SupportsSearching	Gets whether the list supports searching using the Find(PropertyDescriptor, Object) method.
	SupportsSorting	Gets whether the list supports sorting.
	SuppressEvents	Gets or sets a value indicating whether events are blocked from being raised (true) or not (false, default)
	SyncRoot	Gets an object that can be used to synchronize access to the ICollection. It's the same object used in locks inside this object.

Top

Methods

	Name	Description
	Add	Adds an object to the end of the CollectionT. (Inherited from CollectionT.)
	AddIndex	Adds the PropertyDescriptor to the indexes used for searching.
	AddNew	Adds a new item to the list.
	AddRange	Adds the elements in the range specified to this list in one command
	ApplySort	Sorts the list based on a PropertyDescriptor and a ListSortDirection.
	Clear	Removes all elements from the CollectionT. (Inherited from CollectionT.)
	ClearItems	Removes all elements from the CollectionT. (Overrides CollectionTClearItems.)
	Contains	Determines whether an element is in the CollectionT. (Inherited from CollectionT.)
	CopyTo	Copies the entire CollectionT to a compatible one-dimensional Array, starting at the specified index of the target array. (Inherited from CollectionT.)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	Find	Returns the index of the row that has the given PropertyDescriptor.
	GetEnumerator	Returns an enumerator that iterates through the CollectionT. (Inherited from CollectionT.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	IndexOf	Searches for the specified object and returns the zero-based index of the first occurrence within the entire CollectionT. (Inherited from CollectionT.)
	Insert	Inserts an element into the CollectionT at the specified index. (Inherited from CollectionT.)
	InsertItem	Inserts an element into the CollectionT at the specified index. (Overrides CollectionTInsertItem(Int32, T).)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	MoveElement	Moves the element at index currentIndex to the indexToMoveTo index.
	NotifyChange	Notifies a list change to observers with the parameters passed in.
	OnAddingItem	Called right before the item passed in is about to be added to this list. Use this method to do event handler housekeeping on elements in this list.
	OnAddingItemComplete	Called right after the item passed in has been added to the list
	OnClearing	Called right before the clear action starts. Use this method to do event handler housekeeping on elements in this list.
	OnClearingComplete	Called right after the clear action has been completed.
	OnElementPropertyChanged	Called when the PropertyChanged event was raised by an element in this list.
	OnRemovingItem	Called right before the item passed in is about to be removed from this list. Use this method to do event handler housekeeping on elements in this list.
	OnRemovingItemComplete	Called right after the item passed in has been removed from this list.
	PerformSyncedAction(Action)	Performs the specified action, either inside a lock on SyncRoot if this list is Synchronized, or normally, if this list isn't synchronized.
	PerformSyncedActionTFunc(FuncTFunc)	Performs the specified action, either inside a lock on SyncRoot if this list is Synchronized, or normally, if this list isn't synchronized.
	Remove	Removes the first occurrence of a specific object from the CollectionT. (Inherited from CollectionT.)
	RemoveAt	Removes the element at the specified index of the CollectionT. (Inherited from CollectionT.)
	RemoveIndex	Removes the PropertyDescriptor from the indexes used for searching.
	RemoveItem	Removes the element at the specified index of the CollectionT. (Overrides CollectionTRemoveItem(Int32).)
	RemoveSort	Removes any sort applied using ApplySort(PropertyDescriptor, ListSortDirection).
	ResetBindings	Resets the bindings. Raises a ListChanged.Reset event
	SetItem	Replaces the element at the specified index. (Overrides CollectionTSetItem(Int32, T).)
	ToString	Returns a String that represents the current Object. (Overrides ObjectToString.)

Top

Events

	Name	Description
	ElementAdding	Raised when an element is about to be added. The addition of the element can be cancelled through the event arguments.
	ElementRemoved	Raised when an element was removed from this list. The element removed is contained in the event arguments. This event is necessary to be able to retrieve a removed element after it was removed from the list by an observer, as ListChanged only contains indexes, and the index of a removed element isn't valid after it's been removed from the list.
	ElementRemoving	Raised when an element is about to be removed. The removal of the element can be cancelled through the event arguments.
	ListChanged	Occurs when the list changes or an item in the list changes.
	ListClearing	Raised when this list is about to be cleared completely. The clearing of the list can be cancelled through the event arguments.

Top

Extension Methods

	Name	Description
	BinarySearchT	Searches for the element specified in the sorted list specified using binary search http://en.wikipedia.org/wiki/Binary_search. The algorithm is re-implemented here to be able to search in any sorted IList implementing data structure (.NET's BCL only implements BinarySearch on arrays and List(Of T). If no IComparer(Of T) is available, try using Algorithmia's ComparisonBasedComparer, (Defined by IListExtensionMethods.)
	ToReadOnlyCollectionTDestination	Converts the enumerable to a ReadOnlyCollection. (Defined by IEnumerableExtensionMethods.)

Top

Explicit Interface Implementations

	Name	Description
	IListAdd	Adds an item to the IList. (Inherited from CollectionT.)
	IListContains	Determines whether the IList contains a specific value. (Inherited from CollectionT.)
	ICollectionCopyTo	Copies the elements of the ICollection to an Array, starting at a particular Array index. (Inherited from CollectionT.)
	IEnumerableGetEnumerator	Returns an enumerator that iterates through a collection. (Inherited from CollectionT.)
	IListIndexOf	Determines the index of a specific item in the IList. (Inherited from CollectionT.)
	IListInsert	Inserts an item into the IList at the specified index. (Inherited from CollectionT.)
	IListIsFixedSize	Gets a value indicating whether the IList has a fixed size. (Inherited from CollectionT.)
	ICollectionTIsReadOnly	Gets a value indicating whether the ICollectionT is read-only. (Inherited from CollectionT.)
	IListIsReadOnly	Gets a value indicating whether the IList is read-only. (Inherited from CollectionT.)
	ICollectionIsSynchronized	Gets a value indicating whether access to the ICollection is synchronized (thread safe). (Inherited from CollectionT.)
	IListItem	Gets or sets the element at the specified index. (Inherited from CollectionT.)
	IListRemove	Removes the first occurrence of a specific object from the IList. (Inherited from CollectionT.)
	ICollectionSyncRoot	Gets an object that can be used to synchronize access to the ICollection. (Inherited from CollectionT.)

Top

Remarks

This class implements IBindingList and not WPF's INotifyCollectionChanged, because the latter isn't recognized by Winforms controls, hence the IBindingList interface implementation. Due to the nature of IBindingList, an extra event has been added for retrieving a removed element by an observer

This class can be a synchronized collection by passing true for isSynchronized in the constructor. To synchronize access to the contents of this class, lock on the SyncRoot object.

Reference

SD.Tools.Algorithmia.GeneralDataStructures Namespace

Inheritance Hierarchy