XmlAttributeOverrides Třída
Definice
Důležité
Některé informace platí pro předběžně vydaný produkt, který se může zásadně změnit, než ho výrobce nebo autor vydá. Microsoft neposkytuje žádné záruky, výslovné ani předpokládané, týkající se zde uváděných informací.
Umožňuje přepsat vlastnosti, pole a atributy třídy, když použijete XmlSerializer k serializaci nebo deserializaci objektu.
public ref class XmlAttributeOverrides
public class XmlAttributeOverrides
type XmlAttributeOverrides = class
Public Class XmlAttributeOverrides
- Dědičnost
-
XmlAttributeOverrides
Příklady
Následující příklad serializuje třídu pojmenovanou Orchestra
, která obsahuje jedno pole s názvem Instruments
, které vrací pole Instrument
objektů. Druhá třída s názvem Brass
dědí z Instrument
třídy. Příklad používá instanci XmlAttributeOverrides třídy k přepsání Instrument
pole, což umožňuje poli přijímat Brass
objekty.
#using <System.Xml.dll>
#using <System.dll>
using namespace System;
using namespace System::IO;
using namespace System::Xml::Serialization;
public ref class Instrument
{
public:
String^ Name;
};
public ref class Brass: public Instrument
{
public:
bool IsValved;
};
public ref class Orchestra
{
public:
array<Instrument^>^Instruments;
};
void SerializeObject( String^ filename )
{
/* Each overridden field, property, or type requires
an XmlAttributes object. */
XmlAttributes^ attrs = gcnew XmlAttributes;
/* Create an XmlElementAttribute to override the
field that returns Instrument objects. The overridden field
returns Brass objects instead. */
XmlElementAttribute^ attr = gcnew XmlElementAttribute;
attr->ElementName = "Brass";
attr->Type = Brass::typeid;
// Add the element to the collection of elements.
attrs->XmlElements->Add( attr );
// Create the XmlAttributeOverrides object.
XmlAttributeOverrides^ attrOverrides = gcnew XmlAttributeOverrides;
/* Add the type of the class that contains the overridden
member and the XmlAttributes to override it with to the
XmlAttributeOverrides object. */
attrOverrides->Add( Orchestra::typeid, "Instruments", attrs );
// Create the XmlSerializer using the XmlAttributeOverrides.
XmlSerializer^ s = gcnew XmlSerializer( Orchestra::typeid,attrOverrides );
// Writing the file requires a TextWriter.
TextWriter^ writer = gcnew StreamWriter( filename );
// Create the object that will be serialized.
Orchestra^ band = gcnew Orchestra;
// Create an object of the derived type.
Brass^ i = gcnew Brass;
i->Name = "Trumpet";
i->IsValved = true;
array<Instrument^>^myInstruments = {i};
band->Instruments = myInstruments;
// Serialize the object.
s->Serialize( writer, band );
writer->Close();
}
void DeserializeObject( String^ filename )
{
XmlAttributeOverrides^ attrOverrides = gcnew XmlAttributeOverrides;
XmlAttributes^ attrs = gcnew XmlAttributes;
// Create an XmlElementAttribute to override the Instrument.
XmlElementAttribute^ attr = gcnew XmlElementAttribute;
attr->ElementName = "Brass";
attr->Type = Brass::typeid;
// Add the XmlElementAttribute to the collection of objects.
attrs->XmlElements->Add( attr );
attrOverrides->Add( Orchestra::typeid, "Instruments", attrs );
// Create the XmlSerializer using the XmlAttributeOverrides.
XmlSerializer^ s = gcnew XmlSerializer( Orchestra::typeid,attrOverrides );
FileStream^ fs = gcnew FileStream( filename,FileMode::Open );
Orchestra^ band = dynamic_cast<Orchestra^>(s->Deserialize( fs ));
Console::WriteLine( "Brass:" );
/* The difference between deserializing the overridden
XML document and serializing it is this: To read the derived
object values, you must declare an object of the derived type
(Brass), and cast the Instrument instance to it. */
Brass^ b;
System::Collections::IEnumerator^ myEnum = band->Instruments->GetEnumerator();
while ( myEnum->MoveNext() )
{
Instrument^ i = safe_cast<Instrument^>(myEnum->Current);
b = dynamic_cast<Brass^>(i);
Console::WriteLine( "{0}\n{1}", b->Name, b->IsValved );
}
}
int main()
{
SerializeObject( "Override.xml" );
DeserializeObject( "Override.xml" );
}
using System;
using System.IO;
using System.Xml.Serialization;
public class Orchestra
{
public Instrument[] Instruments;
}
public class Instrument
{
public string Name;
}
public class Brass:Instrument
{
public bool IsValved;
}
public class Run
{
public static void Main()
{
Run test = new Run();
test.SerializeObject("Override.xml");
test.DeserializeObject("Override.xml");
}
public void SerializeObject(string filename)
{
/* Each overridden field, property, or type requires
an XmlAttributes object. */
XmlAttributes attrs = new XmlAttributes();
/* Create an XmlElementAttribute to override the
field that returns Instrument objects. The overridden field
returns Brass objects instead. */
XmlElementAttribute attr = new XmlElementAttribute();
attr.ElementName = "Brass";
attr.Type = typeof(Brass);
// Add the element to the collection of elements.
attrs.XmlElements.Add(attr);
// Create the XmlAttributeOverrides object.
XmlAttributeOverrides attrOverrides = new XmlAttributeOverrides();
/* Add the type of the class that contains the overridden
member and the XmlAttributes to override it with to the
XmlAttributeOverrides object. */
attrOverrides.Add(typeof(Orchestra), "Instruments", attrs);
// Create the XmlSerializer using the XmlAttributeOverrides.
XmlSerializer s =
new XmlSerializer(typeof(Orchestra), attrOverrides);
// Writing the file requires a TextWriter.
TextWriter writer = new StreamWriter(filename);
// Create the object that will be serialized.
Orchestra band = new Orchestra();
// Create an object of the derived type.
Brass i = new Brass();
i.Name = "Trumpet";
i.IsValved = true;
Instrument[] myInstruments = {i};
band.Instruments = myInstruments;
// Serialize the object.
s.Serialize(writer,band);
writer.Close();
}
public void DeserializeObject(string filename)
{
XmlAttributeOverrides attrOverrides =
new XmlAttributeOverrides();
XmlAttributes attrs = new XmlAttributes();
// Create an XmlElementAttribute to override the Instrument.
XmlElementAttribute attr = new XmlElementAttribute();
attr.ElementName = "Brass";
attr.Type = typeof(Brass);
// Add the XmlElementAttribute to the collection of objects.
attrs.XmlElements.Add(attr);
attrOverrides.Add(typeof(Orchestra), "Instruments", attrs);
// Create the XmlSerializer using the XmlAttributeOverrides.
XmlSerializer s =
new XmlSerializer(typeof(Orchestra), attrOverrides);
FileStream fs = new FileStream(filename, FileMode.Open);
Orchestra band = (Orchestra) s.Deserialize(fs);
Console.WriteLine("Brass:");
/* The difference between deserializing the overridden
XML document and serializing it is this: To read the derived
object values, you must declare an object of the derived type
(Brass), and cast the Instrument instance to it. */
Brass b;
foreach(Instrument i in band.Instruments)
{
b = (Brass)i;
Console.WriteLine(
b.Name + "\n" +
b.IsValved);
}
}
}
Option Explicit
Option Strict
Imports System.IO
Imports System.Xml.Serialization
Public Class Orchestra
Public Instruments() As Instrument
End Class
Public Class Instrument
Public Name As String
End Class
Public Class Brass
Inherits Instrument
Public IsValved As Boolean
End Class
Public Class Run
Public Shared Sub Main()
Dim test As New Run()
test.SerializeObject("Override.xml")
test.DeserializeObject("Override.xml")
End Sub
Public Sub SerializeObject(ByVal filename As String)
' Each overridden field, property, or type requires
' an XmlAttributes object.
Dim attrs As New XmlAttributes()
' Create an XmlElementAttribute to override the
' field that returns Instrument objects. The overridden field
' returns Brass objects instead.
Dim attr As New XmlElementAttribute()
attr.ElementName = "Brass"
attr.Type = GetType(Brass)
' Add the element to the collection of elements.
attrs.XmlElements.Add(attr)
' Create the XmlAttributeOverrides object.
Dim attrOverrides As New XmlAttributeOverrides()
' Add the type of the class that contains the overridden
' member and the XmlAttributes to override it with to the
' XmlAttributeOverrides object.
attrOverrides.Add(GetType(Orchestra), "Instruments", attrs)
' Create the XmlSerializer using the XmlAttributeOverrides.
Dim s As New XmlSerializer(GetType(Orchestra), attrOverrides)
' Writing the file requires a TextWriter.
Dim writer As New StreamWriter(filename)
' Create the object that will be serialized.
Dim band As New Orchestra()
' Create an object of the derived type.
Dim i As New Brass()
i.Name = "Trumpet"
i.IsValved = True
Dim myInstruments() As Instrument = {i}
band.Instruments = myInstruments
' Serialize the object.
s.Serialize(writer, band)
writer.Close()
End Sub
Public Sub DeserializeObject(filename As String)
Dim attrOverrides As New XmlAttributeOverrides()
Dim attrs As New XmlAttributes()
' Create an XmlElementAttribute to override the Instrument.
Dim attr As New XmlElementAttribute()
attr.ElementName = "Brass"
attr.Type = GetType(Brass)
' Add the XmlElementAttribute to the collection of objects.
attrs.XmlElements.Add(attr)
attrOverrides.Add(GetType(Orchestra), "Instruments", attrs)
' Create the XmlSerializer using the XmlAttributeOverrides.
Dim s As New XmlSerializer(GetType(Orchestra), attrOverrides)
Dim fs As New FileStream(filename, FileMode.Open)
Dim band As Orchestra = CType(s.Deserialize(fs), Orchestra)
Console.WriteLine("Brass:")
' The difference between deserializing the overridden
' XML document and serializing it is this: To read the derived
' object values, you must declare an object of the derived type
' (Brass), and cast the Instrument instance to it.
Dim b As Brass
Dim i As Instrument
For Each i In band.Instruments
b = CType(i, Brass)
Console.WriteLine(b.Name & ControlChars.Cr & b.IsValved)
Next i
End Sub
End Class
Poznámky
Umožňuje XmlAttributeOverrides XmlSerializer přepsat výchozí způsob serializace sady objektů. Přepsání serializace tímto způsobem má dvě použití: nejprve můžete řídit a rozšířit serializaci objektů nalezených v knihovně DLL – i když nemáte přístup ke zdroji; zadruhé můžete vytvořit jednu sadu serializovatelných tříd, ale serializovat objekty několika způsoby. Například místo serializace členů instance třídy jako elementů XML je můžete serializovat jako atributy XML, což vede k efektivnějšímu dokumentu pro přenos.
Po vytvoření objektu XmlAttributeOverrides ho předáte konstruktoru XmlSerializer jako argument. Výsledek XmlSerializer používá data obsažená v XmlAttributeOverrides atributech k přepsání atributů, které řídí, jak jsou objekty serializovány. K tomuto účelu XmlAttributeOverrides obsahuje kolekci typů objektů, které jsou přepsány, a také XmlAttributes objekt přidružený k jednotlivým přepsaným typům objektu. Samotný XmlAttributes objekt obsahuje příslušnou sadu objektů atributů, které řídí způsob serializace každého pole, vlastnosti nebo třídy.
Proces vytváření a používání objektu XmlAttributeOverrides je následující:
XmlAttributes Vytvořte objekt.
Vytvořte objekt atributu, který je vhodný pro přepsání objektu. Chcete-li například přepsat pole nebo vlastnost, vytvořte XmlElementAttributepomocí nového odvozeného typu . Volitelně můžete přiřadit nový ElementNamenebo Namespace přepsání názvu atributu nebo oboru názvů základní třídy.
Přidejte objekt atributu do příslušné XmlAttributes vlastnosti nebo kolekce. Například přidáte XmlElementAttribute do XmlElements kolekce objektu XmlAttributes název člena, který se přepíše.
XmlAttributeOverrides Vytvořte objekt.
Add Pomocí metody přidejte XmlAttributes objekt do objektuXmlAttributeOverrides. Pokud je objekt přepsán nebo XmlRootAttribute XmlTypeAttribute, musíte zadat pouze typ přepsáného objektu. Pokud ale přepisujete pole nebo vlastnost, musíte také zadat název přepsaného člena.
Při vytváření konstruktoru XmlSerializerpředejte XmlAttributeOverrides konstruktoru XmlSerializer .
Výsledek XmlSerializer použijte k serializaci nebo deserializaci odvozených objektů třídy.
Konstruktory
XmlAttributeOverrides() |
Inicializuje novou instanci XmlAttributeOverrides třídy. |
Vlastnosti
Item[Type, String] |
Získá objekt asociovaný se zadaným typem (base-class). Parametr člena určuje člen základní třídy, který je přepsán. |
Item[Type] |
Získá objekt asociovaný se zadaným typem base-class. |
Metody
Add(Type, String, XmlAttributes) |
XmlAttributes Přidá objekt do kolekce XmlAttributes objektů. Parametr |
Add(Type, XmlAttributes) |
XmlAttributes Přidá objekt do kolekce XmlAttributes objektů. Parametr |
Equals(Object) |
Určí, zda se zadaný objekt rovná aktuálnímu objektu. (Zděděno od Object) |
GetHashCode() |
Slouží jako výchozí funkce hash. (Zděděno od Object) |
GetType() |
Type Získá aktuální instanci. (Zděděno od Object) |
MemberwiseClone() |
Vytvoří použádnou kopii aktuálního souboru Object. (Zděděno od Object) |
ToString() |
Vrátí řetězec, který představuje aktuální objekt. (Zděděno od Object) |