DomainClassXmlSerializer Classe

Definição

Essa é a classe base para todos os serializadores de domínio gerados.This is the base class for all generated domain serializers.

public ref class DomainClassXmlSerializer
public class DomainClassXmlSerializer
type DomainClassXmlSerializer = class
Public Class DomainClassXmlSerializer
Herança
DomainClassXmlSerializer
Derivado

Construtores

DomainClassXmlSerializer()

ConstrutorConstructor

Propriedades

MonikerAttributeName

Retorna o nome do atributo XML que contém a cadeia de caracteres do moniker.Returns the XML attribute name that contains the moniker string. Por exemplo, um DomainClass foo pode ter MonikerTagName "FooMoniker" e MonikerAttributeName "ref", então um moniker serializado de Foo será semelhante a < FooMoniker ref = "foo1" > .For example, a DomainClass Foo may have MonikerTagName "FooMoniker", and MonikerAttributeName "ref", then a serialized moniker of Foo will look like <FooMoniker ref="foo1" >. Uma implementação de serializador que substitui MonikerTagName também deve substituir MonikerAttributeName.An serializer implementation that overrides MonikerTagName should also override MonikerAttributeName. A implementação base retorna uma cadeia de caracteres vazia, o que significa que o DomainClass não pode ser modelado.The base implementation returns empty string, meaning that the DomainClass cannot be monikerized.

MonikerTagName

Retorna o nome da marca XML ao serializar o ModelElement manipulado como um moniker.Returns the XML tag name when serializing the handled ModelElement as a moniker. Observe que esse nome de marca é diferente de xmltagname.Note that this tag name is different from XmlTagName. Este é para escrever um moniker, enquanto xmltagname é para gravar a instância real do ModelElement.This one is for writing a moniker, while XmlTagName is for writing the actual instance of the ModelElement. Eles precisam ser nomes de marca diferentes para que o esquema associado para o XML serializado não seja ambíguo.They need to be different tag names so that the associated schema for the serialized XML is not ambiguous. Uma implementação de serializador que substitui MonikerAttributeName também deve substituir MonikerTagName.An serializer implementation that overrides MonikerAttributeName should also override MonikerTagName. A implementação base retorna uma cadeia de caracteres vazia, o que significa que o DomainClass não pode ser modelado.The base implementation returns empty string, meaning that the DomainClass cannot be monikerized.

XmlTagName

Retorna o nome da marca XML que será usada na serialização.Returns the XML tag name that will be used in serialization. Se um DomainClass não puder ser serializado diretamente (por exemplo, classe abstrata, relação de forma curta, etc.), a cadeia de caracteres vazios será retornada para essa propriedade.If a DomainClass cannot be serialized directly (e.g. abstract class, short-form relationship, etc.), emptry string is returned for this property.

Métodos

CalculateQualifiedName(DomainXmlSerializerDirectory, ModelElement)

Esse método calcula uma referência a uma instância ModelElement manipulada.This method calculates a reference to a handled ModelElement instance.

CreateInstance(SerializationContext, XmlReader, Partition)

Com o XmlReader fornecido, crie uma instância do ModelElement na partição especificada.With the given XmlReader, create an instance of the ModelElement in the given Partition. Observação: esse método só é chamado pelo método TryCreateInstance () depois que ele determina a instância de ModelElement correta a ser criada.Note: This method is only called by TryCreateInstance() method once it determines the correct ModelElement instance to create.

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

Com o XmlReader fornecido, crie uma instância de moniker no repositório especificado.With the given XmlReader, create an Moniker instance in the given Store. Observação: esse método só é chamado pelo método TryCreateMonikerInstance () depois que ele determina o moniker de ModelElement correto a ser criado.Note: This method is only called by TryCreateMonikerInstance() method once it determines the correct ModelElement moniker to create.

GetMonikerQualifier(DomainXmlSerializerDirectory, ModelElement)

GetMonikerQualifier retorna a referência de formulário longo a um elemento de modelo.GetMonikerQualifier returns the long form reference to a model element. A referência de formulário longo consiste em referência de formulário/Qualifier/short.The long form reference consists of /Qualifier/short form reference. Esse método calcula o qualificador, se ele existir.This method calculates the Qualifier, if it exists.

Read(SerializationContext, ModelElement, XmlReader)

Método de leitura pública () que desserializa a instância de ModelElement determinada do XML.Public Read() method that deserializes the given ModelElement instance from XML.

ReadAdditionalElementData(SerializationContext, ModelElement, XmlReader)

Ler quaisquer dados de elemento adicionais associados ao elementoRead any additional element data associated with the element

ReadElements(SerializationContext, ModelElement, XmlReader)

Esses métodos desserializam elementos XML aninhados dentro do elemento passado.This methods deserializes nested XML elements inside the passed-in element.

ReadPropertiesFromAttributes(SerializationContext, ModelElement, XmlReader)

Esse método desserializa todas as propriedades serializadas como atributos XML.This method deserializes all properties that are serialized as XML attributes.

ReadRootElement(SerializationContext, ModelElement, XmlReader, ISchemaResolver)

Método público ReadRootElement () que desserializa um elemento de nível raiz de XML.Public ReadRootElement() method that deserializes a root-level element from XML. A diferença entre o elemento de nível raiz e os elementos REST no XML é que a raiz pode conter informações adicionais, como o esquema, a versão, etc. A implementação padrão simplesmente chama o método Read (), cabe às implementações derivadas fazer verificações adicionais.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.

Reset()

Retorna o serializador para seu estado inicialReturns the serializer to its initial state

TryCreateInstance(SerializationContext, XmlReader, Partition)

Com o XmlReader fornecido, verifique se ele está apontando para uma instância ModelElement serializada que este serializador pode manipular.With the given XmlReader, check if it is currently pointing to a serialized ModelElement instance that this serializer can handle. Nesse caso, crie uma instância do ModelElement na partição especificada; caso contrário, retorna NULL.If so, create an instance of the ModelElement in the given Partition; otherwise return NULL. Observação: o chamador garantirá que o leitor seja posicionado na marca XML aberta do elemento que está sendo lido.Note: The caller will guarantee that the reader is positioned at open XML tag of the element being read. Este método não deve mover o leitor; o leitor deve permanecer na mesma posição quando esse método retornar.This method should not move the reader; the reader should remain at the same position when this method returns.

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

Com o XmlReader fornecido, verifique se ele está atualmente apontando para uma instância de um modelador de um ModelElement que este serializador pode manipular.With the given XmlReader, check if it is currently pointing to a monikerized instance of a ModelElement that this serializer can handle. Nesse caso, crie uma instância de moniker na loja determinada; caso contrário, retorna NULL.If so, create an Moniker instance in the given Store; otherwise return NULL. Observação: o chamador garantirá que o leitor seja posicionado na marca XML aberta do moniker do elemento que está sendo lido.Note: The caller will guarantee that the reader is positioned at open XML tag of the element moniker being read. Esse método moverá o leitor (ao contrário do método TryCreateInstance ()), pois ele pode precisar ler a cadeia de caracteres do moniker serializado.This method will move the reader (unlike TryCreateInstance() method) because it may needs to read the serialized moniker string. Se o leitor for movido, ele deverá ser posicionado na marca de fechamento do elemento (para que o chamador possa chamar SerializationUtilities. SkipToNextElement () para mover para o próximo elemento).If the reader is moved, it should be positioned at the closing tag of the element (so that the caller can call SerializationUtilities.SkipToNextElement() to move to the next element).

Write(SerializationContext, ModelElement, XmlWriter)

Método de gravação pública () que serializa a instância ModelElement associada a essa instância de serializador em XML.Public Write() method that serializes the ModelElement instance associated with this serializer instance into XML. Esse método apenas chama Write () sem RootElementSettings.This method just calls Write() with no RootElementSettings.

Write(SerializationContext, ModelElement, XmlWriter, RootElementSettings)

Método de gravação pública () que serializa a instância ModelElement associada a essa instância de serializador em XML.Public Write() method that serializes the ModelElement instance associated with this serializer instance into XML.

WriteAdditionalElementData(SerializationContext, ModelElement, XmlWriter)

Gravar quaisquer dados de elemento adicionais associados ao elementoWrite any additional element data associated with the element

WriteElements(SerializationContext, ModelElement, XmlWriter)

Esse método serializa 1) Propriedades serializadas como elementos XML aninhados e 2) elementos de modelo filho em XML.This methods serializes 1) properties serialized as nested XML elements and 2) child model elements into XML.

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

Método público WriteMoniker () que grava uma instância de ModelElement de moniker em XML.Public WriteMoniker() method that writes a monikerized ModelElement instance into XML.

WritePropertiesAsAttributes(SerializationContext, ModelElement, XmlWriter)

Grave todas as propriedades que precisam ser serializadas como atributos XML.Write all properties that need to be serialized as XML attributes.

WriteRootElement(SerializationContext, ModelElement, XmlWriter)

O método público WriteRootElement () que serializa um elemento de nível raiz em XML.Public WriteRootElement() method that serializes a root-level element to XML. A diferença entre o elemento de nível raiz e os elementos REST no XML é que a raiz pode conter informações adicionais, como o esquema, a versão, etc. A implementação padrão simplesmente chama o método Write () sem RootElementSettings, cabe às implementações derivadas fazer verificações adicionais.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.

Aplica-se a