EntityViewBase(TEntity) Class

EntityViewBaseTEntity Class

Generic entity view base class, which provides the core class code for the EntityView class. EntityView provides 'view' capabilities for an entity collection. This class supports filtering and sorting in-memory, using type safe objects. Binding an entity collection to a grid or other complex databinding control will actually make the control bind to an instance of this class.

Inheritance Hierarchy

SystemObject
  System.ComponentModelMarshalByValueComponent
    SD.LLBLGen.Pro.ORMSupportClassesEntityViewBaseTEntity
      SD.LLBLGen.Pro.ORMSupportClassesEntityViewTEntity
      SD.LLBLGen.Pro.ORMSupportClassesEntityView2TEntity

Namespace: SD.LLBLGen.Pro.ORMSupportClasses
Assembly: SD.LLBLGen.Pro.ORMSupportClasses (in SD.LLBLGen.Pro.ORMSupportClasses.dll) Version: 5.0.0.0 (5.0.0)

Syntax

Copy

[ListBindableAttribute(BindableSupport.Yes)]
public abstract class EntityViewBase<TEntity> : MarshalByValueComponent, 
	IEntityViewCore, IEnumerable<TEntity>, IRaiseItemChangedEvents, IBindingListView, IBindingList, 
	IList, ICollection, IEnumerable, ITypedList
where TEntity : class, IEntityCore

<ListBindableAttribute(BindableSupport.Yes)>
Public MustInherit Class EntityViewBase(Of TEntity As {Class, IEntityCore})
	Inherits MarshalByValueComponent
	Implements IEntityViewCore, IEnumerable(Of TEntity), IRaiseItemChangedEvents, 
	IBindingListView, IBindingList, IList, ICollection, IEnumerable, 
	ITypedList

Type Parameters

TEntity

The EntityViewBaseTEntity type exposes the following members.

Constructors

	Name	Description
	EntityViewBaseTEntity	Initializes a new instance of the EntityViewBaseTEntity class

Top

Properties

	Name	Description
	AllowEdit	Gets / sets whether you can update items in the list.
	AllowNew	Gets/sets 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).
	Container	Gets the container for the component. (Inherited from MarshalByValueComponent.)
	Count	Gets the number of elements contained in the ICollection.
	DataChangeAction	Gets or sets the data change action which specifies what to do when the data in the related collection of an entity view changes. A change in data can be: entity added or changed. If an entity is removed from the underlying collection, the entity is simply removed from the entity view, as the view doesn't contain any data by itself.
	DesignMode	Gets a value indicating whether the component is currently in design mode. (Inherited from MarshalByValueComponent.)
	EntityIndices	Gets the entity indices for the entities which are in this view, in the order sorted by the sorter set.
	Events	Gets the list of event handlers that are attached to this component. (Inherited from MarshalByValueComponent.)
	Filter	Gets or sets the filter to use for this entity view.
	IsSorted	Gets whether the items in the list are sorted.
	Item	Gets the element at the specified index in this view.
	RaisesItemChangedEvents	Gets a value indicating whether the IRaiseItemChangedEvents object raises ListChanged events.
	RelatedCollectionInternal	Gets the related collection using a property which is solely for internal usage. This is then used by the derived classes to expose the collection in a more typed manner.
	Site	Gets or sets the site of the component. (Inherited from MarshalByValueComponent.)
	SortDirection	IBindingList member. Gets the direction of the sort. This property returns the value of the first SortClause in the set sorter.
	Sorter	Gets or sets the sorter for this entity view. Setting this property will re-sort the view and will reset the view in databinding scenario's.
	SortProperty	Gets the PropertyDescriptor that is being used for sorting.

Top

Methods

	Name	Description
	AddNew	Adds a new entity through databinding.
	ApplySort(ListSortDescriptionCollection)	Sorts the data source based on the given ListSortDescriptionCollection.
	ApplySort(PropertyDescriptor, ListSortDirection)	Sorts the list based on a PropertyDescriptor and a ListSortDirection.
	Contains	Determines whether this entity view contains the entity passed in. This method returns false if the entity is outside the filter, but in the related entity collection, as it's then not contained in the entity view.
	CopyTo	Copies the elements of the ICollection to an Array, starting at a particular Array index.
	CreateDummyInstance	Creates a dummy instance for the related entity collection of this view. This is done using the entityfactory of that entitycollection.
	CreateProjection	Creates a projection of the current view data, using the passed in field projections and the projector.
	Dispose	Releases all resources used by the MarshalByValueComponent. (Inherited from MarshalByValueComponent.)
	Dispose(Boolean)	Releases the unmanaged resources used by the MarshalByValueComponent and optionally releases the managed resources. (Overrides MarshalByValueComponentDispose(Boolean).)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	(Inherited from MarshalByValueComponent.)
	Find	Returns the index of the row that has the given PropertyDescriptor.
	GetEntityAtIndex	Gets the entity at the specofied index in the view.
	GetEntityFieldPropertyDescriptors	Gets the entity field property descriptors for the dummy instance passed in.
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetItemProperties	Returns the PropertyDescriptorCollection that represents the properties on each item used to bind data.
	GetListName	Returns the name of the list.
	GetPropertyDescriptors	Gets the property descriptors for the entity passed in. This is a dummy instance, and used to produce the property descriptors.
	GetService	Gets the implementer of the IServiceProvider. (Inherited from MarshalByValueComponent.)
	GetSortProperty	Gets the property descriptor for the first sortclause.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	IndexOf	Determines the index of the entity passed in in the entity view in filtered and sorted state.
	InitClassCore	Inits the class.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	OnListChanged	Called when something changes in the related list or this view.
	Refresh	Refreshes this view by re-applying filter and sorter on the related collection
	Remove	Removes the specified entity from the related collection, if the entity is in the view.
	RemoveAt	Removes the item at the specified index in this view from the related collection
	RemoveSort	Removes any sort applied using ApplySort(PropertyDescriptor, ListSortDirection).
	SetFilter	Applies the filter specified to the set related collection
	SetSorter	Sets the sort expression for the filtered entities in this view. It sorts the entities which are in this view,
	ToString	Returns a String containing the name of the Component, if any. This method should not be overridden. (Inherited from MarshalByValueComponent.)

Top

Events

	Name	Description
	Disposed	Adds an event handler to listen to the Disposed event on the component. (Inherited from MarshalByValueComponent.)
	ListChanged	Event which is fired when the entity collection related to this entityview is changed.

Top

Explicit Interface Implementations

	Name	Description
	IListAdd	Not supported. Use AddNew() or add a new object to the related entity collection.
	IBindingListAddIndex	Adds the PropertyDescriptor to the indexes used for searching.
	IBindingListAddNew	Adds a new item to the list.
	IBindingListAllowEdit	Gets whether you can update items in the list.
	IBindingListAllowNew	Gets whether you can add items to the list using AddNew.
	IBindingListAllowRemove	Gets whether you can remove items from the list, using Remove(Object) or RemoveAt(Int32).
	IBindingListApplySort	Sorts the list based on a PropertyDescriptor and a ListSortDirection.
	IBindingListViewApplySort	Sorts the data source based on the given ListSortDescriptionCollection.
	IListClear	Not supported. Clear the related entity collection instead.
	IListContains	Determines whether the IList contains a specific value.
	ICollectionCopyTo	Copies the elements of the ICollection to an Array, starting at a particular Array index.
	ICollectionCount	Gets the number of elements contained in the ICollection.
	IBindingListViewFilter	Gets or sets the filter to be used to exclude items from the collection of items returned by the data source
	IBindingListFind	Returns the index of the row that has the given PropertyDescriptor.
	IEnumerableTEntityGetEnumerator	Returns an enumerator that iterates through the collection.
	IEnumerableGetEnumerator	Returns an enumerator that iterates through a collection.
	IListIndexOf	Determines the index of a specific item in the IList.
	IListInsert	Not supported. Insert a new entity in the related collection instead.
	IListIsFixedSize	Returns false
	IListIsReadOnly	Returns false.
	IBindingListIsSorted	Gets whether the items in the list are sorted.
	ICollectionIsSynchronized	Gets a value indicating whether access to the ICollection is synchronized (thread safe).
	IListItem	Indexer via IList. Setter isn't supported, getter returns the typed indexer's value.
	IListRemove	Not supported. Remove the entity from the related collection instead.
	IListRemoveAt	Not supported. Remove the entity from the related collection instead.
	IBindingListViewRemoveFilter	Removes the current filter applied to the data source.
	IBindingListRemoveIndex	Removes the PropertyDescriptor from the indexes used for searching.
	IBindingListRemoveSort	Removes any sort applied using ApplySort(PropertyDescriptor, ListSortDirection).
	IBindingListViewSortDescriptions	Gets the collection of sort descriptions currently applied to the data source.
	IBindingListSortDirection	Gets the direction of the sort.
	IBindingListSortProperty	Gets the PropertyDescriptor that is being used for sorting.
	IBindingListViewSupportsAdvancedSorting	Gets a value indicating whether the data source supports advanced sorting.
	IBindingListSupportsChangeNotification	Gets whether a ListChanged event is raised when the list changes or an item in the list changes.
	IBindingListViewSupportsFiltering	Gets a value indicating whether the data source supports filtering.
	IBindingListSupportsSearching	Gets whether the list supports searching using the Find(PropertyDescriptor, Object) method.
	IBindingListSupportsSorting	Gets whether the list supports sorting.
	ICollectionSyncRoot	Gets an object that can be used to synchronize access to the ICollection.
	IEntityViewCoreAllowEdit	Gets / sets whether you can update items in the list.
	IEntityViewCoreAllowNew	Gets/sets whether you can add items to the list using AddNew.
	IEntityViewCoreAllowRemove	Gets whether you can remove items from the list, using Remove(Object) or RemoveAt(Int32).
	IEntityViewCoreCount	Gets the number of elements contained in the ICollection.
	IEntityViewCoreDataChangeAction	Gets or sets the data change action which specifies what to do when the data in the related collection of an entity view changes. A change in data can be: entity added or changed. If an entity is removed from the underlying collection, the entity is simply removed from the entity view, as the view doesn't contain any data by itself.
	IEntityViewCoreFilter	Gets or sets the filter to use for this entity view.
	IEntityViewCoreIndexOf	Determines the index of the entity passed in in the entity view in filtered and sorted state.
	IEntityViewCoreItem	Gets the element at the specified index in this view.
	IEntityViewCoreRefresh	Refreshes this view by re-applying filter and sorter on the related collection
	IEntityViewCoreSorter	Gets or sets the sorter for this entity view. Setting this property will re-sort the view and will reset the view in databinding scenario's.

Top

Reference

SD.LLBLGen.Pro.ORMSupportClasses Namespace