Click or drag to resize
IEntityField2 Interface
Interface for the EntityField2 type. An EntityField2 is the unit which is used to hold the value for a given property of an entity. Adapter specific.

Namespace:  SD.LLBLGen.Pro.ORMSupportClasses
Assembly:  SD.LLBLGen.Pro.ORMSupportClasses (in SD.LLBLGen.Pro.ORMSupportClasses.dll) Version: 5.3.0.0 (5.3.0)
Syntax
public interface IEntityField2 : IEntityFieldCore, 
	IFieldInfo

The IEntityField2 type exposes the following members.

Properties
  NameDescription
Public propertyActAsDerivedTableField
Gets or sets a value indicating whether this field should be threated as a derived table field. This is necessary when this field is in a query and targets a derived table while this field is actually a full entity field (so it has field info). If this flag is true, the field will result in objectAlias.Alias instead of persistenceinfo.Fieldname as alias (alias only if required)
(Inherited from IEntityFieldCore.)
Public propertyCode exampleActualContainingObjectName
The name of the object this field is currently in. Differs only from ContainingObjectName if the field instance is in a subtype while it is originally defined in a supertype.
(Inherited from IFieldInfo.)
Public propertyAggregateFunctionToApply
The aggregate function to apply on this field in a select query. Ignored in INSERT/UPDATE/DELETE queries. Designed to be used in TypedList/TypedView classes.
(Inherited from IEntityFieldCore.)
Public propertyAlias
The alias to use for this field. Only used when this field object is part of a typed list. Adapter: returns the alias set in the designer SelfServicing: returns Name
(Inherited from IEntityFieldCore.)
Public propertyContainingObjectName
Name of the containing object this field belongs to (entity or typed view). This name is required to retrieve persistence information in Adapter Set via constructor. This name is also used by EntityRelation to determine alias - table connection.
(Inherited from IFieldInfo.)
Public propertyCurrentValue
Gets the current value for this field and sets the new value for this field, by overwriting current value. The value in currentValue is discarded, versioning control has to save the original value of currentValue before this property is called.
(Inherited from IEntityFieldCore.)
Public propertyDataType
The Type of the values of this field.
(Inherited from IFieldInfo.)
Public propertyDbValue
Gets the value read from the database for this field. Use this field in optimistic concurrency predicates. Set by ForcedCurrentValueWrite(object, value) by the object fetcher logic.
(Inherited from IEntityFieldCore.)
Public propertyExpressionToApply
The expression to apply to this field in a select list, update statement or predicate or expression. Expression is applied before AggregateFunctionToApply.
(Inherited from IEntityFieldCore.)
Public propertyFieldIndex
Gets the field index related to this IEntityField, so the field can be used to retrieve the field index.
(Inherited from IFieldInfo.)
Public propertyIsChanged
If the value of this field is changed, this property is set to true. Set when CurrentValue receives a valid value.
(Inherited from IEntityFieldCore.)
Public propertyIsForeignKey
If set to true, in the constructor, this field is part of a foreign key. This field is not used in LLBLGen Pro's code, however can be useful in user code.
(Inherited from IFieldInfo.)
Public propertyIsInMultiTargetEntity
Flag to signal if the field is in a multi-target entity. Used for alias production during query building in scenario's with inheritance.
(Inherited from IFieldInfo.)
Public propertyIsNull
If the original value in the column for this entityfield is DBNull (NULL), this parameter should be set to true, otherwise to false. In BL Logic, it's impractical to work with NULL values, so these are converted to handable values. The developer can still determine if the original value was DBNull by checking this field.
(Inherited from IEntityFieldCore.)
Public propertyIsNullable
Will be true if this field can be set to NULL in the database, false otherwise. The Field Validation logic in an entity will use this flag to check if the field indeed can be set to NULL or not. Set by constructor.
(Inherited from IFieldInfo.)
Public propertyIsOfEnumDataType
Gets a value indicating whether the DataType is an enum type. This is a helper boolean so it doesn't have to be determined for every field set during a fetch.
(Inherited from IFieldInfo.)
Public propertyIsPrimaryKey
If set to true, in the constructor, this field will end up in the PrimaryKey field list of the containing IEntityFields object.
(Inherited from IFieldInfo.)
Public propertyIsReadOnly
If set to true, in the constructor, no changes can be made to this field.
(Inherited from IFieldInfo.)
Public propertyLinkedSuperTypeField
Gets the linked super type field, if this field is a subtype field and it's linked to a supertype field, otherwise null.
(Inherited from IEntityFieldCore.)
Public propertyMaxLength
The maximum length of the value of the entityfield (string/binary data). Is ignored for entityfields which hold non-string and non-binary values. Value initially set for this field is the length of the database column this field is mapped on.
(Inherited from IFieldInfo.)
Public propertyName
The name of the field. Name cannot be of zero length nor can they consist of solely spaces. Leading and trailing spaces are trimmed.
(Inherited from IFieldInfo.)
Public propertyObjectAlias
Alias for the object containing the field this entity field is mapped on. Used in typed list selection lists.
(Inherited from IEntityFieldCore.)
Public propertyPrecision
The precision of the value for this field. Value initially set for this field is the precision of the database column this field is mapped on.
(Inherited from IFieldInfo.)
Public propertyRealDataType
Gets the real datatype. This is the underlying datatype of DataType and if that's a Nullable(Of T) it's the type of T. This is a helper property so it's not determined over and over again for every field during a fetch.
(Inherited from IFieldInfo.)
Public propertyScale
The scale of the value for this field. Value initially set for this field is the scale of the database column this field is mapped on.
(Inherited from IFieldInfo.)
Top
Methods
  NameDescription
Public methodClone
Clones this field instance
(Inherited from IEntityFieldCore.)
Public methodForcedCurrentValueWrite(Object)
Overwrites the current value with the value passed. This bypasses value checking and field properties like readonly. Used by internal code only. Do not call this from your code.
(Inherited from IEntityFieldCore.)
Public methodForcedCurrentValueWrite(Object, Object)
Overwrites the current value with the value passed. This bypasses value checking and field properties like readonly. Used by internal code only. Do not call this from your code.
(Inherited from IEntityFieldCore.)
Public methodGetDiscriminatorColumnFlag
Gets the discriminator column flag.
(Inherited from IEntityFieldCore.)
Public methodGetHashCode
Overrides the GetHashCode() method. It will return the hashcode of the value of the field as the hashcode.
(Inherited from IEntityFieldCore.)
Public methodReadDefinitionFromXml
Deserializes the field's definition data on the xml reader into a field instance
(Inherited from IEntityFieldCore.)
Public methodReadXml
Deserializes the data on the xml reader into a fieldinfo instance
(Inherited from IFieldInfo.)
Public methodSetAggregateFunction
Sets the EntityField's AggregateFunctionToApply property
Public methodSetExpression
Sets the Entity Field's ExpressionToToApply property
Public methodSetFieldAlias
Sets the field alias.
Public methodSetFieldIndex
Sets the FieldIndex, if FieldInfo is null. Used in DefineField.
(Inherited from IEntityFieldCore.)
Public methodSetObjectAlias
Sets the entity field's ObjectAlias property to the specified value
Public methodWriteDefinitionAsXml
Serializes the field's definition as xml to the writer specified.
(Inherited from IEntityFieldCore.)
Public methodWriteXml(XmlWriter)
Serializes object as xml to the writer specified.
(Inherited from IFieldInfo.)
Public methodWriteXml(XmlWriter, XmlFormatAspect)
Writes the XML of this Field object to the writer specified
(Inherited from IEntityFieldCore.)
Top
Extension Methods
  NameDescription
Public Extension MethodAddDays
Defines the mapping for the field.AddDays(numberOfDays) method mapping
(Defined by FunctionMappingExtensionMethods.)
Public Extension MethodAddHours
Defines the mapping for the field.AddHours(numberOfHours) method mapping
(Defined by FunctionMappingExtensionMethods.)
Public Extension MethodAddMilliseconds
Defines the mapping for the field.AddMilliseconds(numberOfMilliseconds) method mapping
(Defined by FunctionMappingExtensionMethods.)
Public Extension MethodAddMinutes
Defines the mapping for the field.AddMinutes(numberOfMinutes) method mapping
(Defined by FunctionMappingExtensionMethods.)
Public Extension MethodAddMonths
Defines the mapping for the field.AddMonths(numberOfMonths) method mapping
(Defined by FunctionMappingExtensionMethods.)
Public Extension MethodAddSeconds
Defines the mapping for the field.AddSeconds(numberOfSeconds) method mapping
(Defined by FunctionMappingExtensionMethods.)
Public Extension MethodAddYears
Defines the mapping for the field.AddYears(numberOfYears) method mapping
(Defined by FunctionMappingExtensionMethods.)
Public Extension MethodAs(String)Overloaded.
Specifies the field alias on the field, returning the field.
(Defined by FieldExtensionMethods.)
Public Extension MethodAs(String)Overloaded.
Specifies the field alias on the field, returning the field.
(Defined by FieldExtensionMethods.)
Public Extension MethodAscending
Creates an ascending sort clause for the field specified
(Defined by SortClauseProducers.)
Public Extension MethodAvg
Places the Avg aggregate function on the field specified
(Defined by AggregateRelatedExtensionMethods.)
Public Extension MethodAvgDistinct
Places the Avg(Distinct) aggregate function on the field specified
(Defined by AggregateRelatedExtensionMethods.)
Public Extension MethodBetween
Creates a Between predicate which is true if the field specified is between valueBegin and valueEnd, valueBegin and valueEnd included.
(Defined by BetweenPredicateProducers.)
Public Extension MethodCastToTResult
Specifies the result type of the field to be TResult
(Defined by FieldExtensionMethods.)
Public Extension MethodChar
Defines the mapping for the field.Char[index] property to method mapping
(Defined by FunctionMappingExtensionMethods.)
Public Extension MethodContains
Creates a Like predicate using the pattern: '%pattern%' for the field specified.
(Defined by StringMethodPredicateProducers.)
Public Extension MethodCount
Places the Count aggregate function on the field specified
(Defined by AggregateRelatedExtensionMethods.)
Public Extension MethodCountBig
Places the CountBig aggregate function on the field specified
(Defined by AggregateRelatedExtensionMethods.)
Public Extension MethodCountBigDistinct
Places the CountBig(Distinct) aggregate function on the field specified
(Defined by AggregateRelatedExtensionMethods.)
Public Extension MethodCountDistinct
Places the Count(Distinct) aggregate function on the field specified
(Defined by AggregateRelatedExtensionMethods.)
Public Extension MethodDate
Defines the mapping for the field.Date property to method mapping
(Defined by FunctionMappingExtensionMethods.)
Public Extension MethodDay
Defines the mapping for the field.Day property to method mapping
(Defined by FunctionMappingExtensionMethods.)
Public Extension MethodDescending
Creates a descending sort clause for the field specified
(Defined by SortClauseProducers.)
Public Extension MethodEndsWith
Creates a Like predicate using the pattern: '%pattern' for the field specified.
(Defined by StringMethodPredicateProducers.)
Public Extension MethodEqual(Object)Overloaded.
Creates an equality comparison predicate between the expression and the value specified. If the value is null or DBNull.Value a null comparison predicate is created
(Defined by EqualOpPredicateProducers.)
Public Extension MethodEqual(IEntityFieldCore)Overloaded.
Creates an equality comparison predicate between the two fields specified.
(Defined by EqualOpPredicateProducers.)
Public Extension MethodEqual(IExpression)Overloaded.
Creates an equality comparison predicate between the field and the expression specified.
(Defined by EqualOpPredicateProducers.)
Public Extension MethodGreaterEqual(Object)Overloaded.
Creates a greater or equal comparison predicate between the expression and the value specified.
(Defined by GreaterEqualOpPredicateProducers.)
Public Extension MethodGreaterEqual(IEntityFieldCore)Overloaded.
Creates a greater or equal comparison predicate between the two fields specified.
(Defined by GreaterEqualOpPredicateProducers.)
Public Extension MethodGreaterEqual(IExpression)Overloaded.
Creates a greater or equal comparison predicate between the field and the expression specified.
(Defined by GreaterEqualOpPredicateProducers.)
Public Extension MethodGreaterThan(Object)Overloaded.
Creates a greater than comparison predicate between the expression and the value specified.
(Defined by GreaterThanOpPredicateProducers.)
Public Extension MethodGreaterThan(IEntityFieldCore)Overloaded.
Creates a greater than comparison predicate between the two fields specified.
(Defined by GreaterThanOpPredicateProducers.)
Public Extension MethodGreaterThan(IExpression)Overloaded.
Creates a greater than comparison predicate between the field and the expression specified.
(Defined by GreaterThanOpPredicateProducers.)
Public Extension MethodHour
Defines the mapping for the field.Hour property to method mapping
(Defined by FunctionMappingExtensionMethods.)
Public Extension MethodIn(Object)Overloaded.
Creates a Field IN (values) predicate
(Defined by InPredicateProducers.)
Public Extension MethodIn(DynamicQuery)Overloaded.
Creates a Field IN (query) predicate
(Defined by InPredicateProducers.)
Public Extension MethodIndexOf
Defines the mapping for the field.IndexOf(value) method mapping
(Defined by FunctionMappingExtensionMethods.)
Public Extension MethodIsNotNull
Generates a negated FieldCompareNull predicate on the field specified.
(Defined by IsNullPredicateProducers.)
Public Extension MethodIsNull
Generates a FieldCompareNull predicate on the field specified.
(Defined by IsNullPredicateProducers.)
Public Extension MethodLength
Defines the mapping for the field.Length property to method mapping, if field represents a string value.
(Defined by FunctionMappingExtensionMethods.)
Public Extension MethodLesserEqual(Object)Overloaded.
Creates a lesser or equal comparison predicate between the expression and the value specified.
(Defined by LesserEqualOpPredicateProducers.)
Public Extension MethodLesserEqual(IEntityFieldCore)Overloaded.
Creates a lesser or equal comparison predicate between the two fields specified.
(Defined by LesserEqualOpPredicateProducers.)
Public Extension MethodLesserEqual(IExpression)Overloaded.
Creates a lesser or equal comparison predicate between the field and the expression specified.
(Defined by LesserEqualOpPredicateProducers.)
Public Extension MethodLesserThan(Object)Overloaded.
Creates a lesser than comparison predicate between the expression and the value specified.
(Defined by LesserThanOpPredicateProducers.)
Public Extension MethodLesserThan(IEntityFieldCore)Overloaded.
Creates a lesser than comparison predicate between the two fields specified.
(Defined by LesserThanOpPredicateProducers.)
Public Extension MethodLesserThan(IExpression)Overloaded.
Creates a lesser than comparison predicate between the field and the expression specified.
(Defined by LesserThanOpPredicateProducers.)
Public Extension MethodLike
Creates a Like predicate for the field specified using the pattern specified. The pattern has to contain the wildcards required.
(Defined by StringMethodPredicateProducers.)
Public Extension MethodMax
Places the Max aggregate function on the field specified
(Defined by AggregateRelatedExtensionMethods.)
Public Extension MethodMillisecond
Defines the mapping for the field.Millisecond property to method mapping
(Defined by FunctionMappingExtensionMethods.)
Public Extension MethodMin
Places the Min aggregate function on the field specified
(Defined by AggregateRelatedExtensionMethods.)
Public Extension MethodMinute
Defines the mapping for the field.Minute property to method mapping
(Defined by FunctionMappingExtensionMethods.)
Public Extension MethodMonth
Defines the mapping for the field.Month property to method mapping
(Defined by FunctionMappingExtensionMethods.)
Public Extension MethodNotBetween
Creates a Between predicate which is true if the field specified is not between valueBegin and valueEnd, valueBegin and valueEnd included.
(Defined by BetweenPredicateProducers.)
Public Extension MethodNotEqual(Object)Overloaded.
Creates a negated equality comparison predicate between the expression and the value specified. If the value is null or DBNull.Value a null comparison predicate is created
(Defined by NotEqualOpPredicateProducers.)
Public Extension MethodNotEqual(IEntityFieldCore)Overloaded.
Creates a negated equality comparison predicate between the two fields specified.
(Defined by NotEqualOpPredicateProducers.)
Public Extension MethodNotEqual(IExpression)Overloaded.
Creates a negated equality comparison predicate between the field and the expression specified.
(Defined by NotEqualOpPredicateProducers.)
Public Extension MethodNotIn(Object)Overloaded.
Creates a NOT (Field IN (values)) predicate
(Defined by InPredicateProducers.)
Public Extension MethodNotIn(DynamicQuery)Overloaded.
Creates a NOT (Field IN (query)) predicate
(Defined by InPredicateProducers.)
Public Extension MethodReplace
Defines the mapping for the field.Replace(oldValue, newValue) method mapping
(Defined by FunctionMappingExtensionMethods.)
Public Extension MethodSecond
Defines the mapping for the field.Second property to method mapping
(Defined by FunctionMappingExtensionMethods.)
Public Extension MethodStartsWith
Creates a Like predicate using the pattern: 'pattern%' for the fieldl specified.
(Defined by StringMethodPredicateProducers.)
Public Extension MethodStDev
Places the StDev aggregate function on the field specified
(Defined by AggregateRelatedExtensionMethods.)
Public Extension MethodStDevDistinct
Places the StDev(Distinct) aggregate function on the field specified
(Defined by AggregateRelatedExtensionMethods.)
Public Extension MethodSubstring(Int32)Overloaded.
Defines the mapping for the field.Substring(startIndex) method mapping
(Defined by FunctionMappingExtensionMethods.)
Public Extension MethodSubstring(Int32, Int32)Overloaded.
Defines the mapping for the field.Substring(startIndex, length) method mapping
(Defined by FunctionMappingExtensionMethods.)
Public Extension MethodSum
Places the Sum aggregate function on the field specified
(Defined by AggregateRelatedExtensionMethods.)
Public Extension MethodSumDistinct
Places the Sum(Distinct) aggregate function on the field specified
(Defined by AggregateRelatedExtensionMethods.)
Public Extension MethodToLower
Defines the mapping for the field.ToLower() method mapping
(Defined by FunctionMappingExtensionMethods.)
Public Extension MethodToUnicode
Defines the mapping for the field.ToUnicode() method mapping
(Defined by FunctionMappingExtensionMethods.)
Public Extension MethodToUpper
Defines the mapping for the field.ToUpper() method mapping
(Defined by FunctionMappingExtensionMethods.)
Public Extension MethodToValueTValueOverloaded.
Placeholder method which is used in a Select(lambda func) projection inside the lambda to specify the type of the result of the passed in field.
(Defined by FieldExtensionMethods.)
Public Extension MethodToValueTValue(Int32)Overloaded.
Placeholder method which is used in a generated lambda from a call to Select<T>>(fields) to specify the type of the result of the passed in field and as well the ordinal the source field has in the actual projection of the query.
(Defined by FieldExtensionMethods.)
Public Extension MethodTrim
Defines the mapping for the field.Trim() method mapping
(Defined by FunctionMappingExtensionMethods.)
Public Extension MethodVariance
Places the Variance aggregate function on the field specified
(Defined by AggregateRelatedExtensionMethods.)
Public Extension MethodVarianceDistinct
Places the Variance(Distinct) aggregate function on the field specified
(Defined by AggregateRelatedExtensionMethods.)
Public Extension MethodYear
Defines the mapping for the field.Year property to method mapping
(Defined by FunctionMappingExtensionMethods.)
Top
See Also