Click or drag to resize

DBTableField Class

Class which represenst a table field.
Inheritance Hierarchy

Namespace:  SD.LLBLGen.Pro.DBDriverCore
Assembly:  SD.LLBLGen.Pro.DBDriverCore (in SD.LLBLGen.Pro.DBDriverCore.dll) Version: 5.8.0.0 (5.8.21.0208)
Syntax
public class DBTableField : DBField, 
	IProjectElementFieldMapTargetElement, IDBRenameableElement

The DBTableField type exposes the following members.

Constructors
  NameDescription
Public methodDBTableField
Initializes a new instance of the DBTableField class.
Public methodDBTableField(String)
Initializes a new instance of the DBTableField class.
Public methodDBTableField(String, DBTypeDefinition)
Initializes a new instance of the DBTableField class.
Public methodDBTableField(String, DBTypeDefinition, String)
Initializes a new instance of the DBTableField class.
Public methodDBTableField(String, DBTypeDefinition, String, Boolean, Boolean, Int32, Boolean)
Initializes a new instance of the DBTableField class.
Top
Properties
  NameDescription
Public propertyCreatedByDesigner
Gets or sets a value indicating whether this element is created by the designer from mappings (true) or that it was created from meta-data retrieved from the database (false, default).
(Inherited from DBElementBase.)
Public propertyCustomProperties
Gets the Custom properties (name - value pairs) read from the schema.
(Inherited from DBElementBase.)
Public propertyDBType
Gets the DB type of the field.
(Inherited from DBField.)
Public propertyDbTypeAsString
Gets the DbType as string.
(Inherited from DBField.)
Public propertyDefaultSequence
Gets the default sequence. Only set when the database supports default sequence hints. otherwise null
Public propertyDefaultValue
The default value for this field. It is represented in a string, since it's only used in the code generation process. Is only valid if HasDefaultValue returns true.
Protected propertyDeserializing
Gets or sets a value indicating whether this instance is deserializing.
(Inherited from DBElementBase.)
Public propertyErrorLog
Gets the complete ErrorLog for this object.
(Inherited from DBElementBase.)
Public propertyFieldName
Literal name of the field.
(Inherited from DBField.)
Public propertyFullName
Gets the full name.
(Overrides DBElementBaseFullName.)
Public propertyFullNameForXml
Gets the full name for XML. This is a name which has the format schemaname:elementname or schemaname:elementname:fieldname. Used for references.
(Overrides DBElementBaseFullNameForXml.)
Public propertyFullNameForXmlWithCatalog
Gets the full name for XML. This is a name which has the format catalogname:schemaname:elementname or catalogname:schemaname:elementname:fieldname. Used for references.
(Inherited from DBElementBase.)
Public propertyHasDefaultValue
Flag which signals if this field has a default value. If true, DefaultValue should return the default value for this field.
Public propertyIsComputed
Flag which signals if this field's value is retrieved using a function stored with the field in the database.
Public propertyIsForeignKey
Flag which signals if this field has a foreign key (FK) constraint. By design, fields can have only one foreign key constraint, since more than one is semantically wrong.
Public propertyIsIdentity
Flag which signals if this field is an autonumber/identity field.
(Inherited from DBField.)
Public propertyIsNullable
Flag which signals if this field can contain NULL.
(Inherited from DBField.)
Public propertyIsPrimaryKey
Flag which signals if this field is part of the primary key (PK) of the ParentTable.
Public propertyIsRowGUID
Flag which signals if this field is a RowGUID. Sqlserver specific.
Public propertyIsTimeStamp
Flag which signals if this field is a timestamp field.
(Inherited from DBField.)
Public propertyLength
Gets the length of the type of the target field.
(Inherited from DBField.)
Public propertyMarkedForDeletion
Gets or sets a value indicating whether this element is marked for deletion.
(Overrides DBElementBaseMarkedForDeletion.)
Public propertyNETTypeAsString
Gets the NET type as string.
(Inherited from DBField.)
Public propertyOrdinalPosition
The ordinal position of the instance of DBField in the table or view referenced by ParentTable or ParentView. (See DBTableField and DBViewField) OrdinalPosition is also called 'column identification number' and is the order in the fieldlist of the table or view. OrdinalPosition is 1-based, which means the first field has OrdinalPosition 1.
(Inherited from DBField.)
Public propertyParentTable
Reference to the DBTable instance which reflects the table this DBTableField instance belongs to.
Public propertyPrecision
Gets the precision of the type of the target field.
(Inherited from DBField.)
Public propertyScale
Gets the scale of the type of the target field.
(Inherited from DBField.)
Public propertyTypeDefinition
DBTypeDefinition instance representing the type of this field.
(Inherited from DBField.)
Protected propertyTypeOfDBElement
Gets the type of DB element in the form of a ContainedElementType value.
(Overrides DBElementBaseTypeOfDBElement.)
Public propertyUDTName
Gets the name of the UDT the db type is based on. If not applicable, an empty string is returned.
(Inherited from DBField.)
Top
Methods
  NameDescription
Protected method_member_ValueChangedTValue
Handles the ValueChanged event of the _member control.
(Inherited from DBField.)
Protected methodDeserializeAdditionalAttributes(XmlReader)
Deserializes attributes of this element's base class from the reader.
(Inherited from DBElementBase.)
Protected methodDeserializeAdditionalAttributes(XmlReader, DBSchema)
Deserializes the additional attributes.
(Overrides DBFieldDeserializeAdditionalAttributes(XmlReader, DBSchema).)
Public methodDeserializeFromReader
Deserializes from reader.
(Inherited from DBField.)
Public methodDispose
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
(Inherited from DBElementBase.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodForceOrdinalWrite
Forcefully set the value of the ordinal position member, bypassing change tracking.
(Inherited from DBField.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodHandleContainedListChangedTChangeType
Handles the contained list changed.
(Inherited from DBElementBase.)
Public methodHasChangeFlagsSet
Determines whether this field has one or more of the specified change flags set in the change tracker, false otherwise
Public methodLogError
Logs an error in the ErrorLog structure of this object.
(Inherited from DBElementBase.)
Public methodLogWarning
Logs the description as a warning.
(Inherited from DBElementBase.)
Protected methodMarkElementAsChangedTChangeType
Marks the element as changed.
(Inherited from DBElementBase.)
Public methodMarkElementAsRemoved
Marks the element as removed, which raises the ElementRemoved event.
(Inherited from DBElementBase.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodOnContainedElementAdded
Called when this object received an event of type ContainedElementAdded
(Inherited from DBElementBase.)
Protected methodOnContainedElementChanged
Called when this object received an event of type ContainedElementChanged
(Inherited from DBElementBase.)
Protected methodOnContainedElementRemoved
Called when this object received an event of type ContainedElementRemoved
(Inherited from DBElementBase.)
Protected methodOnPropertyChanged
Raises the PropertyChanged event.
(Inherited from DBElementBase.)
Protected methodPerformAdditionalContainedElementChangedWork
Performs the additional contained element changed work. Override if additional work has to be done after the OnContainedElementChanged method has run.
(Inherited from DBElementBase.)
Public methodResetChangeTracker
Resets the change tracker.
(Inherited from DBField.)
Public methodResetErrorLog
Resets the Error Log for this object to an empty list.
(Inherited from DBElementBase.)
Protected methodSerializeAdditionalAttributes
Serializes the additional attributes.
(Overrides DBElementBaseSerializeAdditionalAttributes(ISerializer).)
Public methodSerializeToWriter
Serializes the data in this class to the serializer passed in
(Inherited from DBField.)
Public methodToString
Returns the name of the field as string
(Inherited from DBField.)
Top
Events
  NameDescription
Public eventContainedElementAdded
Raised when an element was added to a collection (indirectly) contained in this element
(Inherited from DBElementBase.)
Public eventContainedElementChanged
Raised when an element contained in this element was changed.
(Inherited from DBElementBase.)
Public eventContainedElementRemoved
Raised when an element was removed from a collection (indirectly) contained in this element
(Inherited from DBElementBase.)
Public eventHasBeenChanged
Raised when the implementing element has been changed
(Inherited from DBElementBase.)
Public eventHasBeenRemoved
Raised when the implementing element has been removed from its container
(Inherited from DBElementBase.)
Public eventPropertyChanged
Occurs when a property value changes. (INotifyPropertyChanged)
(Inherited from DBElementBase.)
Top
Explicit Interface Implementations
  NameDescription
Explicit interface implementationPrivate propertyIDBRenameableElementIsRenamed
Gets a value indicating whether this instance is renamed to a new value.
Explicit interface implementationPrivate propertyIDBRenameableElementNewName
Gets the new name, if the element was renamed, otherwise the original name
Explicit interface implementationPrivate propertyIDBRenameableElementOriginalName
Gets the original name of the element.
Explicit interface implementationPrivate propertyIProjectElementFieldMapTargetElementCustomProperties
Gets the Custom properties (name - value pairs) read from the schema.
Explicit interface implementationPrivate propertyIProjectElementFieldMapTargetElementDbTypeAsString
Gets the DbType as string.
Explicit interface implementationPrivate propertyIProjectElementFieldMapTargetElementDefaultSequence
Gets the default sequence. Only set when the database supports default sequence hints. otherwise null
Explicit interface implementationPrivate propertyIProjectElementFieldMapTargetElementDefaultValue
The default value for this field. It is represented in a string, since it's only used in the code generation process. Is only valid if HasDefaultValue returns true.
Explicit interface implementationPrivate propertyIProjectElementFieldMapTargetElementDirection
Gets the direction of the parameter represented by this fieldmaptarget element
Explicit interface implementationPrivate propertyIProjectElementFieldMapTargetElementFieldName
Literal name of the field.
Explicit interface implementationPrivate propertyIProjectElementFieldMapTargetElementFullName
Gets the full name which is of the format: Parent's FullName.FieldName
Explicit interface implementationPrivate propertyIProjectElementFieldMapTargetElementHasDefaultValue
Flag which signals if this field has a default value. If true, DefaultValue should return the default value for this field.
Explicit interface implementationPrivate propertyIProjectElementFieldMapTargetElementIsComputed
Flag which signals if this field's value is retrieved using a function stored with the field in the database.
Explicit interface implementationPrivate propertyIProjectElementFieldMapTargetElementIsForeignKey
Flag which signals if this field has a foreign key (FK) constraint. By design, fields can have only one foreign key constraint, since more than one is semantically wrong.
Explicit interface implementationPrivate propertyIProjectElementFieldMapTargetElementIsIdentity
Flag which signals if this field is an autonumber/identity field.
Explicit interface implementationPrivate propertyIProjectElementFieldMapTargetElementIsNullable
Flag which signals if this field can contain NULL.
Explicit interface implementationPrivate propertyIProjectElementFieldMapTargetElementIsPrimaryKey
Flag which signals if this field is part of the primary key (PK) of the IDBTable referenced by Parent.
Explicit interface implementationPrivate propertyIProjectElementFieldMapTargetElementIsRowGUID
Flag which signals if this field is a RowGUID field. Microsoft Specific.
Explicit interface implementationPrivate propertyIProjectElementFieldMapTargetElementIsTimeStamp
Flag which signals if this field is a timestamp field.
Explicit interface implementationPrivate propertyIProjectElementFieldMapTargetElementLength
Gets the length of the type of the target field.
Explicit interface implementationPrivate propertyIProjectElementFieldMapTargetElementNETTypeAsString
Gets the .NET type as string.
Explicit interface implementationPrivate propertyIProjectElementFieldMapTargetElementOrdinalPosition
The ordinal position of the instance of DBField in the table or view referenced by ParentTable or ParentView. (See DBTableField and DBViewField) OrdinalPosition is also called 'column identification number' and is the order in the fieldlist of the table or view. OrdinalPosition is 1-based, which means the first field has OrdinalPosition 1.
Explicit interface implementationPrivate propertyIProjectElementFieldMapTargetElementParent
Reference to the IProjectElementMapTargetElement instance which reflects the table this IEntityFieldMapTargetElement instance belongs to.
Explicit interface implementationPrivate propertyIProjectElementFieldMapTargetElementPrecision
Gets the precision of the type of the target field.
Explicit interface implementationPrivate propertyIProjectElementFieldMapTargetElementScale
Gets the scale of the type of the target field.
Explicit interface implementationPrivate propertyIProjectElementFieldMapTargetElementTypeDefinition
DBTypeDefinition instance representing the type of this field.
Explicit interface implementationPrivate propertyIProjectElementFieldMapTargetElementUDTName
Gets the name of the UDT the db type is based on. If not applicable, an empty string is returned.
Top
See Also