DslSerializer Class

Definition

Serializer DslSerializer for DomainClass Dsl.

public ref class DslSerializer sealed : Microsoft::VisualStudio::Modeling::DslDefinition::DslLibrarySerializer
public sealed class DslSerializer : Microsoft.VisualStudio.Modeling.DslDefinition.DslLibrarySerializer
type DslSerializer = class
    inherit DslLibrarySerializer
Public NotInheritable Class DslSerializer
Inherits DslLibrarySerializer
Inheritance

Constructors

DslSerializer()

DslSerializer Constructor

Properties

MonikerAttributeName

This is the name of the XML attribute that stores the moniker of Dsl in a serialized monikerized instance.

MonikerTagName

This is the XML tag name used to serialize a monikerized instance of Dsl.

XmlTagName

This is the XML tag name used to serialize an instance of Dsl.

Methods

CalculateQualifiedName(DomainXmlSerializerDirectory, ModelElement)

This method calculates a moniker to a given Dsl instance.

CreateInstance(SerializationContext, XmlReader, Partition)

This method creates an instance of DslLibrary based on the tag currently pointed by the reader. The reader is guaranteed (by the caller) to be pointed at a serialized instance of DslLibrary.

(Inherited from DslLibrarySerializerBase)
CreateMonikerInstance(SerializationContext, XmlReader, ModelElement, Guid, Partition)

This method creates a Moniker of DslLibrary based on the tag currently pointed by the reader.

(Inherited from DslLibrarySerializerBase)
GetMonikerQualifier(DomainXmlSerializerDirectory, ModelElement)

A domain class can be monikerized in different ways: standard /qualifier/key mechanism, custom moniker, or element ID. If the domain class is serialized using standard /qualifier/key mechanism, this method returns the qualifier of the moniker; if the domain class uses other ways for monikerization, this method returns empty string.

Read(SerializationContext, ModelElement, XmlReader)

Public Read() method that deserializes one Dsl instance from XML.

ReadAdditionalElementData(SerializationContext, ModelElement, XmlReader)

Read any additional element data associated with the element

(Inherited from DomainClassXmlSerializer)
ReadElements(SerializationContext, ModelElement, XmlReader)

Load imported DslLibraries after reading the current DslLibrary. Since all cross-model references are monikers, which are resolved during transaction commit, it doesn't matter whether we load current model first, or imported model first.

(Inherited from DslLibrarySerializer)
ReadPropertiesFromAttributes(SerializationContext, ModelElement, XmlReader)

This method deserializes all properties that are serialized as XML attributes.

(Inherited from DslLibrarySerializerBase)
ReadRootElement(SerializationContext, ModelElement, XmlReader, ISchemaResolver)

Public ReadRootElement() method that deserializes a root-level element from XML. The difference between root-level element and the rest elements in the XML is that the root may carry additional information like schema, version, etc. The default implementation just calls Read() method, it's up to the derived implementations to do any additional checks.

(Inherited from DomainClassXmlSerializer)
Reset()

Reset the serializer

(Inherited from DslLibrarySerializerBase)
TryCreateInstance(SerializationContext, XmlReader, Partition)

This method creates a correct instance of Dsl based on the tag currently pointed by the reader. If the reader is positioned at a serialized Dsl, a new Dsl instance will be created in the given partition, otherwise null is returned.

TryCreateMonikerInstance(SerializationContext, XmlReader, ModelElement, Guid, Partition)

This method creates a Moniker of the correct derived (including Dsl itself) instance of Dsl based on the tag currently pointed by the reader.

Write(SerializationContext, ModelElement, XmlWriter)

Public Write() method that serializes the ModelElement instance associated with this serializer instance into XML. This method just calls Write() with no RootElementSettings.

(Inherited from DomainClassXmlSerializer)
Write(SerializationContext, ModelElement, XmlWriter, RootElementSettings)

Public Write() method that serializes one Dsl instance into XML.

WriteAdditionalElementData(SerializationContext, ModelElement, XmlWriter)

Write any additional element data associated with the element

(Inherited from DomainClassXmlSerializer)
WriteElements(SerializationContext, ModelElement, XmlWriter)

This methods serializes 1) properties serialized as nested XML elements and 2) child model elements into XML.

(Inherited from DslLibrarySerializerBase)
WriteMoniker(SerializationContext, ModelElement, XmlWriter, ModelElement, DomainRelationshipXmlSerializer)

Public WriteMoniker() method that writes a monikerized Dsl instance into XML.

WritePropertiesAsAttributes(SerializationContext, ModelElement, XmlWriter)

Write all properties that need to be serialized as XML attributes.

(Inherited from DslLibrarySerializerBase)
WriteRootElement(SerializationContext, ModelElement, XmlWriter)

Public WriteRootElement() method that serializes a root-level element to XML. The difference between root-level element and the rest elements in the XML is that the root may carry additional information like schema, version, etc. The default implementation just calls Write() method with no RootElementSettings, it's up to the derived implementations to do any additional checks.

(Inherited from DomainClassXmlSerializer)

Applies to