IEntityFields Interface

Interface for the EntityFields type. An EntityFields type is a collection of IEntityField objects which forms the total amount of fields for a given entity. SelfServicing specific

Namespace: SD.LLBLGen.Pro.ORMSupportClasses
Assembly: SD.LLBLGen.Pro.ORMSupportClasses (in SD.LLBLGen.Pro.ORMSupportClasses.dll) Version: 5.4.0.0 (5.4.0)

Syntax

Copy

public interface IEntityFields : IEntityFieldsCore, 
	IEditableObject, IList<IEntityFieldCore>, ICollection<IEntityFieldCore>, 
	IEnumerable<IEntityFieldCore>, IEnumerable, IList, ICollection

Public Interface IEntityFields
	Inherits IEntityFieldsCore, IEditableObject, IList(Of IEntityFieldCore), 
	ICollection(Of IEntityFieldCore), IEnumerable(Of IEntityFieldCore), IEnumerable, 
	IList, ICollection

The IEntityFields type exposes the following members.

Properties

	Name	Description
	Count	Gets the number of slots allocated in this fields object. (Inherited from IEntityFieldsCore.)
	FieldsWithExpressionOrAggregate	Gets the fields with expression or aggregate. (Inherited from IEntityFieldsCore.)
	InheritanceInfoProviderToUse	Gets the inheritance info provider to use. (Inherited from IEntityFieldsCore.)
	IsChangedInThisEditCycle	Flag to signal if the entity fields have changed during an edit cycle which is controlled outside this IEntityFieldsCore object. If set to true, EndEdit will succeed, otherwise EndEdit will ignore any changes, since these are made in a previous edit cycle which is already ended. (Inherited from IEntityFieldsCore.)
	IsDirty	Gets / sets the flag if the contents of the EntityFields2 object is 'dirty', which means that one or more fields are changed. (Inherited from IEntityFieldsCore.)
	IsFixedSize	Gets a value indicating whether the IList has a fixed size. (Inherited from IList.)
	IsReadOnly	Gets a value indicating whether the ICollectionT is read-only. (Inherited from ICollectionIEntityFieldCore.)
	IsSynchronized	Gets a value indicating whether access to the ICollection is synchronized (thread safe). (Inherited from ICollection.)
	ItemInt32	Gets / sets the EntityField on the specified Index.
	ItemString	Gets the EntityField with the specified name.
	OwnPrimaryKeyFieldInfos	Gets the primary key field infos of the pk fields owned by this entity, so not the pk fields inherited from a supertype. If this entity isn't in a TPE inheritance hierarchy, this property is equal to PrimaryKeyFieldInfos (Inherited from IEntityFieldsCore.)
	PrimaryKeyFieldInfos	Gets the primary key field infos. Similar to PrimaryKeyFields, but this property doesn't trigger field creation. (Inherited from IEntityFieldsCore.)
	PrimaryKeyFields	List of IEntityField references which form the primary key
	State	The state of the IEntityFieldsCore object (Inherited from IEntityFieldsCore.)
	SyncRoot	Gets an object that can be used to synchronize access to the ICollection. (Inherited from ICollection.)

Top

Methods

	Name	Description
	AcceptChanges	Accepts the changes made. Used in databinding scenarios (Inherited from IEntityFieldsCore.)
	Add(Object)	Adds an item to the IList. (Inherited from IList.)
	Add(T)	Adds an item to the ICollectionT. (Inherited from ICollectionIEntityFieldCore.)
	BeginEdit	Begins an edit on an object. (Inherited from IEditableObject.)
	CancelEdit	Discards changes since the last BeginEdit call. (Inherited from IEditableObject.)
	CleanAndPreserveExpressionsFromFields	Removes the expressions from fields and returns them in the dictionary, key is field index, value is the expression on that field. Only removes expressions from fields which have a non-empty containingobjectname, as those are real entity fields. (Inherited from IEntityFieldsCore.)
	Clear	Removes all items from the ICollectionT. (Inherited from ICollectionIEntityFieldCore.)
	Clone	Clones this instance and its contents using a deep copy.
	CloneAsDirty	Clones this object to a new EntityFields object where all fields are changed and the object itself is marked dirty.
	Compact	Compacts the list of fields so all empty slots are removed. (Inherited from IEntityFieldsCore.)
	Contains(Object)	Determines whether the IList contains a specific value. (Inherited from IList.)
	Contains(T)	Determines whether the ICollectionT contains a specific value. (Inherited from ICollectionIEntityFieldCore.)
	Contract	Contracts the list of fields so all empty slots at the end of the list of fields are removed. Doesn't perform a contract operation if the fields object is empty (Inherited from IEntityFieldsCore.)
	CopyTo(Array, Int32)	Copies the elements of the ICollection to an Array, starting at a particular Array index. (Inherited from ICollection.)
	CopyTo(T, Int32)	Copies the elements of the ICollectionT to an Array, starting at a particular Array index. (Inherited from ICollectionIEntityFieldCore.)
	DefineField(IEntityFieldCore, Int32)	Adds the specified field on the position indexInFields in the resultset. (Inherited from IEntityFieldsCore.)
	DefineField(IEntityFieldCore, Int32, AggregateFunction)	Adds the specified field on the position indexInFields in the resultset. (Inherited from IEntityFieldsCore.)
	DefineField(IEntityFieldCore, Int32, String)	Adds the specified field on the position indexInFields in the resultset. (Inherited from IEntityFieldsCore.)
	DefineField(IEntityFieldCore, Int32, String, AggregateFunction)	Adds the specified field on the position indexInFields in the resultset. (Inherited from IEntityFieldsCore.)
	DefineField(IEntityFieldCore, Int32, String, String)	Adds the specified field on the position indexInFields in the resultset. (Inherited from IEntityFieldsCore.)
	DefineField(IEntityFieldCore, Int32, String, String, AggregateFunction)	Adds the specified field on the position indexInFields in the resultset. (Inherited from IEntityFieldsCore.)
	DeserializeData	Deserializes the data of this fields object from the SerializationInfo object specified. (Inherited from IEntityFieldsCore.)
	EndEdit	Pushes changes since the last BeginEdit or AddNew call into the underlying object. (Inherited from IEditableObject.)
	Expand	Expands this entity fields object by appending numberOfCells new cells to this object. (Inherited from IEntityFieldsCore.)
	ForcedValueWrite(Int32, Object)	Sets the current value for the field with the index specified to the currentValue specified without setting changed flags. From user code, use SetCurrentValue instead. (Inherited from IEntityFieldsCore.)
	ForcedValueWrite(Int32, Object, Object)	Sets the current value for the field with the index specified to the currentValue specified and the dbvalue to the dbvalue specified without setting changed flags. From user code, use SetCurrentValue instead. (Inherited from IEntityFieldsCore.)
	GetAsEntityFieldCoreArray	Returns the complete list of IEntityFieldCore objects as an array of IEntityFieldCore objects. (Inherited from IEntityFieldsCore.)
	GetAsPersistenceInfoArray	Returns the complete list of IEntityField objects as an array of IFieldPersistenceInfo objects. IEntityField objects implement IFieldPersistenceInfo.
	GetCurrentValue	Gets the current value for the field at index specified. (Inherited from IEntityFieldsCore.)
	GetDbValue	Gets the DB value for the field at index specified. (Inherited from IEntityFieldsCore.)
	GetEntityFieldStates	Gets the field states for transaction state save (Inherited from IEntityFieldsCore.)
	GetEntityNamesOfFields	Gets the entity names of fields. (Inherited from IEntityFieldsCore.)
	GetEnumerator	Returns an enumerator that iterates through the collection. (Inherited from IEnumerableIEntityFieldCore.)
	GetFieldIndex	Gets the index of the field with the name specified (Inherited from IEntityFieldsCore.)
	GetFieldInfo	Gets the field info for the field at the index specified. (Inherited from IEntityFieldsCore.)
	GetFieldNames	Gets the field names of the fields contained in this fields object. (Inherited from IEntityFieldsCore.)
	GetHashCode	Overrides the GetHashCode routine. It will calculate a hashcode for this set of entity fields using the eXclusive OR of the hashcodes of the primary key fields in this set of entity fields. That hashcode is returned. If no primary key fields are present, the hashcode of the base class is returned, which will not be unique. (Inherited from IEntityFieldsCore.)
	GetIsChanged	Gets the IsChanged flag for the field at the index specified. (Inherited from IEntityFieldsCore.)
	GetIsNull	Gets the IsNull value for the field with the index specified. (Inherited from IEntityFieldsCore.)
	GetLinkedSuperTypeField	Gets the linked super type field for the field with the index specified, or null if not applicable. (Inherited from IEntityFieldsCore.)
	GetUniqueFieldNames	Gets the unique field names. (Inherited from IEntityFieldsCore.)
	IndexOf(Object)	Determines the index of a specific item in the IList. (Inherited from IList.)
	IndexOf(T)	Determines the index of a specific item in the IListT. (Inherited from IListIEntityFieldCore.)
	Insert(Int32, T)	Inserts an item to the IListT at the specified index. (Inherited from IListIEntityFieldCore.)
	Insert(Int32, Object)	Inserts an item to the IList at the specified index. (Inherited from IList.)
	MarkAsFetched	Marks the fields as fetched. Copies the current values to the db values and sets the state to fetched. (Inherited from IEntityFieldsCore.)
	ReadXml	Reads the fields which are childnodes of the passed in fieldsElement into this object (Inherited from IEntityFieldsCore.)
	ReassignExpressionsOnFields	Reassigns the expressions on fields. Specified are the expressions per field index, as returned by CleanAndPreserveExpressionsFromFields (Inherited from IEntityFieldsCore.)
	RejectChanges	Rejects the changes made. Used in databinding scenarios (Inherited from IEntityFieldsCore.)
	Remove(Object)	Removes the first occurrence of a specific object from the IList. (Inherited from IList.)
	Remove(T)	Removes the first occurrence of a specific object from the ICollectionT. (Inherited from ICollectionIEntityFieldCore.)
	RemoveAt	Removes the IListT item at the specified index. (Inherited from IListIEntityFieldCore.)
	SerializeData	Serializes the data of this fields object into the SerializationInfo object specified. (Inherited from IEntityFieldsCore.)
	SetCurrentValue	Sets the current value for the field at index specified. (Inherited from IEntityFieldsCore.)
	SetDbValue	Sets the db value for the field at the index specified. (Inherited from IEntityFieldsCore.)
	SetEntityFieldStates	Sets the field states. Used in transaction state save (Inherited from IEntityFieldsCore.)
	SetIsChanged	Sets the IsChanged flag for the field specified. Sets IsDirty to true if value is true. (Inherited from IEntityFieldsCore.)
	SetValues	Sets the values for the fields, when this object is part of an entity. (Inherited from IEntityFieldsCore.)
	ShallowClone	Creates a shallow copy of this instance, which means that a new EntityFields object is created but all membervariables are kept the same.
	WriteXml(XmlWriter, XmlFormatAspect)	Writes the XML of this Fields object to the writer specified (Inherited from IEntityFieldsCore.)
	WriteXml(XmlFormatAspect, XmlDocument, XmlNode)	Converts this EntityFields object to a set of XmlNodes with all the fields as individual nodes.

Top

Extension Methods

	Name	Description
	InT	Creates a predicate which is true if there's an object of type T in values, which has for each property P a field in fields with the same name / alias and the value for property P is equal to the value of the field equivalent in the main query. (Defined by InPredicateProducers.)
	NotInT	Creates a predicate which is true if there's no object of type T in values, which has for each property P a field in fields with the same name / alias and the value for property P is equal to the value of the field equivalent in the main query. (Defined by InPredicateProducers.)

Top

Reference

SD.LLBLGen.Pro.ORMSupportClasses Namespace