IEntityField Properties

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)

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.

The .NET type of the field in the DB. This value is used to convert a currentvalue back to this type using TypeConverterToUse.

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.

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

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.

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.

The Type of the values of this field.

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.

The expression to apply to this field in a select list, update statement or predicate or expression. Expression is applied before AggregateFunctionToApply.

Gets the field index related to this IEntityField, so the field can be used to retrieve the field index.

If IsIdentity is set to true, this property has to be set to the name of the sequence which supplies the value for the EntityField's corresponding table field. On SqlServer this is @@IDENTITY or SCOPE_IDENTITY() and only used when the row is succesfully inserted, however on Oracle this value is used to specify a new value and to retrieve the new value. Is undefined when IsIdentity is set to false.

If the value of this field is changed, this property is set to true. Set when CurrentValue receives a valid value.

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.

If set to true, the Dynamic Query Engine (DQE) will assume the field is an Identity field and will act accordingly (i.e.: as the target database handles Identity fields: SqlServer will generate a new value itself, Oracle wants to have a sequence input.

Flag to signal if the field is in a multi-target entity. Used for alias production during query building in scenario's with inheritance.

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.

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.

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.

If set to true, in the constructor, this field will end up in the PrimaryKey field list of the containing IEntityFields object.

If set to true, in the constructor, no changes can be made to this field.

Gets the linked super type field, if this field is a subtype field and it's linked to a supertype field, otherwise null.

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.

The name of the field. Name cannot be of zero length nor can they consist of solely spaces. Leading and trailing spaces are trimmed.

Alias for the object containing the field this entity field is mapped on. Used in typed list selection lists.

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.

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.

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.

The name of the catalog the SourceSchemaName is located in.

The type of the Column mapped onto the EntityField(2). The value stored here is the string representation of the enum value of the type, e.g. SqlDbType.Int will result in "Int"

Flag if the Column mapped onto the entityfield is nullable or not. Used for update/insert operations on the column

The maximum length of the value of the entityfield (string/binary data). Is ignored for entityfields which hold non-string and non-binary values. ColumnMaxLength Used for update/insert operations on the column

The name of the corresponding column in a view or table for an entityfield. This name is used to map a column in a resultset onto the entity field.

The precision of the Column mapped onto the entityfield. Used for update/insert operations on the column

The scale of the Column mapped onto the entityfield. Used for update/insert operations on the column

The name of the source object which holds SourceColumnName. Can be a view or a table (or synonym of those). Used to generate SQL on the fly.

The name of the schema which holds SourceObjectName. Schema is used to generate SQL on the fly. A common schema name in SqlServer is f.e. 'dbo'.

Gets the type converter to use. Only set through constructor and when a conversion is required from the .NET type returned by the ADO.NET provider and the defined .NET type for this field.