Click or drag to resize

FieldListTField Class

Class which is usable as a fields list in entity elements. It's a specialization of the commandified list to add eventhandler logic.
Inheritance Hierarchy
SystemObject
  System.Collections.ObjectModelCollectionTField
    SD.Tools.Algorithmia.GeneralDataStructuresCommandifiedListTField
      SD.LLBLGen.Pro.ApplicationCore.EntityModelFieldElementCoreListTField
        SD.LLBLGen.Pro.ApplicationCore.EntityModelFieldListTField

Namespace:  SD.LLBLGen.Pro.ApplicationCore.EntityModel
Assembly:  SD.LLBLGen.Pro.ApplicationCore (in SD.LLBLGen.Pro.ApplicationCore.dll) Version: 5.4.0.0 (5.4.0)
Syntax
public class FieldList<TField> : FieldElementCoreList<TField>, 
	ISerializableToXml
where TField : FieldElement

Type Parameters

TField

The FieldListTField type exposes the following members.

Constructors
  NameDescription
Public methodFieldListTField
Initializes a new instance of the FieldListTField class.
Top
Properties
  NameDescription
Public propertyAllowEdit
Gets whether you can update items in the list.
(Inherited from CommandifiedListT.)
Public propertyAllowNew
Gets a value indicating whether a new instance can be created through databinding.
(Overrides CommandifiedListTAllowNew.)
Public propertyAllowRemove
Gets whether you can remove items from the list, using Remove(Object) or RemoveAt(Int32).
(Inherited from CommandifiedListT.)
Public propertyCount (Inherited from CollectionTField.)
Protected propertyDeserializing (Inherited from FieldElementCoreListTField.)
Public propertyFieldsAsString
Gets the fields as string, which means it returns a comma delimited list with all the field names in this UC.
(Inherited from FieldElementCoreListTField.)
Public propertyHasFieldOrdering
Gets a value indicating whether this instance has a field ordering defined. If at least 1 field has a field index of 0 or higher, this class will assume there is a field ordering and will return true.
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 CollectionTField.)
Public propertyNewElementFactoryFunc
Gets or sets the new element factory func. This func is used to produce new instances in databinding scenario's
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 CollectionTField.)
Public methodAddIndex
Adds the PropertyDescriptor to the indexes used for searching.
(Inherited from CommandifiedListT.)
Public methodAddNew
Creates a new instance of the elements contained in this List.
(Overrides CommandifiedListTAddNew.)
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 CollectionTField.)
Protected methodClearItems (Inherited from CommandifiedListT.)
Public methodContains (Inherited from CollectionTField.)
Public methodCopyTo (Inherited from CollectionTField.)
Public methodDeserializeFromReader
Deserializes the data for this class from the xml reader passed in
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 CollectionTField.)
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 CollectionTField.)
Public methodInsert (Inherited from CollectionTField.)
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.
(Overrides CommandifiedListTNotifyChange(ListChangedType, Int32, Int32).)
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 FieldElementCoreListTFieldOnAddingItem(TField).)
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.
(Inherited from FieldElementCoreListTField.)
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 methodOnPropertyChanged
Called when a property has been changed.
(Inherited from FieldElementCoreListTField.)
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 FieldElementCoreListTFieldOnRemovingItem(TField).)
Protected methodOnRemovingItemComplete
Called right after the item passed in was removed from this list.
(Overrides CommandifiedListTOnRemovingItemComplete(T).)
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.)
Protected methodPrepareFieldForListRemoval
Prepares the field for list removal.
(Overrides FieldElementCoreListTFieldPrepareFieldForListRemoval(TField).)
Protected methodPropagateValidatorsToLoadedObjects
Propagates the validators to loaded objects.
(Inherited from FieldElementCoreListTField.)
Public methodRemove (Inherited from CollectionTField.)
Public methodRemoveAt (Inherited from CollectionTField.)
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 methodResetFieldOrdering
Resets the field ordering. It will set all field's FieldIndex properties to -1.
Protected methodSerializeField
Serializes the field to the writer specified.
Public methodSerializeToWriter
Serializes the data in this class to the serializer passed in
Public methodSetAsNewContents
Sets the fields passed in as the new contents of this list. This is a separate routine, so the multiple actions taken are wrappeable into one command
(Inherited from FieldElementCoreListTField.)
Protected methodSetItem
Replaces the element at the specified index.
(Inherited from CommandifiedListT.)
Protected methodSetValidatorsForField
Sets the validators for field.
(Overrides FieldElementCoreListTFieldSetValidatorsForField(TField).)
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 eventFieldElementCoreInListChanged
Event which is raised when one of the fields inside this list has changed.
(Inherited from FieldElementCoreListTField.)
Public eventFieldIndexesUpdated
Event which is raised when the field indexes are updated.
Public eventFieldInListChanged
Event which is raised when one of the fields inside this list has changed.
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.)
Public eventPropertyChanged
Occurs when a property value changes.
(Inherited from FieldElementCoreListTField.)
Top
Explicit Interface Implementations
  NameDescription
Explicit interface implementationPrivate methodIListAdd
Adds an item to the IList.
(Inherited from CollectionTField.)
Explicit interface implementationPrivate methodIListContains
Determines whether the IList contains a specific value.
(Inherited from CollectionTField.)
Explicit interface implementationPrivate methodICollectionCopyTo
Copies the elements of the ICollection to an Array, starting at a particular Array index.
(Inherited from CollectionTField.)
Explicit interface implementationPrivate methodIEnumerableGetEnumerator
Returns an enumerator that iterates through a collection.
(Inherited from CollectionTField.)
Explicit interface implementationPrivate methodIListIndexOf
Determines the index of a specific item in the IList.
(Inherited from CollectionTField.)
Explicit interface implementationPrivate methodIListInsert
Inserts an item into the IList at the specified index.
(Inherited from CollectionTField.)
Explicit interface implementationPrivate propertyIListIsFixedSize
Gets a value indicating whether the IList has a fixed size.
(Inherited from CollectionTField.)
Explicit interface implementationPrivate propertyICollectionTIsReadOnly (Inherited from CollectionTField.)
Explicit interface implementationPrivate propertyIListIsReadOnly
Gets a value indicating whether the IList is read-only.
(Inherited from CollectionTField.)
Explicit interface implementationPrivate propertyICollectionIsSynchronized
Gets a value indicating whether access to the ICollection is synchronized (thread safe).
(Inherited from CollectionTField.)
Explicit interface implementationPrivate propertyIListItem
Gets or sets the element at the specified index.
(Inherited from CollectionTField.)
Explicit interface implementationPrivate methodIListRemove
Removes the first occurrence of a specific object from the IList.
(Inherited from CollectionTField.)
Explicit interface implementationPrivate propertyICollectionSyncRoot
Gets an object that can be used to synchronize access to the ICollection.
(Inherited from CollectionTField.)
Top
See Also