Click or drag to resize

RootDocumentDefinition Class

Class which defines a root document definition, which is used to define a document at the root level in the DerivedModelDefinition.
Inheritance Hierarchy
SystemObject
  SD.LLBLGen.Pro.ApplicationCore.DerivedModelDocumentDefinitionBase
    SD.LLBLGen.Pro.ApplicationCore.DerivedModelRootDocumentDefinition

Namespace:  SD.LLBLGen.Pro.ApplicationCore.DerivedModel
Assembly:  SD.LLBLGen.Pro.ApplicationCore (in SD.LLBLGen.Pro.ApplicationCore.dll) Version: 5.6.0.0 (5.6.19.0117)
Syntax
public class RootDocumentDefinition : DocumentDefinitionBase

The RootDocumentDefinition type exposes the following members.

Constructors
  NameDescription
Public methodRootDocumentDefinition
Initializes a new instance of the RootDocumentDefinition class. For deserialization only.
Public methodRootDocumentDefinition(String, ReferencedElement)
Initializes a new instance of the RootDocumentDefinition class.
Public methodRootDocumentDefinition(String, EntityDefinition)
Initializes a new instance of the RootDocumentDefinition class.
Top
Properties
  NameDescription
Public propertyCacheIDField
If true, it will cache the ID Field determined in the property IDField. If false, it will obtain the IDField at every request
Public propertyCardinality
Gets the cardinality of this document, whether it represents one or more elements. Used when this instance is an embedded document.
(Inherited from DocumentDefinitionBase.)
Public propertyContainerName
Returns the name of the containing element this object is contained in, which is the derived model name.
(Overrides DocumentDefinitionBaseContainerName.)
Public propertyContainingModel
Gets or sets the contained model of this root document.
Public propertyContainingModelName
Protected propertyDeserializing
Gets a value indicating whether this DocumentDefinitionBase is deserializing.
(Inherited from DocumentDefinitionBase.)
Public propertyFields
Gets the fields of this document definition
(Inherited from DocumentDefinitionBase.)
Public propertyFullName
Gets the full name of this document, which is containingmodel.documentname.
(Overrides DocumentDefinitionBaseFullName.)
Public propertyHasIDField
Public propertyIDField
Gets the ID Field of this document. Can be null. It returns the (if any) field derived from the first PK field (regarding field ordering) of the root entity of this document.
Public propertyName
Gets / sets the name of this document definition
(Inherited from DocumentDefinitionBase.)
Public propertyOutputSettingValues
Gets the output setting values of this target.
(Inherited from DocumentDefinitionBase.)
Public propertyReferencedElementName (Inherited from DocumentDefinitionBase.)
Public propertyRootElement
Gets the root entity of this document.
(Inherited from DocumentDefinitionBase.)
Public propertyRootEntityGroupName (Inherited from DocumentDefinitionBase.)
Public propertyRootEntityName (Inherited from DocumentDefinitionBase.)
Public propertyRootValueTypeGroupName (Inherited from DocumentDefinitionBase.)
Public propertyRootValueTypeName (Inherited from DocumentDefinitionBase.)
Public propertyTargetElementType
Gets the target element type of this target.
(Inherited from DocumentDefinitionBase.)
Top
Methods
  NameDescription
Public methodAddField
Adds the field specified as a new field to this document.
(Inherited from DocumentDefinitionBase.)
Protected methodAppendAdditionalDocElementsToStringBuilder (Inherited from DocumentDefinitionBase.)
Protected methodAppendToStringBuilder
Appends descriptions of its contents to the string builder specified. For ToString()
(Inherited from DocumentDefinitionBase.)
Protected methodBindAdditionalEvents
Binds the additional event handlers of contained elements.
(Inherited from DocumentDefinitionBase.)
Public methodBindEvents
Binds the event handlers of contained elements.
(Inherited from DocumentDefinitionBase.)
Public methodClearErrors
Clears the errors set in this object.
(Inherited from DocumentDefinitionBase.)
Public methodContainsSameField
Determines whether
(Inherited from DocumentDefinitionBase.)
Public methodCreateValidators
Creates the validators for the elements contained in this class.
(Inherited from DocumentDefinitionBase.)
Protected methodDeserializeAdditionalAttributes
Deserializes the additional attributes from the xml pointed at by the passed in xml reader
(Inherited from DocumentDefinitionBase.)
Protected methodDeserializeAdditionalData
Deserializes the additional data from the xml pointed at by the passed in reader.
(Inherited from DocumentDefinitionBase.)
Protected methodDetermineFullPathToRootDocument
Determines the full path to the root document.
(Overrides DocumentDefinitionBaseDetermineFullPathToRootDocument.)
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.)
Protected methodGetAdditionalFields
Gets the additional fields of this document, e.g. embedded in objects like subtypes.
(Inherited from DocumentDefinitionBase.)
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.
(Inherited from DocumentDefinitionBase.)
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.
(Inherited from DocumentDefinitionBase.)
Public methodGetAllEmbeddedDocuments
Gets all embedded documents in this root document.
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)
(Inherited from DocumentDefinitionBase.)
Protected methodGetFieldDerivedFromEntityField
Gets the field derived from the entity field specified, which is a field in the root entity of this document.
(Inherited from DocumentDefinitionBase.)
Public methodGetFieldsOfCompleteTree
Enumerates over the fields in this document and the fields of embedded documents, using depth-first search traversal.
(Inherited from DocumentDefinitionBase.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Protected methodGetNameValidator
Gets the validator for the name property.
(Overrides DocumentDefinitionBaseGetNameValidator.)
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.
(Inherited from DocumentDefinitionBase.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodHandleFieldRemoved
Performs the work necessary after a field has been removed.
(Overrides DocumentDefinitionBaseHandleFieldRemoved(DocumentFieldDefinition).)
Protected methodHandleFieldsListChanged (Inherited from DocumentDefinitionBase.)
Protected methodHandleRootElementValueTypeFieldsChanged
Called when the fields collection in the valuetype in the root element changed.
(Inherited from DocumentDefinitionBase.)
Protected methodMarkDocumentAsChanged
Marks the document definition as changed.
(Inherited from DocumentDefinitionBase.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodPerformAdditionalUpdateDocumentShapeWithThisDocsContents
Performs additional work for the update document shape with this docs contents.
(Inherited from DocumentDefinitionBase.)
Protected methodPerformPostDeserializationWork
Performs the post deserialization work necessary.
(Inherited from DocumentDefinitionBase.)
Protected methodRaiseHasBeenRemoved (Inherited from DocumentDefinitionBase.)
Public methodRemoveField
Removes the field specified from this document
(Inherited from DocumentDefinitionBase.)
Protected methodSerializeAdditionalAttributes
Serializes the additional attributes of this class to the xml.
(Inherited from DocumentDefinitionBase.)
Protected methodSerializeAdditionalElements
Serializes the additional elements of this object to the xml
(Inherited from DocumentDefinitionBase.)
Public methodSerializeToWriter
Serializes the data in this class to the serializer passed in
(Inherited from DocumentDefinitionBase.)
Public methodToString
Returns a string that represents the current object.
(Inherited from DocumentDefinitionBase.)
Protected methodUnbindAdditionalEvents
Unbinds the additional event handlers of contained elements.
(Inherited from DocumentDefinitionBase.)
Public methodUnbindEvents
Unbinds the event handlers of contained elements
(Inherited from DocumentDefinitionBase.)
Public methodUpdateDocumentShape
Updates the shape of this document with the new shape specified. It removes fields which sources are no longer in the newShape. It adds new fields which are present in newShape but aren't in this document.
Public methodUpdateDocumentShapeWithThisDocsContents
Updates the document shape specified using the fields in this document. A field which is in this document but not in the specified document 'toUpdate' is added to the specified document toUpdate.
(Inherited from DocumentDefinitionBase.)
Protected methodUpdateOutputSettingValuesContainerOfNestedElementsWithDefaults
Updates the option values containers with defaults in nested elements, like fields. The base implementation traverses the fields.
(Inherited from DocumentDefinitionBase.)
Protected methodValidate
Validates this instance.
(Overrides DocumentDefinitionBaseValidate.)
Top
Events
  NameDescription
Public eventDocumentDefinitionChanged
Event which is raised when the definition of this DocumentDefinition has been changed. What has changed is enclosed inside the event args.
(Inherited from DocumentDefinitionBase.)
Public eventHasBeenChanged
Raised when the implementing element has been changed
(Inherited from DocumentDefinitionBase.)
Public eventHasBeenRemoved
Raised when the implementing element has been removed from its container
(Inherited from DocumentDefinitionBase.)
Public eventPropertyChanged
Occurs when a property value changes. (INotifyPropertyChanged)
(Inherited from DocumentDefinitionBase.)
Top
Explicit Interface Implementations
See Also