SoapAttributes.SoapIgnore Właściwość
Definicja
Ważne
Niektóre informacje odnoszą się do produktu w wersji wstępnej, który może zostać znacząco zmodyfikowany przed wydaniem. Firma Microsoft nie udziela żadnych gwarancji, jawnych lub domniemanych, w odniesieniu do informacji podanych w tym miejscu.
Pobiera lub ustawia wartość określającą, czy XmlSerializer serializuje pole publiczne lub właściwość jako zakodowany kodowany kod SOAP XML.
public:
property bool SoapIgnore { bool get(); void set(bool value); };
public bool SoapIgnore { get; set; }
member this.SoapIgnore : bool with get, set
Public Property SoapIgnore As Boolean
Wartość właściwości
true
jeśli element XmlSerializer nie może serializować pola lub właściwości; w przeciwnym razie false
.
Przykłady
Poniższy przykład serializuje klasę o nazwie Group
. Serializacja GroupName
pól i IgnoreThis
i elementów członkowskich GroupType
wyliczenia jest zastępowana. W metodzie CreateOverrideSerializer
SoapAttributeOverrides jest tworzony element , a dla każdego przesłoniętego elementu członkowskiego lub wyliczenia SoapAttributes jest tworzony z odpowiednim zestawem właściwości i dodanym do SoapAttributeOverrideselementu . Obiekt XmlTypeMapping jest tworzony przy użyciu elementu SoapAttributeOverridesi służy XmlTypeMapping do utworzenia XmlSerializer elementu, który zastępuje domyślną serializacji.
#using <System.Xml.dll>
#using <System.dll>
using namespace System;
using namespace System::IO;
using namespace System::Text;
using namespace System::Xml;
using namespace System::Xml::Serialization;
using namespace System::Xml::Schema;
ref class Car;
// SoapInclude allows Vehicle to accept Car type.
[SoapInclude(Car::typeid)]
public ref class Vehicle abstract
{
public:
String^ licenseNumber;
DateTime makeDate;
};
public ref class Car: public Vehicle{};
public enum class GroupType
{
// These enums can be overridden.
[SoapEnum("Small")]
A,
[SoapEnum("Large")]
B
};
public ref class Group
{
public:
[SoapAttributeAttribute(Namespace="http://www.cpandl.com")]
String^ GroupName;
[SoapAttributeAttribute(DataType="base64Binary")]
array<Byte>^GroupNumber;
[SoapAttributeAttribute(DataType="date",AttributeName="CreationDate")]
DateTime Today;
[SoapElement(DataType="nonNegativeInteger",ElementName="PosInt")]
String^ PostitiveInt;
// This is ignored when serialized unless it's overridden.
[SoapIgnore]
bool IgnoreThis;
GroupType Grouptype;
Vehicle^ MyVehicle;
// The SoapInclude allows the method to return a Car.
[SoapInclude(Car::typeid)]
Vehicle^ myCar( String^ licNumber )
{
Vehicle^ v;
if ( licNumber->Equals( "" ) )
{
v = gcnew Car;
v->licenseNumber = "!!!!!!";
}
else
{
v = gcnew Car;
v->licenseNumber = licNumber;
}
return v;
}
};
public ref class Run
{
public:
static void main()
{
Run^ test = gcnew Run;
test->SerializeOriginal( "SoapOriginal.xml" );
test->SerializeOverride( "SoapOverrides.xml" );
test->DeserializeOriginal( "SoapOriginal.xml" );
test->DeserializeOverride( "SoapOverrides.xml" );
}
void SerializeOriginal( String^ filename )
{
// Create an instance of the XmlSerializer class.
XmlTypeMapping^ myMapping = (gcnew SoapReflectionImporter)->ImportTypeMapping( Group::typeid );
XmlSerializer^ mySerializer = gcnew XmlSerializer( myMapping );
Group^ myGroup = MakeGroup();
// Writing the file requires a TextWriter.
XmlTextWriter^ writer = gcnew XmlTextWriter( filename,Encoding::UTF8 );
writer->Formatting = Formatting::Indented;
writer->WriteStartElement( "wrapper" );
// Serialize the class, and close the TextWriter.
mySerializer->Serialize( writer, myGroup );
writer->WriteEndElement();
writer->Close();
}
void SerializeOverride( String^ filename )
{
// Create an instance of the XmlSerializer class
// that overrides the serialization.
XmlSerializer^ overRideSerializer = CreateOverrideSerializer();
Group^ myGroup = MakeGroup();
// Writing the file requires a TextWriter.
XmlTextWriter^ writer = gcnew XmlTextWriter( filename,Encoding::UTF8 );
writer->Formatting = Formatting::Indented;
writer->WriteStartElement( "wrapper" );
// Serialize the class, and close the TextWriter.
overRideSerializer->Serialize( writer, myGroup );
writer->WriteEndElement();
writer->Close();
}
private:
Group^ MakeGroup()
{
// Create an instance of the class that will be serialized.
Group^ myGroup = gcnew Group;
// Set the object properties.
myGroup->GroupName = ".NET";
array<Byte>^hexByte = {Convert::ToByte( 100 ),Convert::ToByte( 50 )};
myGroup->GroupNumber = hexByte;
DateTime myDate = DateTime(2002,5,2);
myGroup->Today = myDate;
myGroup->PostitiveInt = "10000";
myGroup->IgnoreThis = true;
myGroup->Grouptype = GroupType::B;
Car^ thisCar = dynamic_cast<Car^>(myGroup->myCar( "1234566" ));
myGroup->MyVehicle = thisCar;
return myGroup;
}
public:
void DeserializeOriginal( String^ filename )
{
// Create an instance of the XmlSerializer class.
XmlTypeMapping^ myMapping = (gcnew SoapReflectionImporter)->ImportTypeMapping( Group::typeid );
XmlSerializer^ mySerializer = gcnew XmlSerializer( myMapping );
// Reading the file requires an XmlTextReader.
XmlTextReader^ reader = gcnew XmlTextReader( filename );
reader->ReadStartElement( "wrapper" );
// Deserialize and cast the object.
Group^ myGroup;
myGroup = dynamic_cast<Group^>(mySerializer->Deserialize( reader ));
reader->ReadEndElement();
reader->Close();
}
void DeserializeOverride( String^ filename )
{
// Create an instance of the XmlSerializer class.
XmlSerializer^ overRideSerializer = CreateOverrideSerializer();
// Reading the file requires an XmlTextReader.
XmlTextReader^ reader = gcnew XmlTextReader( filename );
reader->ReadStartElement( "wrapper" );
// Deserialize and cast the object.
Group^ myGroup;
myGroup = dynamic_cast<Group^>(overRideSerializer->Deserialize( reader ));
reader->ReadEndElement();
reader->Close();
ReadGroup( myGroup );
}
private:
void ReadGroup( Group^ myGroup )
{
Console::WriteLine( myGroup->GroupName );
Console::WriteLine( myGroup->GroupNumber[ 0 ] );
Console::WriteLine( myGroup->GroupNumber[ 1 ] );
Console::WriteLine( myGroup->Today );
Console::WriteLine( myGroup->PostitiveInt );
Console::WriteLine( myGroup->IgnoreThis );
Console::WriteLine();
}
XmlSerializer^ CreateOverrideSerializer()
{
SoapAttributeOverrides^ mySoapAttributeOverrides = gcnew SoapAttributeOverrides;
SoapAttributes^ soapAtts = gcnew SoapAttributes;
SoapElementAttribute^ mySoapElement = gcnew SoapElementAttribute;
mySoapElement->ElementName = "xxxx";
soapAtts->SoapElement = mySoapElement;
mySoapAttributeOverrides->Add( Group::typeid, "PostitiveInt", soapAtts );
// Override the IgnoreThis property.
SoapIgnoreAttribute^ myIgnore = gcnew SoapIgnoreAttribute;
soapAtts = gcnew SoapAttributes;
soapAtts->SoapIgnore = false;
mySoapAttributeOverrides->Add( Group::typeid, "IgnoreThis", soapAtts );
// Override the GroupType enumeration.
soapAtts = gcnew SoapAttributes;
SoapEnumAttribute^ xSoapEnum = gcnew SoapEnumAttribute;
xSoapEnum->Name = "Over1000";
soapAtts->GroupType::SoapEnum = xSoapEnum;
// Add the SoapAttributes to the
// mySoapAttributeOverridesrides object.
mySoapAttributeOverrides->Add( GroupType::typeid, "A", soapAtts );
// Create second enumeration and add it.
soapAtts = gcnew SoapAttributes;
xSoapEnum = gcnew SoapEnumAttribute;
xSoapEnum->Name = "ZeroTo1000";
soapAtts->GroupType::SoapEnum = xSoapEnum;
mySoapAttributeOverrides->Add( GroupType::typeid, "B", soapAtts );
// Override the Group type.
soapAtts = gcnew SoapAttributes;
SoapTypeAttribute^ soapType = gcnew SoapTypeAttribute;
soapType->TypeName = "Team";
soapAtts->SoapType = soapType;
mySoapAttributeOverrides->Add( Group::typeid, soapAtts );
// Create an XmlTypeMapping that is used to create an instance
// of the XmlSerializer. Then return the XmlSerializer object.
XmlTypeMapping^ myMapping = (gcnew SoapReflectionImporter( mySoapAttributeOverrides ))->ImportTypeMapping( Group::typeid );
XmlSerializer^ ser = gcnew XmlSerializer( myMapping );
return ser;
}
};
int main()
{
Run::main();
}
using System;
using System.IO;
using System.Text;
using System.Xml;
using System.Xml.Serialization;
using System.Xml.Schema;
public class Group
{
[SoapAttribute (Namespace = "http://www.cpandl.com")]
public string GroupName;
[SoapAttribute(DataType = "base64Binary")]
public Byte [] GroupNumber;
[SoapAttribute(DataType = "date", AttributeName = "CreationDate")]
public DateTime Today;
[SoapElement(DataType = "nonNegativeInteger", ElementName = "PosInt")]
public string PostitiveInt;
// This is ignored when serialized unless it's overridden.
[SoapIgnore]
public bool IgnoreThis;
public GroupType Grouptype;
public Vehicle MyVehicle;
// The SoapInclude allows the method to return a Car.
[SoapInclude(typeof(Car))]
public Vehicle myCar(string licNumber)
{
Vehicle v;
if(licNumber == "")
{
v = new Car();
v.licenseNumber = "!!!!!!";
}
else
{
v = new Car();
v.licenseNumber = licNumber;
}
return v;
}
}
// SoapInclude allows Vehicle to accept Car type.
[SoapInclude(typeof(Car))]
public abstract class Vehicle
{
public string licenseNumber;
public DateTime makeDate;
}
public class Car: Vehicle
{
}
public enum GroupType
{
// These enums can be overridden.
[SoapEnum("Small")]
A,
[SoapEnum("Large")]
B
}
public class Run
{
public static void Main()
{
Run test = new Run();
test.SerializeOriginal("SoapOriginal.xml");
test.SerializeOverride("SoapOverrides.xml");
test.DeserializeOriginal("SoapOriginal.xml");
test.DeserializeOverride("SoapOverrides.xml");
}
public void SerializeOriginal(string filename)
{
// Create an instance of the XmlSerializer class.
XmlTypeMapping myMapping =
(new SoapReflectionImporter().ImportTypeMapping(
typeof(Group)));
XmlSerializer mySerializer =
new XmlSerializer(myMapping);
Group myGroup=MakeGroup();
// Writing the file requires a TextWriter.
XmlTextWriter writer =
new XmlTextWriter(filename, Encoding.UTF8);
writer.Formatting = Formatting.Indented;
writer.WriteStartElement("wrapper");
// Serialize the class, and close the TextWriter.
mySerializer.Serialize(writer, myGroup);
writer.WriteEndElement();
writer.Close();
}
public void SerializeOverride(string filename)
{
// Create an instance of the XmlSerializer class
// that overrides the serialization.
XmlSerializer overRideSerializer = CreateOverrideSerializer();
Group myGroup=MakeGroup();
// Writing the file requires a TextWriter.
XmlTextWriter writer =
new XmlTextWriter(filename, Encoding.UTF8);
writer.Formatting = Formatting.Indented;
writer.WriteStartElement("wrapper");
// Serialize the class, and close the TextWriter.
overRideSerializer.Serialize(writer, myGroup);
writer.WriteEndElement();
writer.Close();
}
private Group MakeGroup(){
// Create an instance of the class that will be serialized.
Group myGroup = new Group();
// Set the object properties.
myGroup.GroupName = ".NET";
Byte [] hexByte = new Byte[2]{Convert.ToByte(100),
Convert.ToByte(50)};
myGroup.GroupNumber = hexByte;
DateTime myDate = new DateTime(2002,5,2);
myGroup.Today = myDate;
myGroup.PostitiveInt= "10000";
myGroup.IgnoreThis=true;
myGroup.Grouptype= GroupType.B;
Car thisCar =(Car) myGroup.myCar("1234566");
myGroup.MyVehicle=thisCar;
return myGroup;
}
public void DeserializeOriginal(string filename)
{
// Create an instance of the XmlSerializer class.
XmlTypeMapping myMapping =
(new SoapReflectionImporter().ImportTypeMapping(
typeof(Group)));
XmlSerializer mySerializer =
new XmlSerializer(myMapping);
// Reading the file requires an XmlTextReader.
XmlTextReader reader=
new XmlTextReader(filename);
reader.ReadStartElement("wrapper");
// Deserialize and cast the object.
Group myGroup;
myGroup = (Group) mySerializer.Deserialize(reader);
reader.ReadEndElement();
reader.Close();
}
public void DeserializeOverride(string filename)
{
// Create an instance of the XmlSerializer class.
XmlSerializer overRideSerializer = CreateOverrideSerializer();
// Reading the file requires an XmlTextReader.
XmlTextReader reader=
new XmlTextReader(filename);
reader.ReadStartElement("wrapper");
// Deserialize and cast the object.
Group myGroup;
myGroup = (Group) overRideSerializer.Deserialize(reader);
reader.ReadEndElement();
reader.Close();
ReadGroup(myGroup);
}
private void ReadGroup(Group myGroup){
Console.WriteLine(myGroup.GroupName);
Console.WriteLine(myGroup.GroupNumber[0]);
Console.WriteLine(myGroup.GroupNumber[1]);
Console.WriteLine(myGroup.Today);
Console.WriteLine(myGroup.PostitiveInt);
Console.WriteLine(myGroup.IgnoreThis);
Console.WriteLine();
}
private XmlSerializer CreateOverrideSerializer()
{
SoapAttributeOverrides mySoapAttributeOverrides =
new SoapAttributeOverrides();
SoapAttributes soapAtts = new SoapAttributes();
SoapElementAttribute mySoapElement = new SoapElementAttribute();
mySoapElement.ElementName = "xxxx";
soapAtts.SoapElement = mySoapElement;
mySoapAttributeOverrides.Add(typeof(Group), "PostitiveInt",
soapAtts);
// Override the IgnoreThis property.
SoapIgnoreAttribute myIgnore = new SoapIgnoreAttribute();
soapAtts = new SoapAttributes();
soapAtts.SoapIgnore = false;
mySoapAttributeOverrides.Add(typeof(Group), "IgnoreThis",
soapAtts);
// Override the GroupType enumeration.
soapAtts = new SoapAttributes();
SoapEnumAttribute xSoapEnum = new SoapEnumAttribute();
xSoapEnum.Name = "Over1000";
soapAtts.SoapEnum = xSoapEnum;
// Add the SoapAttributes to the
// mySoapAttributeOverridesrides object.
mySoapAttributeOverrides.Add(typeof(GroupType), "A",
soapAtts);
// Create second enumeration and add it.
soapAtts = new SoapAttributes();
xSoapEnum = new SoapEnumAttribute();
xSoapEnum.Name = "ZeroTo1000";
soapAtts.SoapEnum = xSoapEnum;
mySoapAttributeOverrides.Add(typeof(GroupType), "B",
soapAtts);
// Override the Group type.
soapAtts = new SoapAttributes();
SoapTypeAttribute soapType = new SoapTypeAttribute();
soapType.TypeName = "Team";
soapAtts.SoapType = soapType;
mySoapAttributeOverrides.Add(typeof(Group),soapAtts);
// Create an XmlTypeMapping that is used to create an instance
// of the XmlSerializer. Then return the XmlSerializer object.
XmlTypeMapping myMapping = (new SoapReflectionImporter(
mySoapAttributeOverrides)).ImportTypeMapping(typeof(Group));
XmlSerializer ser = new XmlSerializer(myMapping);
return ser;
}
}
Imports System.IO
Imports System.Text
Imports System.Xml
Imports System.Xml.Serialization
Imports System.Xml.Schema
Public Class Group
<SoapAttribute (Namespace:= "http:'www.cpandl.com")> _
Public GroupName As String
<SoapAttribute(DataType:= "base64Binary")> _
Public GroupNumber() As Byte
<SoapAttribute(DataType:= "date", _
AttributeName:= "CreationDate")> _
Public Today As DateTime
<SoapElement(DataType:= "nonNegativeInteger", _
ElementName:= "PosInt")> _
Public PostitiveInt As String
' This is ignored when serialized unless it's overridden.
<SoapIgnore> _
Public IgnoreThis As Boolean
Public Grouptype As GroupType
Public MyVehicle As Vehicle
' The SoapInclude allows the method to return a Car.
<SoapInclude(GetType(Car))> _
Public Function myCar(licNumber As String ) As Vehicle
Dim v As Vehicle
if licNumber = "" Then
v = New Car()
v.licenseNumber = "!!!!!!"
else
v = New Car()
v.licenseNumber = licNumber
End If
return v
End Function
End Class
' SoapInclude allows Vehicle to accept Car type.
<SoapInclude(GetType(Car))> _
Public MustInherit class Vehicle
Public licenseNumber As String
Public makeDate As DateTime
End Class
Public Class Car
Inherits Vehicle
End Class
Public enum GroupType
' These enums can be overridden.
<SoapEnum("Small")> _
A
<SoapEnum("Large")> _
B
End Enum
Public Class Run
Shared Sub Main()
Dim test As Run = New Run()
test.SerializeOriginal("SoapOriginal.xml")
test.SerializeOverride("SoapOverrides.xml")
test.DeserializeOriginal("SoapOriginal.xml")
test.DeserializeOverride("SoapOverrides.xml")
End SUb
Public Sub SerializeOriginal(filename As String)
' Create an instance of the XmlSerializer class.
Dim myMapping As XmlTypeMapping = _
(New SoapReflectionImporter().ImportTypeMapping _
(GetType(Group)))
Dim mySerializer As XmlSerializer = _
New XmlSerializer(myMapping)
Dim myGroup As Group =MakeGroup()
' Writing the file requires a TextWriter.
Dim writer As XmlTextWriter = _
New XmlTextWriter(filename, Encoding.UTF8)
writer.Formatting = Formatting.Indented
writer.WriteStartElement("wrapper")
' Serialize the class, and close the TextWriter.
mySerializer.Serialize(writer, myGroup)
writer.WriteEndElement()
writer.Close()
End Sub
Public Sub SerializeOverride(filename As String)
' Create an instance of the XmlSerializer class
' that overrides the serialization.
Dim overRideSerializer As XmlSerializer = _
CreateOverrideSerializer()
Dim myGroup As Group =MakeGroup()
' Writing the file requires a TextWriter.
Dim writer As XmlTextWriter = _
New XmlTextWriter(filename, Encoding.UTF8)
writer.Formatting = Formatting.Indented
writer.WriteStartElement("wrapper")
' Serialize the class, and close the TextWriter.
overRideSerializer.Serialize(writer, myGroup)
writer.WriteEndElement()
writer.Close()
End Sub
private Function MakeGroup() As Group
' Create an instance of the class that will be serialized.
Dim myGroup As Group = New Group()
' Set the object properties.
myGroup.GroupName = ".NET"
Dim hexByte()As Byte = new Byte(1){Convert.ToByte(100), _
Convert.ToByte(50)}
myGroup.GroupNumber = hexByte
Dim myDate As DateTime = new DateTime(2002,5,2)
myGroup.Today = myDate
myGroup.PostitiveInt = "10000"
myGroup.IgnoreThis = true
myGroup.Grouptype = GroupType.B
Dim thisCar As Car
thisCar =CType(myGroup.myCar("1234566"), Car)
myGroup.myVehicle=thisCar
return myGroup
End Function
Public Sub DeserializeOriginal(filename As String)
' Create an instance of the XmlSerializer class.
Dim myMapping As XmlTypeMapping = _
(New SoapReflectionImporter().ImportTypeMapping _
(GetType(Group)))
Dim mySerializer As XmlSerializer = _
New XmlSerializer(myMapping)
' Reading the file requires an XmlTextReader.
Dim reader As XmlTextReader = _
New XmlTextReader(filename)
reader.ReadStartElement("wrapper")
' Deserialize and cast the object.
Dim myGroup As Group = _
CType(mySerializer.Deserialize(reader), Group)
reader.ReadEndElement()
reader.Close()
End Sub
Public Sub DeserializeOverride(filename As String)
' Create an instance of the XmlSerializer class.
Dim overRideSerializer As XmlSerializer = _
CreateOverrideSerializer()
' Reading the file requires an XmlTextReader.
Dim reader As XmlTextReader = _
New XmlTextReader(filename)
reader.ReadStartElement("wrapper")
' Deserialize and cast the object.
Dim myGroup As Group = _
CType(overRideSerializer.Deserialize(reader), Group)
reader.ReadEndElement()
reader.Close()
ReadGroup(myGroup)
End Sub
private Sub ReadGroup(myGroup As Group)
Console.WriteLine(myGroup.GroupName)
Console.WriteLine(myGroup.GroupNumber(0))
Console.WriteLine(myGroup.GroupNumber(1))
Console.WriteLine(myGroup.Today)
Console.WriteLine(myGroup.PostitiveInt)
Console.WriteLine(myGroup.IgnoreThis)
Console.WriteLine()
End Sub
Private Function CreateOverrideSerializer() As XmlSerializer
Dim soapOver As SoapAttributeOverrides = New SoapAttributeOverrides()
Dim soapAtts As SoapAttributes = New SoapAttributes()
Dim mySoapElement As SoapElementAttribute = New SoapElementAttribute()
mySoapElement.ElementName = "xxxx"
soapAtts.SoapElement = mySoapElement
soapOver.Add(GetType(Group), "PostitiveInt", soapAtts)
' Override the IgnoreThis property.
Dim myIgnore As SoapIgnoreAttribute = new SoapIgnoreAttribute()
soapAtts = New SoapAttributes()
soapAtts.SoapIgnore = false
soapOver.Add(GetType(Group), "IgnoreThis", soapAtts)
' Override the GroupType enumeration.
soapAtts = New SoapAttributes()
Dim xSoapEnum As SoapEnumAttribute = new SoapEnumAttribute()
xSoapEnum.Name = "Over1000"
soapAtts.SoapEnum = xSoapEnum
' Add the SoapAttributes to the SoapOverrides object.
soapOver.Add(GetType(GroupType), "A", soapAtts)
' Create second enumeration and add it.
soapAtts = New SoapAttributes()
xSoapEnum = New SoapEnumAttribute()
xSoapEnum.Name = "ZeroTo1000"
soapAtts.SoapEnum = xSoapEnum
soapOver.Add(GetType(GroupType), "B", soapAtts)
' Override the Group type.
soapAtts = New SoapAttributes()
Dim soapType As SoapTypeAttribute = New SoapTypeAttribute()
soapType.TypeName = "Team"
soapAtts.SoapType = soapType
soapOver.Add(GetType(Group),soapAtts)
Dim myMapping As XmlTypeMapping = (New SoapReflectionImporter( _
soapOver)).ImportTypeMapping(GetType(Group))
Dim ser As XmlSerializer = new XmlSerializer(myMapping)
return ser
End Function
End Class
Uwagi
Domyślnie wszystkie pola publiczne i właściwości odczytu/zapisu są serializowane przez XmlSerializerelement . Oznacza to, że wartość każdego pola publicznego lub właściwości jest utrwalana jako element XML lub atrybut XML w dokumencie XML.
Aby zastąpić domyślną serializacji pola lub właściwości, utwórz SoapAttributeswłaściwość i ustaw jej SoapIgnore właściwość na true
.
Add Użyj metody , aby dodać obiekt do SoapAttributeOverrides obiektu i określić typ obiektu zawierającego pole lub właściwość do zignorowania oraz nazwę pola lub właściwości do zignorowania.
Jeśli obiekt SoapIgnoreAttribute jest stosowany do pola lub właściwości, pole lub właściwość są ignorowane. Można jednak zastąpić to zachowanie, tworząc SoapAttributeswłaściwość , ustawiając jej SoapIgnore właściwość na false
, i dodając ją do SoapAttributeOverrideselementu , określając typ obiektu zawierającego pole lub właściwość oraz nazwę pola lub właściwości.