Click or drag to resize

DocumentFieldDefinitionList Class

Class which defines a list for document fields.
Inheritance Hierarchy
SystemObject
  System.Collections.ObjectModelCollectionDocumentFieldDefinition
    SD.Tools.Algorithmia.GeneralDataStructuresCommandifiedListDocumentFieldDefinition
      SD.LLBLGen.Pro.ApplicationCore.DerivedModelDocumentFieldDefinitionList

Namespace:  SD.LLBLGen.Pro.ApplicationCore.DerivedModel
Assembly:  SD.LLBLGen.Pro.ApplicationCore (in SD.LLBLGen.Pro.ApplicationCore.dll) Version: 5.11.0.0 (5.11.23.1114)
Syntax
public class DocumentFieldDefinitionList : CommandifiedList<DocumentFieldDefinition>

The DocumentFieldDefinitionList type exposes the following members.

Constructors
  NameDescription
Public methodDocumentFieldDefinitionList
Initializes a new instance of the DocumentFieldDefinitionList class.
Top
Properties
  NameDescription
Public propertyAllowEdit
Gets whether you can update items in the list.
(Inherited from CommandifiedListT.)
Public propertyAllowNew (Inherited from CommandifiedListT.)
Public propertyAllowRemove
Gets whether you can remove items from the list, using Remove(Object) or RemoveAt(Int32).
(Inherited from CommandifiedListT.)
Public propertyContainingDocument
Public propertyCount (Inherited from CollectionDocumentFieldDefinition.)
Public propertyIsSorted
Gets whether the items in the list are sorted.
(Inherited from CommandifiedListT.)
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 CommandifiedListT.)
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 CommandifiedListT.)
Protected propertyItems (Inherited from CollectionDocumentFieldDefinition.)
Public propertySortDirection
Gets the direction of the sort.
(Inherited from CommandifiedListT.)
Public propertySortProperty
Gets the PropertyDescriptor that is being used for sorting.
(Inherited from CommandifiedListT.)
Public propertySupportsChangeNotification
Gets whether a ListChanged event is raised when the list changes or an item in the list changes.
(Inherited from CommandifiedListT.)
Public propertySupportsSearching
Gets whether the list supports searching using the Find(PropertyDescriptor, Object) method.
(Inherited from CommandifiedListT.)
Public propertySupportsSorting
Gets whether the list supports sorting.
(Inherited from CommandifiedListT.)
Public propertySuppressEvents
Gets or sets a value indicating whether events are blocked from being raised (true) or not (false, default)
(Inherited from CommandifiedListT.)
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 CommandifiedListT.)
Top
Methods
  NameDescription
Public methodAdd (Inherited from CollectionDocumentFieldDefinition.)
Public methodAddIndex
Adds the PropertyDescriptor to the indexes used for searching.
(Inherited from CommandifiedListT.)
Public methodAddNew
Adds a new item to the list.
(Inherited from CommandifiedListT.)
Public methodAddRange
Adds the elements in the range specified to this list in one command
(Inherited from CommandifiedListT.)
Public methodApplySort
Sorts the list based on a PropertyDescriptor and a ListSortDirection.
(Inherited from CommandifiedListT.)
Public methodClear (Inherited from CollectionDocumentFieldDefinition.)
Protected methodClearItems (Inherited from CommandifiedListT.)
Public methodContains (Inherited from CollectionDocumentFieldDefinition.)
Public methodCopyTo (Inherited from CollectionDocumentFieldDefinition.)
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 CommandifiedListT.)
Public methodGetEnumerator (Inherited from CollectionDocumentFieldDefinition.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIndexOf (Inherited from CollectionDocumentFieldDefinition.)
Public methodInsert (Inherited from CollectionDocumentFieldDefinition.)
Protected methodInsertItem (Inherited from CommandifiedListT.)
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 CommandifiedListT.)
Protected methodNotifyChange
Notifies a list change to observers with the parameters passed in.
(Inherited from CommandifiedListT.)
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 CommandifiedListTOnAddingItem(T).)
Protected methodOnAddingItemComplete
Called right after the item passed in has been added to the list
(Inherited from CommandifiedListT.)
Protected methodOnClearing
Called right before the clear action starts. Use this method to do event handler housekeeping on elements in this list.
(Overrides CommandifiedListTOnClearing.)
Protected methodOnClearingComplete
Called right after the clear action has been completed.
(Inherited from CommandifiedListT.)
Protected methodOnElementPropertyChanged
Called when the PropertyChanged event was raised by an element in this list.
(Inherited from CommandifiedListT.)
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 CommandifiedListTOnRemovingItem(T).)
Protected methodOnRemovingItemComplete
Called right after the item passed in has been removed from this list.
(Inherited from CommandifiedListT.)
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 CommandifiedListT.)
Protected methodPerformSyncedActionTFunc(FuncTFunc)
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 CommandifiedListT.)
Public methodRemove (Inherited from CollectionDocumentFieldDefinition.)
Public methodRemoveAt (Inherited from CollectionDocumentFieldDefinition.)
Public methodRemoveIndex
Removes the PropertyDescriptor from the indexes used for searching.
(Inherited from CommandifiedListT.)
Protected methodRemoveItem (Inherited from CommandifiedListT.)
Public methodRemoveSort
Removes any sort applied using ApplySort(PropertyDescriptor, ListSortDirection).
(Inherited from CommandifiedListT.)
Public methodResetBindings
Resets the bindings. Raises a ListChanged.Reset event
(Inherited from CommandifiedListT.)
Public methodSerializeToWriter
Serializes the source to the serializer specified.
Protected methodSetItem
Replaces the element at the specified index.
(Inherited from CommandifiedListT.)
Public methodToString
Returns a String that represents the current Object.
(Inherited from CommandifiedListT.)
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 CommandifiedListT.)
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 CommandifiedListT.)
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 CommandifiedListT.)
Public eventListChanged
Occurs when the list changes or an item in the list changes.
(Inherited from CommandifiedListT.)
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 CommandifiedListT.)
Top
Explicit Interface Implementations
  NameDescription
Explicit interface implementationPrivate methodIListAdd
Adds an item to the IList.
(Inherited from CollectionDocumentFieldDefinition.)
Explicit interface implementationPrivate methodIListContains
Determines whether the IList contains a specific value.
(Inherited from CollectionDocumentFieldDefinition.)
Explicit interface implementationPrivate methodICollectionCopyTo
Copies the elements of the ICollection to an Array, starting at a particular Array index.
(Inherited from CollectionDocumentFieldDefinition.)
Explicit interface implementationPrivate methodIEnumerableGetEnumerator
Returns an enumerator that iterates through a collection.
(Inherited from CollectionDocumentFieldDefinition.)
Explicit interface implementationPrivate methodIListIndexOf
Determines the index of a specific item in the IList.
(Inherited from CollectionDocumentFieldDefinition.)
Explicit interface implementationPrivate methodIListInsert
Inserts an item into the IList at the specified index.
(Inherited from CollectionDocumentFieldDefinition.)
Explicit interface implementationPrivate propertyIListIsFixedSize
Gets a value indicating whether the IList has a fixed size.
(Inherited from CollectionDocumentFieldDefinition.)
Explicit interface implementationPrivate propertyICollectionTIsReadOnly (Inherited from CollectionDocumentFieldDefinition.)
Explicit interface implementationPrivate propertyIListIsReadOnly
Gets a value indicating whether the IList is read-only.
(Inherited from CollectionDocumentFieldDefinition.)
Explicit interface implementationPrivate propertyICollectionIsSynchronized
Gets a value indicating whether access to the ICollection is synchronized (thread safe).
(Inherited from CollectionDocumentFieldDefinition.)
Explicit interface implementationPrivate propertyIListItem
Gets or sets the element at the specified index.
(Inherited from CollectionDocumentFieldDefinition.)
Explicit interface implementationPrivate methodIListRemove
Removes the first occurrence of a specific object from the IList.
(Inherited from CollectionDocumentFieldDefinition.)
Explicit interface implementationPrivate propertyICollectionSyncRoot
Gets an object that can be used to synchronize access to the ICollection.
(Inherited from CollectionDocumentFieldDefinition.)
Top
See Also