Click or drag to resize

DocumentFieldDefinition Class

Class which represents a document field, and which includes its source.
Inheritance Hierarchy
SystemObject
  SD.LLBLGen.Pro.ApplicationCore.DerivedModelDocumentFieldDefinition

Namespace:  SD.LLBLGen.Pro.ApplicationCore.DerivedModel
Assembly:  SD.LLBLGen.Pro.ApplicationCore (in SD.LLBLGen.Pro.ApplicationCore.dll) Version: 5.9.0.0 (5.9.0)
Syntax
[FilterPropertiesAttribute]
public class DocumentFieldDefinition : INotifyAsRemoved, 
	IDataErrorInfo, IOutputSettingValuesTarget

The DocumentFieldDefinition type exposes the following members.

Constructors
  NameDescription
Public methodDocumentFieldDefinition(IDocumentFieldSource)
Initializes a new instance of the DocumentFieldDefinition class.
Public methodDocumentFieldDefinition(IDocumentFieldSource, String)
Initializes a new instance of the DocumentFieldDefinition class.
Top
Properties
  NameDescription
Public propertyCanBeDenormalized
Gets a value indicating whether this instance can be denormalized (true) or not (false).
Public propertyContainingDerivedElementName
Gets the name of the containing derived element. this is a proxy property for UI purposes.
Public propertyContainingDocument
Returns the document this field is part of, or null if not determinable.
Public propertyContainingDocumentName
Gets the name of the containing document, which is the full name of the containing document or empty string if the field isn't in any document.
Public propertyFullName
Gets the full name of the field which is in the format: containingdocumentname.fieldname.
Public propertyFullPathToRoot
Gets the full path to root.
Public propertyHasBeenRenamed
Public propertyIsDenormalized
Gets a value indicating that this field is a denormalized field from a related document
Public propertyIsIDField
Gets a value indicating whether this instance is the ID field in the containing document. If the containing document isn't a root document, this property returns false.
Public propertyName
Gets or sets the name of this document field. Initially it's the name of the source, however if set, it overrides the name of the source. Setting it to an empty string or null with reset it to the name of the source.
Public propertyOutputSettingValues
Gets the output setting values of this target.
Public propertySource
Gets the source this field is derived from
Public propertySourceFieldIsOptional
Gets a value indicating whether the source field is optional or not. If the source isn't a field, this property returns false.
Public propertySourceFieldIsReadOnly
Gets a value indicating whether the source field is read-only or not. If the source isn't a field, this property returns false.
Public propertySourceFieldLength
Gets a value indicating whether the (max)length of the source field. If the source isn't a field, this property returns -1.
Public propertySourceFieldType
Gets the type of the source field, if the source is an entity field, null otherwise.
Public propertyTargetElementType
Gets the target element type of this target.
Top
Methods
  NameDescription
Public methodClone
Clones this instance using deep cloning. Doesn't clone objects from the entity model.
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)
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 and removes itself from its containing list (if any).
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodSerializeToWriter
Serializes the source to the serializer specified.
Public methodToString
Returns a string that represents the current object.
(Overrides ObjectToString.)
Top
Events
  NameDescription
Public eventHasBeenRemoved
Raised when the implementing element has been removed from its container
Top
Explicit Interface Implementations
See Also