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

SystemObject
  SD.LLBLGen.Pro.ApplicationCore.DerivedModelDocumentDefinitionBase
    SD.LLBLGen.Pro.ApplicationCore.DerivedModelEmbeddedDocumentDefinition
    SD.LLBLGen.Pro.ApplicationCore.DerivedModelRootDocumentDefinition

Namespace: SD.LLBLGen.Pro.ApplicationCore.DerivedModel
Assembly: SD.LLBLGen.Pro.ApplicationCore (in SD.LLBLGen.Pro.ApplicationCore.dll) Version: 5.4.0.0 (5.4.0)

Syntax

Copy

[FilterPropertiesAttribute]
public class DocumentDefinitionBase : ISerializableToXml, 
	INotifyPropertyChanged, INotifyAsChanged, INotifyAsRemoved, IDataErrorInfo, IOutputSettingValuesTarget

<FilterPropertiesAttribute>
Public Class DocumentDefinitionBase
	Implements ISerializableToXml, INotifyPropertyChanged, INotifyAsChanged, INotifyAsRemoved, 
	IDataErrorInfo, IOutputSettingValuesTarget

The DocumentDefinitionBase type exposes the following members.

Constructors

	Name	Description
	DocumentDefinitionBase(FrameworkSettingTargetElementType)	For deserialization purposes only.
	DocumentDefinitionBase(String, ReferencedElement, FrameworkSettingTargetElementType)	Initializes a new instance of the DocumentDefinitionBase class.

Top

Properties

	Name	Description
	Cardinality	Gets the cardinality of this document, whether it represents one or more elements. Used when this instance is an embedded document.
	ContainerName	Returns the name of the containing element this object is contained in.
	Deserializing	Gets a value indicating whether this DocumentDefinitionBase is deserializing.
	Fields	Gets the fields of this document definition
	FullName	Gets the full name of this document, which is containingelementname.documentname
	Name	Gets / sets the name of this document definition
	OutputSettingValues	Gets the output setting values of this target.
	ReferencedElementName
	RootElement	Gets the root entity of this document.
	RootEntityGroupName
	RootEntityName
	RootValueTypeGroupName
	RootValueTypeName
	TargetElementType	Gets the target element type of this target.

Top

Methods

	Name	Description
	AddField	Adds the field specified as a new field to this document.
	AppendAdditionalDocElementsToStringBuilder
	AppendToStringBuilder	Appends descriptions of its contents to the string builder specified. For ToString()
	BindAdditionalEvents	Binds the additional event handlers of contained elements.
	BindEvents	Binds the event handlers of contained elements.
	ClearErrors	Clears the errors set in this object.
	ContainsSameField	Determines whether
	CreateValidators	Creates the validators for the elements contained in this class.
	DeserializeAdditionalAttributes	Deserializes the additional attributes from the xml pointed at by the passed in xml reader
	DeserializeAdditionalData	Deserializes the additional data from the xml pointed at by the passed in reader.
	DetermineFullPathToRootDocument	Determines the full path to the root document.
	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.
	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.
	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.
	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)
	GetFieldDerivedFromEntityField	Gets the field derived from the entity field specified, which is a field in the root entity of this document.
	GetFieldsOfCompleteTree	Enumerates over the fields in this document and the fields of embedded documents, using depth-first search traversal.
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetNameValidator	Gets the validator for the name property.
	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.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	HandleFieldRemoved	Performs the work necessary after a field has been removed.
	HandleFieldsListChanged
	HandleRootElementValueTypeFieldsChanged	Called when the fields collection in the valuetype in the root element changed.
	MarkDocumentAsChanged	Marks the document definition as changed.
	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.
	PerformPostDeserializationWork	Performs the post deserialization work necessary.
	RaiseHasBeenRemoved
	RemoveField	Removes the field specified from this document
	SerializeAdditionalAttributes	Serializes the additional attributes of this class to the xml.
	SerializeAdditionalElements	Serializes the additional elements of this object to the xml
	SerializeToWriter	Serializes the data in this class to the serializer passed in
	ToString	Returns a string that represents the current object. (Overrides ObjectToString.)
	UnbindAdditionalEvents	Unbinds the additional event handlers of contained elements.
	UnbindEvents	Unbinds the event handlers of contained elements
	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.
	UpdateOutputSettingValuesContainerOfNestedElementsWithDefaults	Updates the option values containers with defaults in nested elements, like fields. The base implementation traverses the fields.
	Validate	Validates this instance.

Top

Events

	Name	Description
	DocumentDefinitionChanged	Event which is raised when the definition of this DocumentDefinition has been changed. What has changed is enclosed inside the event args.
	HasBeenChanged	Raised when the implementing element has been changed
	HasBeenRemoved	Raised when the implementing element has been removed from its container
	PropertyChanged	Occurs when a property value changes. (INotifyPropertyChanged)

Top

Explicit Interface Implementations

	Name	Description
	IDataErrorInfoError	Gets an error message indicating what is wrong with this object.
	IDataErrorInfoItem	Gets the String with the specified column name.
	IOutputSettingValuesTargetTargetName	Gets the name of the element.

Top

Reference

SD.LLBLGen.Pro.ApplicationCore.DerivedModel Namespace