Click or drag to resize

RootDocumentBuilder Class

Class which can build root document instances based on entity model elements passed into it. It uses internal state to keep track of documents currently build so to build a full document, it has to be used with all actions on the document. Is used in conjunction with tree visitors or standalone.
Inheritance Hierarchy
SystemObject
  SD.LLBLGen.Pro.ApplicationCore.DerivedModelRootDocumentBuilder

Namespace:  SD.LLBLGen.Pro.ApplicationCore.DerivedModel
Assembly:  SD.LLBLGen.Pro.ApplicationCore (in SD.LLBLGen.Pro.ApplicationCore.dll) Version: 5.11.0.0 (5.11.23.1114)
Syntax
Copy
public class RootDocumentBuilder

The RootDocumentBuilder type exposes the following members.

Constructors
  NameDescription
Public methodRootDocumentBuilder
Initializes a new instance of the RootDocumentBuilder class
Top
Properties
  NameDescription
Public propertyDocumentBuilt
Gets the document built with this instance. Is null if no call to HandleRootEntity has been seen.
Top
Methods
  NameDescription
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 methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodHandleEntity
Public methodHandleEntityField
Public methodHandleNavigator
Public methodHandleRootEntity
Creates the root document from the entity specified. All work will be done on this document or nested documents of this document
Public methodHandleValueType(ValueTypeDefinition, IFieldElementCore)
Handles a value type. This method returns an embedded document, created from the valuetype specified, using the field specified for its name and navigational path.
Public methodHandleValueType(ValueTypeDefinition, String, ReferencedElement)
Handles a value type. This method returns an embedded document, created from the valuetype specified, using the referenced element specified as its root element
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodPostHandleEntity
Method which does housecleaning for when an entity was completely handled (which can be subtype, entity or root entity)
Public methodPostHandleNavigator
Method which does housecleaning for when a navigator was completely handled.
Public methodPostHandleValueType
Method which does housecleaning for when an entity was completely handled (which can be subtype, entity or root entity)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Remarks
If used standalone, be sure to call HandleRootEntity(EntityDefinition, String, Boolean) while passing the setting to create validators as by default this builder doesn't add validators to the document it creates itself as for visitor usage this isn't needed.
See Also