IEntityFieldCore Interface |
Interface definition which defines the core IEntityField set. Is implemented by other interfaces like IEntityField and IEntityField2.
Generic.
Namespace: SD.LLBLGen.Pro.ORMSupportClasses
Assembly: SD.LLBLGen.Pro.ORMSupportClasses (in SD.LLBLGen.Pro.ORMSupportClasses.dll) Version: 5.8.0.0 (5.8.21.0111)
SyntaxThe IEntityFieldCore type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | ActAsDerivedTableField |
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)
|
 | ActualContainingObjectName |
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.) |
| AggregateFunctionToApply |
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.
|
| Alias |
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
|
| ContainingObjectName |
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.) |
| CurrentValue |
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.
|
| DataType |
The Type of the values of this field.
(Inherited from IFieldInfo.) |
| DbValue |
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.
|
| ExpressionToApply |
The expression to apply to this field in a select list, update statement or predicate or expression.
Expression is applied before AggregateFunctionToApply.
|
| FieldIndex |
Gets the field index related to this IEntityField, so the field can be used to retrieve the field index.
(Inherited from IFieldInfo.) |
| IsChanged |
If the value of this field is changed, this property is set to true. Set when CurrentValue receives a valid value.
|
| IsForeignKey |
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.) |
| IsInMultiTargetEntity |
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.) |
| IsNull |
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.
|
| IsNullable |
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.) |
| IsOfEnumDataType |
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.) |
| IsPrimaryKey |
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.) |
| IsReadOnly |
If set to true, in the constructor, no changes can be made to this field.
(Inherited from IFieldInfo.) |
| LinkedSuperTypeField |
Gets the linked super type field, if this field is a subtype field and it's linked to a supertype field, otherwise null.
|
| MaxLength |
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.) |
| Name |
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.) |
| ObjectAlias |
Alias for the object containing the field this entity field is mapped on. Used in typed list selection lists.
|
| OverClauseToApply |
The window specification for an OVER() clause to apply to this field in a select list. Not used elsewhere. WindowSpecification results in an OVER() clause
which is appended to an aggregatefunction and expression.
|
| Precision |
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.) |
| RealDataType |
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.) |
| Scale |
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.) |
Methods| Name | Description | |
|---|---|---|
 | Clone |
Clones this field instance
|
| ForcedCurrentValueWrite(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.
|
| ForcedCurrentValueWrite(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.
|
| GetDiscriminatorColumnFlag |
Gets the discriminator column flag.
|
| GetHashCode |
Overrides the GetHashCode() method. It will return the hashcode of the value of the field as the hashcode.
|
| GetHashCodeForExpressionKey |
Returns the hashcode for this field which can be used for an expression key. This value is based on the field info hashcode and alias, as well as expression hashcode (if present)
|
| ReadDefinitionFromXml |
Deserializes the field's definition data on the xml reader into a field instance
|
| ReadXml |
Deserializes the data on the xml reader into a fieldinfo instance
(Inherited from IFieldInfo.) |
| SetFieldIndex |
Sets the FieldIndex, if FieldInfo is null. Used in DefineField.
|
| WriteDefinitionAsXml |
Serializes the field's definition as xml to the writer specified.
|
| WriteXml(XmlWriter) |
Serializes object as xml to the writer specified.
(Inherited from IFieldInfo.) |
| WriteXml(XmlWriter, XmlFormatAspect) |
Writes the XML of this Field object to the writer specified
|
Extension Methods| Name | Description | |
|---|---|---|
 | Add |
Creates a new expression: leftoperand + rightoperand
(Defined by FieldExtensionMethods.) |
| AddDays |
Defines the mapping for the field.AddDays(numberOfDays) method mapping
(Defined by FunctionMappingExtensionMethods.) |
| AddHours |
Defines the mapping for the field.AddHours(numberOfHours) method mapping
(Defined by FunctionMappingExtensionMethods.) |
| AddMilliseconds |
Defines the mapping for the field.AddMilliseconds(numberOfMilliseconds) method mapping
(Defined by FunctionMappingExtensionMethods.) |
| AddMinutes |
Defines the mapping for the field.AddMinutes(numberOfMinutes) method mapping
(Defined by FunctionMappingExtensionMethods.) |
| AddMonths |
Defines the mapping for the field.AddMonths(numberOfMonths) method mapping
(Defined by FunctionMappingExtensionMethods.) |
| AddSeconds |
Defines the mapping for the field.AddSeconds(numberOfSeconds) method mapping
(Defined by FunctionMappingExtensionMethods.) |
| AddYears |
Defines the mapping for the field.AddYears(numberOfYears) method mapping
(Defined by FunctionMappingExtensionMethods.) |
| And |
Creates a new expression: leftoperand AND rightoperand
(Defined by FieldExtensionMethods.) |
| As |
Specifies the field alias on the field, returning the field.
(Defined by FieldExtensionMethods.) |
| Ascending |
Creates an ascending sort clause for the field specified
(Defined by SortClauseProducers.) |
| Avg |
Places the Avg aggregate function on the field specified
(Defined by AggregateRelatedExtensionMethods.) |
| AvgDistinct |
Places the Avg(Distinct) aggregate function on the field specified
(Defined by AggregateRelatedExtensionMethods.) |
| Between |
Creates a Between predicate which is true if the field specified is between valueBegin and valueEnd, valueBegin and valueEnd included.
(Defined by BetweenPredicateProducers.) |
| BitwiseAnd |
Creates a new expression: leftoperand BitwiseAnd rightoperand
(Defined by FieldExtensionMethods.) |
| BitwiseOr |
Creates a new expression: leftoperand BitwiseOr rightoperand
(Defined by FieldExtensionMethods.) |
| BitwiseXor |
Creates a new expression: leftoperand BitwiseXor rightoperand
(Defined by FieldExtensionMethods.) |
| CastToTResult |
Specifies the result type of the field to be TResult
(Defined by FieldExtensionMethods.) |
| Char |
Defines the mapping for the field.Char[index] property to method mapping
(Defined by FunctionMappingExtensionMethods.) |
| Contains |
Creates a Like predicate using the pattern: '%pattern%' for the field specified.
(Defined by StringMethodPredicateProducers.) |
| Count |
Places the Count aggregate function on the field specified
(Defined by AggregateRelatedExtensionMethods.) |
| CountBig |
Places the CountBig aggregate function on the field specified
(Defined by AggregateRelatedExtensionMethods.) |
| CountBigDistinct |
Places the CountBig(Distinct) aggregate function on the field specified
(Defined by AggregateRelatedExtensionMethods.) |
| CountDistinct |
Places the Count(Distinct) aggregate function on the field specified
(Defined by AggregateRelatedExtensionMethods.) |
| Date |
Defines the mapping for the field.Date property to method mapping
(Defined by FunctionMappingExtensionMethods.) |
| Day |
Defines the mapping for the field.Day property to method mapping
(Defined by FunctionMappingExtensionMethods.) |
| Descending |
Creates a descending sort clause for the field specified
(Defined by SortClauseProducers.) |
| Div |
Creates a new expression: leftoperand / rightoperand
(Defined by FieldExtensionMethods.) |
| EndsWith |
Creates a Like predicate using the pattern: '%pattern' for the field specified.
(Defined by StringMethodPredicateProducers.) |
| Equal(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.) |
| Equal(IEntityFieldCore) | Overloaded.
Creates an equality comparison predicate between the two fields specified.
(Defined by EqualOpPredicateProducers.) |
| Equal(IExpression) | Overloaded.
Creates an equality comparison predicate between the field and the expression specified.
(Defined by EqualOpPredicateProducers.) |
| GreaterEqual(Object) | Overloaded.
Creates a greater or equal comparison predicate between the expression and the value specified.
(Defined by GreaterEqualOpPredicateProducers.) |
| GreaterEqual(IEntityFieldCore) | Overloaded.
Creates a greater or equal comparison predicate between the two fields specified.
(Defined by GreaterEqualOpPredicateProducers.) |
| GreaterEqual(IExpression) | Overloaded.
Creates a greater or equal comparison predicate between the field and the expression specified.
(Defined by GreaterEqualOpPredicateProducers.) |
| GreaterThan(Object) | Overloaded.
Creates a greater than comparison predicate between the expression and the value specified.
(Defined by GreaterThanOpPredicateProducers.) |
| GreaterThan(IEntityFieldCore) | Overloaded.
Creates a greater than comparison predicate between the two fields specified.
(Defined by GreaterThanOpPredicateProducers.) |
| GreaterThan(IExpression) | Overloaded.
Creates a greater than comparison predicate between the field and the expression specified.
(Defined by GreaterThanOpPredicateProducers.) |
| Hour |
Defines the mapping for the field.Hour property to method mapping
(Defined by FunctionMappingExtensionMethods.) |
| In(Object) | Overloaded.
Creates a Field IN (values) predicate
(Defined by InPredicateProducers.) |
| In(DynamicQuery) | Overloaded.
Creates a Field IN (query) predicate
(Defined by InPredicateProducers.) |
| IndexOf |
Defines the mapping for the field.IndexOf(value) method mapping
(Defined by FunctionMappingExtensionMethods.) |
| IsNotNull |
Generates a negated FieldCompareNull predicate on the field specified.
(Defined by IsNullPredicateProducers.) |
| IsNull |
Generates a FieldCompareNull predicate on the field specified.
(Defined by IsNullPredicateProducers.) |
| Length |
Defines the mapping for the field.Length property to method mapping, if field represents a string value.
(Defined by FunctionMappingExtensionMethods.) |
| LesserEqual(Object) | Overloaded.
Creates a lesser or equal comparison predicate between the expression and the value specified.
(Defined by LesserEqualOpPredicateProducers.) |
| LesserEqual(IEntityFieldCore) | Overloaded.
Creates a lesser or equal comparison predicate between the two fields specified.
(Defined by LesserEqualOpPredicateProducers.) |
| LesserEqual(IExpression) | Overloaded.
Creates a lesser or equal comparison predicate between the field and the expression specified.
(Defined by LesserEqualOpPredicateProducers.) |
| LesserThan(Object) | Overloaded.
Creates a lesser than comparison predicate between the expression and the value specified.
(Defined by LesserThanOpPredicateProducers.) |
| LesserThan(IEntityFieldCore) | Overloaded.
Creates a lesser than comparison predicate between the two fields specified.
(Defined by LesserThanOpPredicateProducers.) |
| LesserThan(IExpression) | Overloaded.
Creates a lesser than comparison predicate between the field and the expression specified.
(Defined by LesserThanOpPredicateProducers.) |
| Like |
Creates a Like predicate for the field specified using the pattern specified. The pattern has to contain the wildcards required.
(Defined by StringMethodPredicateProducers.) |
| Max |
Places the Max aggregate function on the field specified
(Defined by AggregateRelatedExtensionMethods.) |
| Millisecond |
Defines the mapping for the field.Millisecond property to method mapping
(Defined by FunctionMappingExtensionMethods.) |
| Min |
Places the Min aggregate function on the field specified
(Defined by AggregateRelatedExtensionMethods.) |
| Minute |
Defines the mapping for the field.Minute property to method mapping
(Defined by FunctionMappingExtensionMethods.) |
| Mod |
Creates a new expression: leftoperand MOD rightoperand
(Defined by FieldExtensionMethods.) |
| Month |
Defines the mapping for the field.Month property to method mapping
(Defined by FunctionMappingExtensionMethods.) |
| Mul |
Creates a new expression: leftoperand * rightoperand
(Defined by FieldExtensionMethods.) |
| NotBetween |
Creates a Between predicate which is true if the field specified is not between valueBegin and valueEnd, valueBegin and valueEnd included.
(Defined by BetweenPredicateProducers.) |
| NotEqual(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.) |
| NotEqual(IEntityFieldCore) | Overloaded.
Creates a negated equality comparison predicate between the two fields specified.
(Defined by NotEqualOpPredicateProducers.) |
| NotEqual(IExpression) | Overloaded.
Creates a negated equality comparison predicate between the field and the expression specified.
(Defined by NotEqualOpPredicateProducers.) |
| NotIn(Object) | Overloaded.
Creates a NOT (Field IN (values)) predicate
(Defined by InPredicateProducers.) |
| NotIn(DynamicQuery) | Overloaded.
Creates a NOT (Field IN (query)) predicate
(Defined by InPredicateProducers.) |
| Or |
Creates a new expression: leftoperand Or rightoperand
(Defined by FieldExtensionMethods.) |
| Over | Overloaded.
Places a new WindowSpecification in the specified field's OverClauseToApply property with no arguments
(Defined by AggregateRelatedExtensionMethods.) |
| Over(ISortClause) | Overloaded.
Places a new WindowSpecification in the specified field's OverClauseToApply property with the arguments specified
(Defined by AggregateRelatedExtensionMethods.) |
| Over(ISortExpression) | Overloaded.
Places a new WindowSpecification in the specified field's OverClauseToApply property with the arguments specified
(Defined by AggregateRelatedExtensionMethods.) |
| Over(WindowPartition) | Overloaded.
Places a new WindowSpecification in the specified field's OverClauseToApply property with the arguments specified
(Defined by AggregateRelatedExtensionMethods.) |
| Over(WindowSpecification) | Overloaded.
Places the specified WindowSpecification in the specified field's OverClauseToApply property
(Defined by AggregateRelatedExtensionMethods.) |
| Over(ISortClause, WindowBounds) | Overloaded.
Places a new WindowSpecification in the specified field's OverClauseToApply property with the arguments specified
(Defined by AggregateRelatedExtensionMethods.) |
| Over(ISortExpression, WindowBounds) | Overloaded.
Places a new WindowSpecification in the specified field's OverClauseToApply property with the arguments specified
(Defined by AggregateRelatedExtensionMethods.) |
| Over(WindowPartition, ISortExpression) | Overloaded.
Places a new WindowSpecification in the specified field's OverClauseToApply property with the arguments specified
(Defined by AggregateRelatedExtensionMethods.) |
| Over(WindowPartition, ISortClause) | Overloaded.
Places a new WindowSpecification in the specified field's OverClauseToApply property with the arguments specified
(Defined by AggregateRelatedExtensionMethods.) |
| Over(WindowPartition, ISortClause, WindowBounds) | Overloaded.
Places a new WindowSpecification in the specified field's OverClauseToApply property with the arguments specified
(Defined by AggregateRelatedExtensionMethods.) |
| Over(WindowPartition, ISortExpression, WindowBounds) | Overloaded.
Places a new WindowSpecification in the specified field's OverClauseToApply property with the arguments specified
(Defined by AggregateRelatedExtensionMethods.) |
| Replace |
Defines the mapping for the field.Replace(oldValue, newValue) method mapping
(Defined by FunctionMappingExtensionMethods.) |
| Second |
Defines the mapping for the field.Second property to method mapping
(Defined by FunctionMappingExtensionMethods.) |
| StartsWith |
Creates a Like predicate using the pattern: 'pattern%' for the fieldl specified.
(Defined by StringMethodPredicateProducers.) |
| StDev |
Places the StDev aggregate function on the field specified
(Defined by AggregateRelatedExtensionMethods.) |
| StDevDistinct |
Places the StDev(Distinct) aggregate function on the field specified
(Defined by AggregateRelatedExtensionMethods.) |
| Sub |
Creates a new expression: leftoperand - rightoperand
(Defined by FieldExtensionMethods.) |
| Substring(Int32) | Overloaded.
Defines the mapping for the field.Substring(startIndex) method mapping
(Defined by FunctionMappingExtensionMethods.) |
| Substring(Int32, Int32) | Overloaded.
Defines the mapping for the field.Substring(startIndex, length) method mapping
(Defined by FunctionMappingExtensionMethods.) |
| Sum |
Places the Sum aggregate function on the field specified
(Defined by AggregateRelatedExtensionMethods.) |
| SumDistinct |
Places the Sum(Distinct) aggregate function on the field specified
(Defined by AggregateRelatedExtensionMethods.) |
| ToLower |
Defines the mapping for the field.ToLower() method mapping
(Defined by FunctionMappingExtensionMethods.) |
| ToUnicode |
Defines the mapping for the field.ToUnicode() method mapping
(Defined by FunctionMappingExtensionMethods.) |
| ToUpper |
Defines the mapping for the field.ToUpper() method mapping
(Defined by FunctionMappingExtensionMethods.) |
| ToValueTValue | Overloaded.
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.) |
| ToValueTValue(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.) |
| Trim |
Defines the mapping for the field.Trim() method mapping
(Defined by FunctionMappingExtensionMethods.) |
| Variance |
Places the Variance aggregate function on the field specified
(Defined by AggregateRelatedExtensionMethods.) |
| VarianceDistinct |
Places the Variance(Distinct) aggregate function on the field specified
(Defined by AggregateRelatedExtensionMethods.) |
| Year |
Defines the mapping for the field.Year property to method mapping
(Defined by FunctionMappingExtensionMethods.) |
See Also