XmlElementAttribute.IsNullable 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 indicates whether the XmlSerializer must serialize a member that is set to nullNothingnullptra null reference (Nothing in Visual Basic) as an empty tag with the xsi:nil attribute set to true.

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

Syntax

Public Property IsNullable As Boolean
public bool IsNullable { get; set; }

Property Value

Type: System..::.Boolean
true if the XmlSerializer generates the xsi:nil attribute; otherwise, false.

Remarks

The XML schema specification for structures allows an XML document to explicitly signal that an element's content is missing. Such an element contains the attribute xsi:nil set to true. For more information, see the World Wide Web Consortium (www.w3.org) specification, XML Schema Part 1: Structures.

If the IsNullable property is set to true, the xsi:nil attribute is generated for class members that have been set to nullNothingnullptra null reference (Nothing in Visual Basic). For example, if you set a field named MyStringArray to nullNothingnullptra null reference (Nothing in Visual Basic), the XmlSerializer generates the following XML code.

 <MyStringArray xsi:nil = "true" />

If the IsNullable property is false, no XML element is generated for class members that have been set to nullNothingnullptra null reference (Nothing in Visual Basic).

Note

You cannot apply the IsNullable property to a member typed as a value type because a value type cannot contain nullNothingnullptra null reference (Nothing in Visual Basic). Additionally, you cannot set this property to false for value types that can be nullNothingnullptra null reference (Nothing in Visual Basic). When such types are nullNothingnullptra null reference (Nothing in Visual Basic), they are serialized by setting xsi:nil to true.

Version Information

Windows Phone OS

Supported in: 8.1, 8.0, 7.1, 7.0

Platforms

Windows Phone

See Also

Reference

XmlElementAttribute Class

System.Xml.Serialization Namespace