XmlIgnore Property

XmlAttributes.XmlIgnore Property

[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]

Gets or sets a value that specifies whether the XmlSerializer serializes a public field or public read/write property.

Namespace:  System.Xml.Serialization
Assembly:  System.Xml.Serialization (in System.Xml.Serialization.dll)

'Declaration
Public Property XmlIgnore As Boolean

Property Value

Type: System.Boolean
true if the XmlSerializer must not serialize the field or property; otherwise, false.

By default, all public fields and public read/write properties are serialized by the XmlSerializer. That is, the value of each public field or property is persisted as an XML element or XML attribute in an XML-document instance.

To override the default serialization of a field or property, create an XmlAttributes object and set its XmlIgnore property to true. Add the object to an XmlAttributeOverrides object and specify the type of the object that contains the field or property to ignore and the name of the field or property to ignore.

If an XmlIgnoreAttribute is applied to a field or property, the field or property is ignored. However, you can override that behavior by creating an XmlAttributes object, setting its XmlIgnore property to false, and adding it to an XmlAttributeOverrides object that specifies the type of the object that contains the field or property and the name of the field or property.

Windows Phone OS

Supported in: 8.1, 8.0, 7.1, 7.0

Windows Phone

Show:
© 2017 Microsoft