Click or drag to resize

DocumentDefinitionList<T> Class

Class which defines a list of document definitions and performs auto-maintenance on itself based on what happens with the contents.
Inheritance Hierarchy
System.Object
  System.Collections.ObjectModel.Collection<T>
    SD.Tools.Algorithmia.GeneralDataStructures.CommandifiedList<T>
      SD.LLBLGen.Pro.ApplicationCore.DerivedModel.DocumentDefinitionList<T>
        SD.LLBLGen.Pro.ApplicationCore.DerivedModel.DerivedModelDefinition

Namespace:  SD.LLBLGen.Pro.ApplicationCore.DerivedModel
Assembly:  SD.LLBLGen.Pro.ApplicationCore (in SD.LLBLGen.Pro.ApplicationCore.dll) Version: 5.4.0.0 (5.4.0)
Syntax
public class DocumentDefinitionList<T> : CommandifiedList<T>, 
	ISerializableToXml
where T : new(), DocumentDefinitionBase

Type Parameters

T

The DocumentDefinitionList<T> type exposes the following members.

Constructors
  NameDescription
Public methodDocumentDefinitionList<T>
Initializes a new instance of the DocumentDefinitionList<T> class.
Top
Properties
  NameDescription
Public propertyAllowEdit
Gets whether you can update items in the list.
(Inherited from CommandifiedList<T>.)
Public propertyAllowNew (Inherited from CommandifiedList<T>.)
Public propertyAllowRemove
Gets whether you can remove items from the list, using Remove(Object) or RemoveAt(Int32).
(Inherited from CommandifiedList<T>.)
Public propertyCount (Inherited from Collection<T>.)
Protected propertyDeserializing
Gets a value indicating whether this DocumentDefinitionList<T> is deserializing.
Public propertyIsSorted
Gets whether the items in the list are sorted.
(Inherited from CommandifiedList<T>.)
Public propertyIsSynchronized
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.
(Inherited from CommandifiedList<T>.)
Public propertyItem
Gets or sets the instance at the specified index. This is a redefinition, so the get can be synchronized if needed.
(Inherited from CommandifiedList<T>.)
Protected propertyItems (Inherited from Collection<T>.)
Public propertySortDirection
Gets the direction of the sort.
(Inherited from CommandifiedList<T>.)
Public propertySortProperty
Gets the PropertyDescriptor that is being used for sorting.
(Inherited from CommandifiedList<T>.)
Public propertySupportsChangeNotification
Gets whether a ListChanged event is raised when the list changes or an item in the list changes.
(Inherited from CommandifiedList<T>.)
Public propertySupportsSearching
Gets whether the list supports searching using the Find(PropertyDescriptor, Object) method.
(Inherited from CommandifiedList<T>.)
Public propertySupportsSorting
Gets whether the list supports sorting.
(Inherited from CommandifiedList<T>.)
Public propertySuppressEvents
Gets or sets a value indicating whether events are blocked from being raised (true) or not (false, default)
(Inherited from CommandifiedList<T>.)
Public propertySyncRoot
Gets an object that can be used to synchronize access to the ICollection. It's the same object used in locks inside this object.
(Inherited from CommandifiedList<T>.)
Protected propertyXmlElementName
Gets or sets the name of the XML element of this object.
Top
Methods
  NameDescription
Public methodAdd (Inherited from Collection<T>.)
Public methodAddIndex
Adds the PropertyDescriptor to the indexes used for searching.
(Inherited from CommandifiedList<T>.)
Public methodAddNew
Adds a new item to the list.
(Inherited from CommandifiedList<T>.)
Public methodAddRange
Adds the elements in the range specified to this list in one command
(Inherited from CommandifiedList<T>.)
Public methodApplySort
Sorts the list based on a PropertyDescriptor and a ListSortDirection.
(Inherited from CommandifiedList<T>.)
Protected methodBindAdditionalEvents
Binds the additional event handlers of contained elements in derived classes.
Public methodClear (Inherited from Collection<T>.)
Protected methodClearItems (Inherited from CommandifiedList<T>.)
Public methodContains (Inherited from Collection<T>.)
Public methodCopyTo (Inherited from Collection<T>.)
Protected methodDeserializeAdditionalAttributes
Deserializes the additional attributes of this class from the xml pointed at by the reader, which is at the startelement of this object.
Protected methodDeserializeAdditionalElements
Deserializes the additional elements from the reader. The reader will be placed on an element that's not recognized by the deserializer of this class.
Public methodDeserializeFromReader
Deserializes the data for this DerivedModelDefinition from the xml reader passed in. The reader is assumed to be at the start element of the DerivedModelDefinition
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodFind
Returns the index of the row that has the given PropertyDescriptor.
(Inherited from CommandifiedList<T>.)
Public methodGetEnumerator (Inherited from Collection<T>.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Protected methodGetOrderedEquivalent
Gets the ordered equivalent of this list. Needed for persistence.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIndexOf (Inherited from Collection<T>.)
Public methodInsert (Inherited from Collection<T>.)
Protected methodInsertItem (Inherited from CommandifiedList<T>.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodMoveElement
Moves the element at index currentIndex to the indexToMoveTo index.
(Inherited from CommandifiedList<T>.)
Protected methodNotifyChange
Notifies a list change to observers with the parameters passed in.
(Inherited from CommandifiedList<T>.)
Protected methodOnAddingItem
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.
(Overrides CommandifiedList<T>.OnAddingItem(T).)
Protected methodOnAddingItemComplete
Called right after the item passed in has been added to the list
(Inherited from CommandifiedList<T>.)
Protected methodOnClearing
Called right before the clear action starts. Use this method to do event handler housekeeping on elements in this list.
(Overrides CommandifiedList<T>.OnClearing().)
Protected methodOnClearingComplete
Called right after the clear action has been completed.
(Inherited from CommandifiedList<T>.)
Protected methodOnElementPropertyChanged
Called when the PropertyChanged event was raised by an element in this list.
(Inherited from CommandifiedList<T>.)
Protected methodOnRemovingItem
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.
(Overrides CommandifiedList<T>.OnRemovingItem(T).)
Protected methodOnRemovingItemComplete
Called right after the item passed in has been removed from this list.
(Inherited from CommandifiedList<T>.)
Protected methodPerformCleanupOnRemovedItem
performs tasks on the item which has been removed from this list.
Protected methodPerformSetupOnAddedItem
Performs the setup tasks on the item which has been added to this list.
Protected methodPerformSyncedAction(Action)
Performs the specified action, either inside a lock on SyncRoot if this list is Synchronized, or normally, if this list isn't synchronized.
(Inherited from CommandifiedList<T>.)
Protected methodPerformSyncedAction<TFunc>(Func<TFunc>)
Performs the specified action, either inside a lock on SyncRoot if this list is Synchronized, or normally, if this list isn't synchronized.
(Inherited from CommandifiedList<T>.)
Public methodRemove (Inherited from Collection<T>.)
Public methodRemoveAt (Inherited from Collection<T>.)
Public methodRemoveIndex
Removes the PropertyDescriptor from the indexes used for searching.
(Inherited from CommandifiedList<T>.)
Protected methodRemoveItem (Inherited from CommandifiedList<T>.)
Public methodRemoveSort
Removes any sort applied using ApplySort(PropertyDescriptor, ListSortDirection).
(Inherited from CommandifiedList<T>.)
Public methodResetBindings
Resets the bindings. Raises a ListChanged.Reset event
(Inherited from CommandifiedList<T>.)
Protected methodSerializeAdditionalAttributes
Serializes the additional attributes of this class to the start element.
Protected methodSerializeAdditionalElements
Serializes the additional elements inside the containing element of this class
Public methodSerializeToWriter
Serializes the data in this class to the serializer passed in
Protected methodSetItem
Replaces the element at the specified index.
(Inherited from CommandifiedList<T>.)
Public methodToString
Returns a String that represents the current Object.
(Inherited from CommandifiedList<T>.)
Protected methodUnbindAdditionalEvents
Unbinds the additional event handlers of contained elements in derived classes
Top
Events
  NameDescription
Public eventElementAdding
Raised when an element is about to be added. The addition of the element can be cancelled through the event arguments.
(Inherited from CommandifiedList<T>.)
Public eventElementRemoved
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.
(Inherited from CommandifiedList<T>.)
Public eventElementRemoving
Raised when an element is about to be removed. The removal of the element can be cancelled through the event arguments.
(Inherited from CommandifiedList<T>.)
Public eventListChanged
Occurs when the list changes or an item in the list changes.
(Inherited from CommandifiedList<T>.)
Public eventListClearing
Raised when this list is about to be cleared completely. The clearing of the list can be cancelled through the event arguments.
(Inherited from CommandifiedList<T>.)
Top
Explicit Interface Implementations
  NameDescription
Explicit interface implementationPrivate methodIList.Add
Adds an item to the IList.
(Inherited from Collection<T>.)
Explicit interface implementationPrivate methodIList.Contains
Determines whether the IList contains a specific value.
(Inherited from Collection<T>.)
Explicit interface implementationPrivate methodICollection.CopyTo
Copies the elements of the ICollection to an Array, starting at a particular Array index.
(Inherited from Collection<T>.)
Explicit interface implementationPrivate methodIEnumerable.GetEnumerator
Returns an enumerator that iterates through a collection.
(Inherited from Collection<T>.)
Explicit interface implementationPrivate methodIList.IndexOf
Determines the index of a specific item in the IList.
(Inherited from Collection<T>.)
Explicit interface implementationPrivate methodIList.Insert
Inserts an item into the IList at the specified index.
(Inherited from Collection<T>.)
Explicit interface implementationPrivate propertyIList.IsFixedSize
Gets a value indicating whether the IList has a fixed size.
(Inherited from Collection<T>.)
Explicit interface implementationPrivate propertyICollection<T>.IsReadOnly (Inherited from Collection<T>.)
Explicit interface implementationPrivate propertyIList.IsReadOnly
Gets a value indicating whether the IList is read-only.
(Inherited from Collection<T>.)
Explicit interface implementationPrivate propertyICollection.IsSynchronized
Gets a value indicating whether access to the ICollection is synchronized (thread safe).
(Inherited from Collection<T>.)
Explicit interface implementationPrivate propertyIList.Item
Gets or sets the element at the specified index.
(Inherited from Collection<T>.)
Explicit interface implementationPrivate methodIList.Remove
Removes the first occurrence of a specific object from the IList.
(Inherited from Collection<T>.)
Explicit interface implementationPrivate propertyICollection.SyncRoot
Gets an object that can be used to synchronize access to the ICollection.
(Inherited from Collection<T>.)
Top
See Also