mscorlib(4.0.0.0) API with additions
System.Xml.Serialization Namespace Reference

Classes

class  CodeExporter
 Represents a class that can generate proxy code from an XML representation of a data structure. More...
 
class  CodeIdentifier
 Provides static methods to convert input text into names for code entities. More...
 
class  CodeIdentifiers
 Maintains a group of names for related code entities or type mappings that are generated by the .NET Framework's XML serialization infrastructure. More...
 
class  ImportContext
 Describes the context in which a set of schema is bound to .NET Framework code entities. More...
 
interface  IXmlSerializable
 Provides custom formatting for XML serialization and deserialization. More...
 
interface  IXmlTextParser
 Establishes a P:System.Xml.Serialization.IXmlTextParser.Normalized property for use by the .NET Framework infrastructure. More...
 
class  SchemaImporter
 Describes a schema importer. More...
 
class  SoapAttributeAttribute
 Specifies that the T:System.Xml.Serialization.XmlSerializer must serialize the class member as an encoded SOAP attribute. More...
 
class  SoapAttributeOverrides
 Allows you to override attributes applied to properties, fields, and classes when you use an T:System.Xml.Serialization.XmlSerializer to serialize or deserialize an object as encoded SOAP. More...
 
class  SoapAttributes
 Represents a collection of attribute objects that control how the T:System.Xml.Serialization.XmlSerializer serializes and deserializes SOAP methods. More...
 
class  SoapCodeExporter
 Generates types and attribute declarations from internal type mapping information for SOAP-encoded message parts defined in a WSDL document. More...
 
class  SoapElementAttribute
 Specifies that the public member value be serialized by the T:System.Xml.Serialization.XmlSerializer as an encoded SOAP XML element. More...
 
class  SoapEnumAttribute
 Controls how the T:System.Xml.Serialization.XmlSerializer serializes an enumeration member. More...
 
class  SoapIgnoreAttribute
 Instructs the T:System.Xml.Serialization.XmlSerializer not to serialize the public field or public read/write property value. More...
 
class  SoapIncludeAttribute
 Allows the T:System.Xml.Serialization.XmlSerializer to recognize a type when it serializes or deserializes an object as encoded SOAP XML. More...
 
class  SoapReflectionImporter
 Generates mappings to SOAP-encoded messages from .NET Framework types or Web service method information. More...
 
class  SoapSchemaExporter
 Populates T:System.Xml.Schema.XmlSchema objects with XML Schema data type definitions for .NET Framework types that are serialized using SOAP encoding. More...
 
class  SoapSchemaImporter
 Used within the .NET Framework to generate internal mappings to .NET Framework types for SOAP-encoded message parts in a WSDL document. More...
 
class  SoapSchemaMember
 Represents certain attributes of a XSD <part> element in a WSDL document for generating classes from the document. More...
 
class  SoapTypeAttribute
 Controls the schema generated by the T:System.Xml.Serialization.XmlSerializer when a class instance is serialized as SOAP encoded XML. More...
 
class  UnreferencedObjectEventArgs
 Provides data for the known, but unreferenced, object found in an encoded SOAP XML stream during deserialization. More...
 
class  XmlAnyAttributeAttribute
 Specifies that the member (a field that returns an array of T:System.Xml.XmlAttribute objects) can contain any XML attributes. More...
 
class  XmlAnyElementAttribute
 Specifies that the member (a field that returns an array of T:System.Xml.XmlElement or T:System.Xml.XmlNode objects) contains objects that represent any XML element that has no corresponding member in the object being serialized or deserialized. More...
 
class  XmlAnyElementAttributes
 Represents a collection of T:System.Xml.Serialization.XmlAnyElementAttribute objects. More...
 
class  XmlArrayAttribute
 Specifies that the T:System.Xml.Serialization.XmlSerializer must serialize a particular class member as an array of XML elements. More...
 
class  XmlArrayItemAttribute
 Represents an attribute that specifies the derived types that the T:System.Xml.Serialization.XmlSerializer can place in a serialized array. More...
 
class  XmlArrayItemAttributes
 Represents a collection of T:System.Xml.Serialization.XmlArrayItemAttribute objects. More...
 
class  XmlAttributeAttribute
 Specifies that the T:System.Xml.Serialization.XmlSerializer must serialize the class member as an XML attribute. More...
 
class  XmlAttributeEventArgs
 Provides data for the E:System.Xml.Serialization.XmlSerializer.UnknownAttribute event. More...
 
class  XmlAttributeOverrides
 Allows you to override property, field, and class attributes when you use the T:System.Xml.Serialization.XmlSerializer to serialize or deserialize an object. More...
 
class  XmlAttributes
 Represents a collection of attribute objects that control how the T:System.Xml.Serialization.XmlSerializer serializes and deserializes an object. More...
 
class  XmlChoiceIdentifierAttribute
 Specifies that the member can be further detected by using an enumeration. More...
 
class  XmlCodeExporter
 Generates types and attribute declarations from internal type mapping information for XML schema element declarations. More...
 
struct  XmlDeserializationEvents
 Contains fields that can be used to pass event delegates to a thread-safe Overload:System.Xml.Serialization.XmlSerializer.Deserialize method of the T:System.Xml.Serialization.XmlSerializer. More...
 
class  XmlElementAttribute
 Indicates that a public field or property represents an XML element when the T:System.Xml.Serialization.XmlSerializer serializes or deserializes the object that contains it. More...
 
class  XmlElementAttributes
 Represents a collection of T:System.Xml.Serialization.XmlElementAttribute objects used by the T:System.Xml.Serialization.XmlSerializer to override the default way it serializes a class. More...
 
class  XmlElementEventArgs
 Provides data for the E:System.Xml.Serialization.XmlSerializer.UnknownElement event. More...
 
class  XmlEnumAttribute
 Controls how the T:System.Xml.Serialization.XmlSerializer serializes an enumeration member. More...
 
class  XmlIgnoreAttribute
 Instructs the M:System.Xml.Serialization.XmlSerializer.Serialize(System.IO.TextWriter,System.Object) method of the T:System.Xml.Serialization.XmlSerializer not to serialize the public field or public read/write property value. More...
 
class  XmlIncludeAttribute
 Allows the T:System.Xml.Serialization.XmlSerializer to recognize a type when it serializes or deserializes an object. More...
 
class  XmlMapping
 Supports mappings between .NET Framework types and XML Schema data types. More...
 
class  XmlMemberMapping
 Maps a code entity in a .NET Framework Web service method to an element in a Web Services Description Language (WSDL) message. More...
 
class  XmlMembersMapping
 Provides mappings between .NET Framework Web service methods and Web Services Description Language (WSDL) messages that are defined for SOAP Web services. More...
 
class  XmlNamespaceDeclarationsAttribute
 Specifies that the target property, parameter, return value, or class member contains prefixes associated with namespaces that are used within an XML document. More...
 
class  XmlNodeEventArgs
 Provides data for the E:System.Xml.Serialization.XmlSerializer.UnknownNode event. More...
 
class  XmlReflectionImporter
 Generates mappings to XML schema element declarations, including literal XML Schema Definition (XSD) message parts in a Web Services Description Language (WSDL) document, for .NET Framework types or Web service method information. More...
 
class  XmlReflectionMember
 Provides mappings between code entities in .NET Framework Web service methods and the content of Web Services Description Language (WSDL) messages that are defined for SOAP Web services. More...
 
class  XmlRootAttribute
 Controls XML serialization of the attribute target as an XML root element. More...
 
class  XmlSchemaEnumerator
 Enables iteration over a collection of T:System.Xml.Schema.XmlSchema objects. More...
 
class  XmlSchemaExporter
 Populates T:System.Xml.Schema.XmlSchema objects with XML schema element declarations that are found in type mapping objects. More...
 
class  XmlSchemaImporter
 Generates internal mappings to .NET Framework types for XML schema element declarations, including literal XSD message parts in a WSDL document. More...
 
class  XmlSchemaProviderAttribute
 When applied to a type, stores the name of a static method of the type that returns an XML schema and a T:System.Xml.XmlQualifiedName (or T:System.Xml.Schema.XmlSchemaType for anonymous types) that controls the serialization of the type. More...
 
class  XmlSchemas
 Represents the collection of XML schemas. More...
 
class  XmlSerializationGeneratedCode
 An abstract class that is the base class for T:System.Xml.Serialization.XmlSerializationReader and T:System.Xml.Serialization.XmlSerializationWriter and that contains methods common to both of these types. More...
 
class  XmlSerializationReader
 Controls deserialization by the T:System.Xml.Serialization.XmlSerializer class. More...
 
class  XmlSerializationWriter
 Represents an abstract class used for controlling serialization by the T:System.Xml.Serialization.XmlSerializer class. More...
 
class  XmlSerializer
 Serializes and deserializes objects into and from XML documents. The T:System.Xml.Serialization.XmlSerializer enables you to control how objects are encoded into XML. More...
 
class  XmlSerializerAssemblyAttribute
 Applied to a Web service client proxy, enables you to specify an assembly that contains custom-made serializers. More...
 
class  XmlSerializerFactory
 Creates typed versions of the T:System.Xml.Serialization.XmlSerializer for more efficient serialization. More...
 
class  XmlSerializerImplementation
 Defines the reader, writer, and methods for pre-generated, typed serializers. More...
 
class  XmlSerializerNamespaces
 Contains the XML namespaces and prefixes that the T:System.Xml.Serialization.XmlSerializer uses to generate qualified names in an XML-document instance. More...
 
class  XmlSerializerVersionAttribute
 Signifies that the code was generated by the serialization infrastructure and can be reused for increased performance, when this attribute is applied to an assembly. More...
 
class  XmlTextAttribute
 Indicates to the T:System.Xml.Serialization.XmlSerializer that the member must be treated as XML text when the class that contains it is serialized or deserialized. More...
 
class  XmlTypeAttribute
 Controls the XML schema that is generated when the attribute target is serialized by the T:System.Xml.Serialization.XmlSerializer. More...
 
class  XmlTypeMapping
 Contains a mapping of one type to another. More...
 

Enumerations

enum  Cmp {
  LessThan, EqualTo, LessThanOrEqualTo, GreaterThan,
  NotEqualTo, GreaterThanOrEqualTo
}
 
enum  CodeGenerationOptions {
  CodeGenerationOptions.None = 0x0, CodeGenerationOptions.GenerateProperties = 0x1, CodeGenerationOptions.GenerateNewAsync = 0x2, CodeGenerationOptions.GenerateOldAsync = 0x4,
  CodeGenerationOptions.GenerateOrder = 0x8, CodeGenerationOptions.EnableDataBinding = 0x10
}
 Specifies various options to use when generating .NET Framework types for use with an XML Web Service. More...
 
enum  SoapAttributeFlags { Enum = 1, Type = 2, Element = 4, Attribute = 8 }
 
enum  SpecifiedAccessor { None, ReadOnly, ReadWrite }
 
enum  TypeFlags {
  None = 0, Abstract = 1, Reference = 2, Special = 4,
  CanBeAttributeValue = 8, CanBeTextValue = 0x10, CanBeElementValue = 0x20, HasCustomFormatter = 0x40,
  AmbiguousDataType = 0x80, IgnoreDefault = 0x200, HasIsEmpty = 0x400, HasDefaultConstructor = 0x800,
  XmlEncodingNotRequired = 0x1000, UseReflection = 0x4000, CollapseWhitespace = 0x8000, OptionalValue = 0x10000,
  CtorInaccessible = 0x20000, UsePrivateImplementation = 0x40000, GenericInterface = 0x80000, Unsupported = 0x100000
}
 
enum  TypeKind {
  Root, Primitive, Enum, Struct,
  Class, Array, Collection, Enumerable,
  Void, Node, Attribute, Serializable
}
 
enum  XmlAttributeFlags {
  Enum = 1, Array = 2, Text = 4, ArrayItems = 8,
  Elements = 0x10, Attribute = 0x20, Root = 0x40, Type = 0x80,
  AnyElements = 0x100, AnyAttribute = 0x200, ChoiceIdentifier = 0x400, XmlnsDeclarations = 0x800
}
 
enum  XmlMappingAccess { XmlMappingAccess.None = 0x0, XmlMappingAccess.Read = 0x1, XmlMappingAccess.Write = 0x2 }
 Specifies whether a mapping is read, write, or both. More...
 

Functions

delegate void UnreferencedObjectEventHandler (object sender, UnreferencedObjectEventArgs e)
 Represents the method that handles the E:System.Xml.Serialization.XmlSerializer.UnreferencedObject event of an T:System.Xml.Serialization.XmlSerializer. More...
 
delegate void XmlAttributeEventHandler (object sender, XmlAttributeEventArgs e)
 Represents the method that handles the E:System.Xml.Serialization.XmlSerializer.UnknownAttribute More...
 
delegate void XmlElementEventHandler (object sender, XmlElementEventArgs e)
 Represents the method that handles the E:System.Xml.Serialization.XmlSerializer.UnknownElement event of an T:System.Xml.Serialization.XmlSerializer. More...
 
delegate void XmlNodeEventHandler (object sender, XmlNodeEventArgs e)
 Represents the method that handles the E:System.Xml.Serialization.XmlSerializer.UnknownNode event of an T:System.Xml.Serialization.XmlSerializer. More...
 
delegate void XmlSerializationCollectionFixupCallback (object collection, object collectionItems)
 Delegate used by the T:System.Xml.Serialization.XmlSerializer class for deserialization of SOAP-encoded XML data types that map to collections or enumerations. More...
 
delegate void XmlSerializationFixupCallback (object fixup)
 Delegate used by the T:System.Xml.Serialization.XmlSerializer class for deserialization of SOAP-encoded XML data. More...
 
delegate object XmlSerializationReadCallback ()
 Delegate used by the T:System.Xml.Serialization.XmlSerializer class for deserialization of types from SOAP-encoded, non-root XML data. More...
 
delegate void XmlSerializationWriteCallback (object o)
 Delegate that is used by the T:System.Xml.Serialization.XmlSerializer class for serialization of types from SOAP-encoded, non-root XML data. More...
 

Enumeration Type Documentation

◆ CodeGenerationOptions

Specifies various options to use when generating .NET Framework types for use with an XML Web Service.

Enumerator
None 

Represents primitive types by fields and primitive types by N:System namespace types.

GenerateProperties 

Represents primitive types by properties.

GenerateNewAsync 

Creates events for the asynchronous invocation of Web methods.

GenerateOldAsync 

Creates Begin and End methods for the asynchronous invocation of Web methods.

GenerateOrder 

Generates explicitly ordered serialization code as specified through the Order property of the T:System.Xml.Serialization.XmlAnyElementAttribute, T:System.Xml.Serialization.XmlArrayAttribute, and T:System.Xml.Serialization.XmlElementAttribute attributes.

EnableDataBinding 

Enables data binding.

Definition at line 5 of file CodeGenerationOptions.cs.

◆ XmlMappingAccess

Specifies whether a mapping is read, write, or both.

Enumerator
None 

Both read and write methods are generated.

Read 

Read methods are generated.

Write 

Write methods are generated.

Definition at line 6 of file XmlMappingAccess.cs.

Function Documentation

◆ UnreferencedObjectEventHandler()

delegate void System.Xml.Serialization.UnreferencedObjectEventHandler ( object  sender,
UnreferencedObjectEventArgs  e 
)

Represents the method that handles the E:System.Xml.Serialization.XmlSerializer.UnreferencedObject event of an T:System.Xml.Serialization.XmlSerializer.

Parameters
senderThe source of the event.
eAn T:System.Xml.Serialization.UnreferencedObjectEventArgs that contains the event data.

◆ XmlAttributeEventHandler()

delegate void System.Xml.Serialization.XmlAttributeEventHandler ( object  sender,
XmlAttributeEventArgs  e 
)

Represents the method that handles the E:System.Xml.Serialization.XmlSerializer.UnknownAttribute

Parameters
senderThe source of the event.
eAn T:System.Xml.Serialization.XmlAttributeEventArgs that contains the event data.

◆ XmlElementEventHandler()

delegate void System.Xml.Serialization.XmlElementEventHandler ( object  sender,
XmlElementEventArgs  e 
)

Represents the method that handles the E:System.Xml.Serialization.XmlSerializer.UnknownElement event of an T:System.Xml.Serialization.XmlSerializer.

Parameters
senderThe source of the event.
eA T:System.Xml.Serialization.XmlElementEventArgs that contains the event data.

◆ XmlNodeEventHandler()

delegate void System.Xml.Serialization.XmlNodeEventHandler ( object  sender,
XmlNodeEventArgs  e 
)

Represents the method that handles the E:System.Xml.Serialization.XmlSerializer.UnknownNode event of an T:System.Xml.Serialization.XmlSerializer.

Parameters
senderThe source of the event.
eAn T:System.Xml.Serialization.XmlNodeEventArgs that contains the event data.

◆ XmlSerializationCollectionFixupCallback()

delegate void System.Xml.Serialization.XmlSerializationCollectionFixupCallback ( object  collection,
object  collectionItems 
)

Delegate used by the T:System.Xml.Serialization.XmlSerializer class for deserialization of SOAP-encoded XML data types that map to collections or enumerations.

Parameters
collectionThe collection into which the collection items array is copied.
collectionItemsAn array of items to be copied into the object collection .

◆ XmlSerializationFixupCallback()

delegate void System.Xml.Serialization.XmlSerializationFixupCallback ( object  fixup)

Delegate used by the T:System.Xml.Serialization.XmlSerializer class for deserialization of SOAP-encoded XML data.

Parameters
fixupAn instance of the T:System.Xml.Serialization.XmlSerializationReader.Fixup class that contains the object to be fixed and the array of string identifiers for the items to fill in.

◆ XmlSerializationReadCallback()

delegate object System.Xml.Serialization.XmlSerializationReadCallback ( )

Delegate used by the T:System.Xml.Serialization.XmlSerializer class for deserialization of types from SOAP-encoded, non-root XML data.

Returns
The object returned by the callback.

◆ XmlSerializationWriteCallback()

delegate void System.Xml.Serialization.XmlSerializationWriteCallback ( object  o)

Delegate that is used by the T:System.Xml.Serialization.XmlSerializer class for serialization of types from SOAP-encoded, non-root XML data.

Parameters
oThe object being serialized.