ExtensionElementSerializer Class

Definition

Serializer ExtensionElementSerializer for DomainClass ExtensionElement.

public ref class ExtensionElementSerializer : Microsoft::VisualStudio::Modeling::DomainClassXmlSerializer
public class ExtensionElementSerializer : Microsoft.VisualStudio.Modeling.DomainClassXmlSerializer
type ExtensionElementSerializer = class
    inherit DomainClassXmlSerializer
Public Class ExtensionElementSerializer
Inherits DomainClassXmlSerializer
Inheritance
ExtensionElementSerializer

Constructors

ExtensionElementSerializer()

ExtensionElementSerializer Constructor

Properties

MonikerAttributeName

Returns the XML attribute name that contains the moniker string. For example, a DomainClass Foo may have MonikerTagName "FooMoniker", and MonikerAttributeName "ref", then a serialized moniker of Foo will look like <FooMoniker ref="foo1" >. An serializer implementation that overrides MonikerTagName should also override MonikerAttributeName. The base implementation returns empty string, meaning that the DomainClass cannot be monikerized.

(Inherited from DomainClassXmlSerializer)
MonikerTagName

Returns the XML tag name when serializing the handled ModelElement as a moniker. Note that this tag name is different from XmlTagName. This one is for writing a moniker, while XmlTagName is for writing the actual instance of the ModelElement. They need to be different tag names so that the associated schema for the serialized XML is not ambiguous. An serializer implementation that overrides MonikerAttributeName should also override MonikerTagName. The base implementation returns empty string, meaning that the DomainClass cannot be monikerized.

(Inherited from DomainClassXmlSerializer)
XmlTagName

Returns the XML tag name that will be used in serialization. If a DomainClass cannot be serialized directly (e.g. abstract class, short-form relationship, etc.), emptry string is returned for this property.

(Inherited from DomainClassXmlSerializer)

Methods

CalculateQualifiedName(DomainXmlSerializerDirectory, ModelElement)

This method calculates a moniker to a given ExtensionElement instance.

CreateInstance(SerializationContext, XmlReader, Partition)

With the given XmlReader, create an instance of the ModelElement in the given Partition. Note: This method is only called by TryCreateInstance() method once it determines the correct ModelElement instance to create.

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

With the given XmlReader, create an Moniker instance in the given Store. Note: This method is only called by TryCreateMonikerInstance() method once it determines the correct ModelElement moniker to create.

(Inherited from DomainClassXmlSerializer)
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 the given ModelElement instance from XML.

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

Read any additional element data associated with the element

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

This method deserializes nested XML elements inside the passed-in element.

ReadPropertiesFromAttributes(SerializationContext, ModelElement, XmlReader)

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

(Inherited from DomainClassXmlSerializer)
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

TryCreateInstance(SerializationContext, XmlReader, Partition)

This method creates a correct instance of ExtensionElement based on the tag currently pointed by the reader. If the reader is positioned at a serialized ExtensionElement, a new ExtensionElement 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 ExtensionElement itself) instance of ExtensionElement 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 ExtensionElement 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.

WriteMoniker(SerializationContext, ModelElement, XmlWriter, ModelElement, DomainRelationshipXmlSerializer)

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

WritePropertiesAsAttributes(SerializationContext, ModelElement, XmlWriter)

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

(Inherited from DomainClassXmlSerializer)
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