Click or drag to resize
DocumentDefinitionBase Class
Class which defines a document base functionality, which is a de-normalized definition of a subgraph inside an entity model. Subtypes define documents that either can be used as root documents or as embedded documents.
Inheritance Hierarchy

Namespace: SD.LLBLGen.Pro.ApplicationCore.DerivedModel
Assembly: SD.LLBLGen.Pro.ApplicationCore (in SD.LLBLGen.Pro.ApplicationCore.dll) Version: 5.0.0.0 (5.0.0)
Syntax
Copy
[FilterPropertiesAttribute]
public class DocumentDefinitionBase : ISerializableToXml, 
	INotifyPropertyChanged, INotifyAsChanged, INotifyAsRemoved, IDataErrorInfo, IOutputSettingValuesTarget

The DocumentDefinitionBase type exposes the following members.

Constructors
  NameDescription
Protected methodDocumentDefinitionBase(FrameworkSettingTargetElementType)
For deserialization purposes only.
Protected methodDocumentDefinitionBase(String, ReferencedElement, FrameworkSettingTargetElementType)
Initializes a new instance of the DocumentDefinitionBase class.
Top
Properties
  NameDescription
Public propertyCardinality
Gets the cardinality of this document, whether it represents one or more elements. Used when this instance is an embedded document.
Public propertyContainerName
Returns the name of the containing element this object is contained in.
Protected propertyDeserializing
Gets a value indicating whether this DocumentDefinitionBase is deserializing.
Public propertyFields
Gets the fields of this document definition
Public propertyFullName
Gets the full name of this document, which is containingelementname.documentname
Public propertyName
Gets / sets the name of this document definition
Public propertyOutputSettingValues
Gets the output setting values of this target.
Public propertyReferencedElementName
Public propertyRootElement
Gets the root entity of this document.
Public propertyRootEntityGroupName
Public propertyRootEntityName
Public propertyRootValueTypeGroupName
Public propertyRootValueTypeName
Public propertyTargetElementType
Gets the target element type of this target.
Top
Methods
  NameDescription
Public methodAddField
Adds the field specified as a new field to this document.
Protected methodAppendAdditionalDocElementsToStringBuilder
Protected methodAppendToStringBuilder
Appends descriptions of its contents to the string builder specified. For ToString()
Protected methodBindAdditionalEvents
Binds the additional event handlers of contained elements.
Public methodBindEvents
Binds the event handlers of contained elements.
Public methodClearErrors
Clears the errors set in this object.
Public methodContainsSameField
Determines whether
Public methodCreateValidators
Creates the validators for the elements contained in this class.
Protected methodDeserializeAdditionalAttributes
Deserializes the additional attributes from the xml pointed at by the passed in xml reader
Protected methodDeserializeAdditionalData
Deserializes the additional data from the xml pointed at by the passed in reader.
Protected methodDetermineFullPathToRootDocument
Determines the full path to the root document.
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.
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 methodGetFieldDerivedFromEntityField
Gets the field derived from the entity field specified, which is a field in the root entity of this document.
Public methodGetFieldsOfCompleteTree
Enumerates over the fields in this document and the fields of embedded documents, using depth-first search traversal.
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Protected methodGetNameValidator
Gets the validator for the name property.
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.)
Protected methodHandleFieldRemoved
Performs the work necessary after a field has been removed.
Protected methodHandleFieldsListChanged
Protected methodHandleRootElementValueTypeFieldsChanged
Called when the fields collection in the valuetype in the root element changed.
Protected methodMarkDocumentAsChanged
Marks the document definition as changed.
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.
Protected methodPerformPostDeserializationWork
Performs the post deserialization work necessary.
Protected methodRaiseHasBeenRemoved
Public methodRemoveField
Removes the field specified from this document
Protected methodSerializeAdditionalAttributes
Serializes the additional attributes of this class to the xml.
Protected methodSerializeAdditionalElements
Serializes the additional elements of this object to the xml
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 methodUnbindAdditionalEvents
Unbinds the additional event handlers of contained elements.
Public methodUnbindEvents
Unbinds the event handlers of contained elements
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.
Protected methodUpdateOutputSettingValuesContainerOfNestedElementsWithDefaults
Updates the option values containers with defaults in nested elements, like fields. The base implementation traverses the fields.
Protected methodValidate
Validates this instance.
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.
Public eventHasBeenChanged
Raised when the implementing element has been changed
Public eventHasBeenRemoved
Raised when the implementing element has been removed from its container
Public eventPropertyChanged
Occurs when a property value changes. (INotifyPropertyChanged)
Top
Explicit Interface Implementations
See Also