EmbeddedDocumentDefinition Class |
Namespace: SD.LLBLGen.Pro.ApplicationCore.DerivedModel
The EmbeddedDocumentDefinition type exposes the following members.
Name | Description | |
---|---|---|
EmbeddedDocumentDefinition |
For deserialization purposes only.
| |
EmbeddedDocumentDefinition(String, ReferencedElement) |
Initializes a new instance of the EmbeddedDocumentDefinition class.
| |
EmbeddedDocumentDefinition(String, EntityDefinition) |
Initializes a new instance of the EmbeddedDocumentDefinition class.
|
Name | Description | |
---|---|---|
Cardinality |
Gets the cardinality of this document, whether it represents one or more elements. Used when this instance is an embedded document.
(Overrides DocumentDefinitionBaseCardinality.) | |
ContainerName |
Returns the name of the containing element this object is contained in, which is the name of the embedding field
(Overrides DocumentDefinitionBaseContainerName.) | |
ContainingField |
The field of which this instance is the document source.
| |
Deserializing |
Gets a value indicating whether this DocumentDefinitionBase is deserializing.
(Inherited from DocumentDefinitionBase.) | |
ElementName |
Name of the source, which is determined from the actual object implementing this interface.
| |
Fields |
Gets the fields of this document definition
(Inherited from DocumentDefinitionBase.) | |
FullName |
Gets the full name of this document, which is containingfieldname.documentname.
(Overrides DocumentDefinitionBaseFullName.) | |
FullPathToRoot | ||
Name |
Gets / sets the name of this document definition
(Inherited from DocumentDefinitionBase.) | |
OutputSettingValues |
Gets the output setting values of this target.
(Inherited from DocumentDefinitionBase.) | |
ReferencedElementName | (Inherited from DocumentDefinitionBase.) | |
RootElement |
Gets the root entity of this document.
(Inherited from DocumentDefinitionBase.) | |
RootEntityGroupName | (Inherited from DocumentDefinitionBase.) | |
RootEntityName | (Inherited from DocumentDefinitionBase.) | |
RootValueTypeGroupName | (Inherited from DocumentDefinitionBase.) | |
RootValueTypeName | (Inherited from DocumentDefinitionBase.) | |
SetOfSubtypes |
Gets the set of subtypes for this embedded document. This are documents based on subtypes of the root entity of this document.
| |
SourceElementTypeAsString |
Gets the source element type as string, which is e.g. the field type if this source represents a field, or 'entity' if it's an entity.
| |
SourceType |
The type of source, e.g. multi element or single element or a field.
| |
TargetElementType |
Gets the target element type of this target.
(Inherited from DocumentDefinitionBase.) |
Name | Description | |
---|---|---|
AddField |
Adds the field specified as a new field to this document.
(Inherited from DocumentDefinitionBase.) | |
AddSubtype |
Adds the specified subtype to the set of sub types of this embedded document.
| |
AppendAdditionalDocElementsToStringBuilder | (Inherited from DocumentDefinitionBase.) | |
AppendToStringBuilder | (Overrides DocumentDefinitionBaseAppendToStringBuilder(StringBuilder, Int32).) | |
BindAdditionalEvents |
Binds the additional event handlers of contained elements.
(Overrides DocumentDefinitionBaseBindAdditionalEvents.) | |
BindEvents |
Binds the event handlers of contained elements.
(Inherited from DocumentDefinitionBase.) | |
ClearErrors |
Clears the errors set in this object.
(Inherited from DocumentDefinitionBase.) | |
Clone |
Clones this instance using deep cloning. It doesn't clone elements referenced from the entity model. There it uses shallow clone.
| |
ContainsSameField |
Determines whether
(Inherited from DocumentDefinitionBase.) | |
CreateValidators |
Creates the validators for the elements contained in this class.
(Inherited from DocumentDefinitionBase.) | |
DeserializeAdditionalAttributes |
Deserializes the additional attributes from the xml pointed at by the passed in xml reader
(Inherited from DocumentDefinitionBase.) | |
DeserializeAdditionalData |
Deserializes the additional data from the xml pointed at by the passed in reader.
(Overrides DocumentDefinitionBaseDeserializeAdditionalData(XmlReader, Project, ReferencedElement).) | |
DetermineFullPathToRootDocument |
Determines the full path to the root document.
(Overrides DocumentDefinitionBaseDetermineFullPathToRootDocument.) | |
Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) | |
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) | |
GetAdditionalFields |
Gets the additional fields of this document, e.g. embedded in objects like subtypes.
(Overrides DocumentDefinitionBaseGetAdditionalFields.) | |
GetAdditionalInterfaces |
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.) | |
GetAdditionalNamespaces |
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.) | |
GetAllInheritedFields |
Gets all inherited fields, which are all fields (indirectly) inherited by the supertype document plus the fields of the supertype document. If this embedded
document isn't in a set of subtypes, this method returns an empty list.
| |
GetAllSubtypesInCompleteHierarchy |
Gets all subtypes in the complete hierarchy, so also the indirect subtypes of the subtypes in this document.
| |
GetAttributes |
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.) | |
GetContainingDerivedModel |
Gets the derived model definition this element is part of.
(Overrides DocumentDefinitionBaseGetContainingDerivedModel.) | |
GetFieldDerivedFromEntityField |
Gets the field derived from the entity field specified, which is a field in the root entity of this document.
(Inherited from DocumentDefinitionBase.) | |
GetFieldsOfCompleteTree |
Enumerates over the fields in this document and the fields of embedded documents, using depth-first search traversal.
(Inherited from DocumentDefinitionBase.) | |
GetHashCode | Serves as the default hash function. (Inherited from Object.) | |
GetNameValidator |
Gets the validator for the name property.
(Overrides DocumentDefinitionBaseGetNameValidator.) | |
GetRealStringSettingValueWithMacrosResolved |
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.) | |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
HandleFieldRemoved |
Performs the work necessary after a field has been removed.
(Inherited from DocumentDefinitionBase.) | |
HandleFieldsListChanged | (Overrides DocumentDefinitionBaseHandleFieldsListChanged(ListChangedEventArgs).) | |
HandleRootElementValueTypeFieldsChanged |
Called when the fields collection in the valuetype in the root element changed, so a field was removed or added. We simply rebuild the document and update ourselves.
(Overrides DocumentDefinitionBaseHandleRootElementValueTypeFieldsChanged.) | |
IsSame |
Returns true if the passed in IDocumentFieldSource instance can be seen as a source originating from the same element. This means that
even if the passed in element or this element has been changed, e.g. elementName has been changed, it will still return true if the original
source is equal. This method is therefore different from 'Equals' which compares all elements.
| |
MarkAsRemoved |
Marks this document as removed by raising its HasBeenRemoved event.
| |
MarkDocumentAsChanged |
Marks the document definition as changed.
(Overrides DocumentDefinitionBaseMarkDocumentAsChanged(DocumentDefinitionChangeType).) | |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
PerformAdditionalUpdateDocumentShapeWithThisDocsContents |
Performs additional work for the update document shape with this docs contents.
(Overrides DocumentDefinitionBasePerformAdditionalUpdateDocumentShapeWithThisDocsContents(EmbeddedDocumentDefinition, ListDocumentFieldDefinition).) | |
PerformPostDeserializationWork | (Overrides DocumentDefinitionBasePerformPostDeserializationWork.) | |
RaiseHasBeenRemoved | (Inherited from DocumentDefinitionBase.) | |
RemoveAdditionalType |
Removes the additional type specified from the set of additional types of this embedded document.
| |
RemoveField |
Removes the field specified from this document
(Inherited from DocumentDefinitionBase.) | |
RenameOurselvesIfRequired |
Called when the root element's name was changed
(Overrides DocumentDefinitionBaseRenameOurselvesIfRequired(GroupableModelElementChangeType, String, String).) | |
SerializeAdditionalAttributes |
Serializes the additional attributes of this class to the xml.
(Inherited from DocumentDefinitionBase.) | |
SerializeAdditionalElements |
Serializes the additional elements of this class.
(Overrides DocumentDefinitionBaseSerializeAdditionalElements(ISerializer).) | |
SerializeToWriter |
Serializes the data in this class to the serializer passed in
(Inherited from DocumentDefinitionBase.) | |
SignalContainedElementChanged | (Overrides DocumentDefinitionBaseSignalContainedElementChanged(GroupableModelElementChangeType, String, String).) | |
ToString |
Returns a string that represents the current object.
(Inherited from DocumentDefinitionBase.) | |
UnbindAdditionalEvents |
Unbinds the additional event handlers of contained elements.
(Overrides DocumentDefinitionBaseUnbindAdditionalEvents.) | |
UnbindEvents |
Unbinds the event handlers of contained elements
(Inherited from DocumentDefinitionBase.) | |
UpdateDocumentShapeWithThisDocsContents |
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.) | |
UpdateOutputSettingValuesContainerOfNestedElementsWithDefaults |
Updates the option values containers with defaults in nested elements, like fields. The base implementation traverses the fields.
(Overrides DocumentDefinitionBaseUpdateOutputSettingValuesContainerOfNestedElementsWithDefaults(FrameworkSettingTargetElementType, OutputSettingValuesContainer).) | |
Validate |
Validates this instance.
(Overrides DocumentDefinitionBaseValidate.) |
Name | Description | |
---|---|---|
ContainedStringPropertyChanged |
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.
| |
DocumentDefinitionChanged |
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.) | |
HasBeenChanged |
Raised when the implementing element has been changed
(Inherited from DocumentDefinitionBase.) | |
HasBeenRemoved |
Raised when the implementing element has been removed from its container
(Inherited from DocumentDefinitionBase.) | |
PropertyChanged |
Occurs when a property value changes. (INotifyPropertyChanged)
(Inherited from DocumentDefinitionBase.) |
Name | Description | |
---|---|---|
IDataErrorInfoError |
Gets an error message indicating what is wrong with this object.
(Inherited from DocumentDefinitionBase.) | |
IDataErrorInfoItem |
Gets the String with the specified column name.
(Inherited from DocumentDefinitionBase.) | |
IDocumentFieldSourceCreateValidators |
Creates validator objects for the source object, if required.
| |
IDocumentFieldSourceSerializeToWriter |
Serializes the source to the serializer specified.
| |
IDocumentFieldSourceUpdateOutputSettingValuesContainerWithDefaults |
Updates the output setting values container of this element (if applicable) with the defaults in the container specified.
| |
IOutputSettingValuesTargetTargetName |
Gets the name of the element.
(Inherited from DocumentDefinitionBase.) |