| FieldInfo Class |
General container class for static field information which is readonly at runtime and which is equal for all instances of a
given field. This information is shared among all instances of an entity, and therefore saves a lot of memory at runtime.
Inheritance HierarchyNamespace: SD.LLBLGen.Pro.ORMSupportClasses
Assembly: SD.LLBLGen.Pro.ORMSupportClasses (in SD.LLBLGen.Pro.ORMSupportClasses.dll) Version: 5.0.0.0 (5.0.0)
SyntaxThe FieldInfo type exposes the following members.
ConstructorsProperties| Name | Description | |
|---|---|---|
  | 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.
|
| 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.
|
| DataType |
The Type of the values of this field.
|
| FieldIndex |
Gets the field index related to this IEntityField, so the field can be used to retrieve the field index.
|
| 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.
|
| 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.
|
| 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.
|
| 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.
|
| IsPrimaryKey |
If set to true, in the constructor, this field will end up in the PrimaryKey field list of the containing IEntityFields object.
|
| IsReadOnly |
If set to true, in the constructor, no changes can be made to this field.
|
| 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.
|
| 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.
|
| 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.
|
| 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.
|
| 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.
|
Methods| Name | Description | |
|---|---|---|
 | Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Explicit Interface Implementations| Name | Description | |
|---|---|---|
  | IFieldInfoReadXml |
Deserializes the data on the xml reader into a fieldinfo instance
|
| IFieldInfoWriteXml |
Serializes object as xml to the writer specified.
|
See Also