Click or drag to resize

FieldElement Class

Class for a field definition in an entity.
Inheritance Hierarchy

Namespace:  SD.LLBLGen.Pro.ApplicationCore.EntityModel
Assembly:  SD.LLBLGen.Pro.ApplicationCore (in SD.LLBLGen.Pro.ApplicationCore.dll) Version: 5.9.0.0 (5.9.0)
Syntax
Copy
[FilterPropertiesAttribute]
public class FieldElement : IIdentifyingField, 
	IFieldElementCore, INotifyAsRemoved, IOutputSettingValuesTarget, IMappableField, INotifyPropertyChanged, 
	INotifyAsChanged, ISerializableToXml, IDataErrorInfo, IEditableObject

The FieldElement type exposes the following members.

Constructors
  NameDescription
Public methodFieldElement
Initializes a new instance of the FieldElement class.
Top
Properties
  NameDescription
Public propertyContainingElement
Gets the containing element
Public propertyContainingElementFullName
Gets the full name of the containing element.
Public propertyDescription
Gets or sets the description of this Field
Public propertyDirection
Gets or sets the direction of the field's if it would be used as a parameter.
Public propertyError
Gets an error message indicating what is wrong with this object. The default is an empty string ("")
Public propertyFieldIndex
The field index, starting with 0, for this field. A field index is by default -1 (undefined) and is used to sort fields in a given order. It is not used as external index for code generation, but solely for field ordering inside the fields of a groupable model element (except for stored procedure calls).
Public propertyFieldType
Gets or sets the type of the field.
Public propertyFullName
Gets the full name of the field. This is the name of the field with optionally (FK) appended to it if the field is an FK field.
Public propertyFullNameWithContainer
Gets the full name with container.
Public propertyFullNameWithContainerAndTypeName
Gets the full name of the field with the container name and the name of the type, in the format containername.fieldname (fieldtype)
Public propertyIsAutoCreatedFkField
Gets a value indicating whether this instance is auto created fk field. Auto-created FK fields are fields which are auto-created when a relationship was created and will be removed if the relationship will removed.
Public propertyIsChanged
Gets or sets the flag to signal that this element has been changed
Public propertyIsDiscriminator
Gets or sets a value indicating whether this instance is the discriminator field of the containing entity. Ignored in value types.
Public propertyIsForeignKeyField
Gets a value indicating whether this instance is a foreign key field. Returns true if this field is in at least one FieldFieldRelationship instance.
Public propertyIsOptional
Gets or sets the IsOptional flag
Public propertyIsPartOfIdentifyingFields
Gets or sets a value indicating whether this instance is part of the identifying fields
Public propertyIsReadOnly
Gets or sets the IsReadOnly flag
Public propertyIsValid
Gets a value indicating whether this instance is valid.
Public propertyItem
Gets the String with the specified column name.
Public propertyMaxLength
Gets or sets the maximum length of this field.
Public propertyName
Gets or sets the name of this Field
Public propertyNameValidatorToUse
Sets the name validator.
Public propertyNumericValidatorToUse
Sets the numeric validator to use.
Public propertyOutputSettingValues
Gets the output setting values of this target.
Public propertyPrecision
Gets or sets the precision.
Public propertyScale
Gets or sets the scale.
Public propertyTargetElementType
Gets the target element type of this target.
Top
Methods
  NameDescription
Public methodBeginEdit
Begins an edit on an object.
Public methodCancelEdit
Discards changes since the last BeginEdit call.
Public methodClone
Clones this instance.
Public methodDeserializeFromReader
Deserializes the data for this class from the xml reader passed in
Public methodEndEdit
Pushes changes since the last BeginEdit or AddNew call into the underlying object.
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 methodGetAdditionalInterfaces
Gets the additional interfaces, if applicable, for this element, where the default interfaces are prefiltered with the ignored interfaces defined in this element. All interface macros are replaced with real names.
Public methodGetAdditionalNamespaces
Gets the additional namespaces, if applicable, for this element, where the default namespaces are prefiltered with the ignored namespaces defined in this element. All namespace macros are replaced with real names.
Public methodGetAttributes
Gets the attributes, if applicable, for this element, where the default attributes are prefiltered with the ignored attributes defined in this element. All name macros and $length/$precision/$scale macros are replaced with real values. (if applicable)
Protected methodGetElementNameForXml
Gets the element name for XML.
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetRealStringSettingValueWithMacrosResolved
Gets the real setting value of the setting with the name specified as string. Also resolves any macros defined in the value (if any) to real values.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodMarkAsRemoved
Marks this field as removed. This routine will raise INotifyAsRemoved.ElementRemoved
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodOnPropertyChanged
Called when a property was changed
Public methodSerializeToWriter
Serializes the data in this class to the serializer passed in
Public methodToString
Returns a String that represents the current Object.
(Overrides ObjectToString.)
Protected methodValidate
Validates this instance.
Protected methodValidate(Action, Boolean)
Validates this instance.
Top
Events
  NameDescription
Public eventContainedStringPropertyChanged
Event which is raised when a string based member of this object has been changed. Which string based member and its old/new value is enclosed in the event args.
Public eventFieldElementChanged
Event for signaling a change in this object
Public eventHasBeenChanged
Raised when the implementing element has been changed
Public eventHasBeenRemoved
Raised when the implementing element has been removed from its container
Public eventIFieldElementCoreChanged
Event for signaling a change in this object
Public eventPropertyChanged
Occurs when a property value changes. (INotifyPropertyChanged)
Top
Explicit Interface Implementations
  NameDescription
Explicit interface implementationPrivate methodIFieldElementCoreClone
Clones this instance
Explicit interface implementationPrivate propertyIFieldElementCoreContainingElement
Gets the containing element, be it a valuetype or an entity
Explicit interface implementationPrivate propertyIFieldElementCoreFieldType
Gets the type of the field.
Explicit interface implementationPrivate propertyIFieldElementCoreFieldTypeAsString
Gets the field type as string, or string.Empty if field type is null.
Explicit interface implementationPrivate propertyIFieldElementCoreFullName
Gets the full name of the field.
Explicit interface implementationPrivate propertyIFieldElementCoreIsDiscriminator
Gets or sets a value indicating whether this instance is the discriminator field of the containing entity. Ignored in value types.
Explicit interface implementationPrivate propertyIFieldElementCoreIsOptional
Gets or sets a value indicating whether this field is optional .
Explicit interface implementationPrivate propertyIFieldElementCoreIsPartOfIdentifyingFields
Gets or sets a value indicating whether this instance is part of the identifying fields
Explicit interface implementationPrivate propertyIFieldElementCoreIsReadOnly
Gets the IsReadOnly flag
Explicit interface implementationPrivate propertyIFieldElementCoreMaxLength
Gets the maximum length of this field.
Explicit interface implementationPrivate propertyIFieldElementCoreName
Gets or sets the name of this Field
Explicit interface implementationPrivate propertyIFieldElementCorePrecision
Gets the precision.
Explicit interface implementationPrivate propertyIFieldElementCoreScale
Gets the scale.
Explicit interface implementationPrivate propertyIFieldElementCoreSuppressEvents
Gets or sets a value indicating whether events have to be suppressed
Explicit interface implementationPrivate propertyIMappableFieldCanSetNewFieldType
Gets a value indicating whether this instance can set the FieldType property
Explicit interface implementationPrivate propertyIMappableFieldContainingElement
Gets the containing element, be it a valuetype or an entity
Explicit interface implementationPrivate propertyIMappableFieldDescription
Gets or sets the description of this Field
Explicit interface implementationPrivate propertyIMappableFieldFieldIndex
The field index, starting with 0, for this field. A field index is by default -1 (undefined) and is used to sort fields in a given order. It is not used as external index for code generation, but solely for field ordering inside the fields of a groupable model element (except for stored procedure calls).
Explicit interface implementationPrivate propertyIMappableFieldFieldType
Gets or sets the type of the field.
Explicit interface implementationPrivate propertyIMappableFieldFullName
Gets the full name of the field.
Explicit interface implementationPrivate propertyIMappableFieldIsDiscriminator
Gets a value indicating whether this instance is the discriminator field of the containing entity. Ignored in value types.
Explicit interface implementationPrivate propertyIMappableFieldIsOptional
Gets or sets the IsOptional flag
Explicit interface implementationPrivate propertyIMappableFieldIsPartOfIdentifyingFields
Gets or sets a value indicating whether this instance is part of the identifying fields
Explicit interface implementationPrivate propertyIMappableFieldIsReadOnly
Gets or sets the IsReadOnly flag
Explicit interface implementationPrivate methodIMappableFieldMarkAsRemoved
Marks this field as removed. This routine will raise INotifyAsRemoved.HasBeenRemoved
Explicit interface implementationPrivate propertyIMappableFieldMaxLength
Gets or sets the maximum length of this field.
Explicit interface implementationPrivate propertyIMappableFieldName
Gets or sets the name of this Field
Explicit interface implementationPrivate propertyIMappableFieldOutputSettingValues
Gets the output setting values of this target.
Explicit interface implementationPrivate propertyIMappableFieldPrecision
Gets or sets the precision.
Explicit interface implementationPrivate propertyIMappableFieldScale
Gets or sets the scale.
Explicit interface implementationPrivate methodIMappableFieldSetNewFieldType
Sets the new type of the field. If CanSetNewFieldType returns false, this method is a no-op.
Explicit interface implementationPrivate methodIMappableFieldSetNewFieldTypeProperties
Sets the new field type properties.
Explicit interface implementationPrivate propertyIMappableFieldTypeOfMappableField
Gets the type of mappable field this interface is implemented on.
Explicit interface implementationPrivate propertyIOutputSettingValuesTargetTargetName
Gets the name of the element.
Top
See Also