XmlElementAttribute.IsNullable プロパティ

.NET Framework クラス ライブラリ リファレンス

XmlElementAttribute.IsNullable プロパティ

XmlSerializer が、null 参照 (Visual Basic では Nothing) に設定されているメンバを、xsi:nil 属性が true に設定されている空タグとしてシリアル化する必要があるかどうかを示す値を取得または設定します。

名前空間: System.Xml.Serialization
アセンブリ: System.Xml (system.xml.dll 内)
構文

Visual Basic (宣言)

Public Property IsNullable As
 Boolean

Visual Basic (使用法)

Dim instance As XmlElementAttribute
Dim value As Boolean

value = instance.IsNullable

instance.IsNullable = value

C#

public bool IsNullable { get;
 set; }

C++

public:
property bool IsNullable {
    bool get ();
    void set (bool value);
}

J#

/** @property */
public boolean get_IsNullable ()

/** @property */
public void set_IsNullable (boolean value)

JScript

public function get IsNullable
 () : boolean

public function set IsNullable
 (value : boolean)

プロパティ値
XmlSerializer が xsi:nil 属性を生成する場合は true。それ以外の場合は false。

解説

XML スキーマで構造を指定することにより、XML ドキュメントで、要素の内容が欠落していることを明示的に知らせることができます。このような要素には、true に設定された属性 xsi:nil が含まれます。詳細については、W3C (World Wide Web Consortium) (www.w3.org) の仕様『XML Schema Part 1: Structures』を参照してください。

IsNullable プロパティが true に設定されている場合は、null 参照 (Visual Basic では Nothing) に設定されているクラス メンバに対して xsi:nil 属性が生成されます。たとえば、MyStringArray というフィールドを null 参照 (Visual Basic では Nothing) に設定すると、XmlSerializer は次の XML コードを生成します。

 <MyStringArray xsi:nil = "true" />

IsNullable プロパティが false の場合、null 参照 (Visual Basic では Nothing) に設定されたクラスのメンバについては、XML 要素は生成されません。

メモ
値型には null 参照 (Visual Basic では Nothing) を指定できないため、IsNullable プロパティは、値型として指定されたメンバには適用できません。また、null 許容の値型で、このプロパティを false に設定することはできません。このような型に null 参照 (Visual Basic では Nothing) が格納されていた場合は、xsi:nil を true に設定することによってシリアル化されます。

使用例

XmlElementAttribute が適用され、IsNullable プロパティが false に設定されたフィールドの例を次に示します。

Visual Basic

Public Class MyClass1
    <XmlElement(IsNullable := False)> Public
 Group As String
End Class

C#

public class MyClass
{
   [XmlElement(IsNullable = false)]
   public string Group;
}

C++

public ref class MyClass
{
public:

   [XmlElement(IsNullable=false)]
   String^ Group;
};

J#

public class MyClass
{
    /** @attribute XmlElement(IsNullable = false)
     */
    public String group;
} //MyClass

プラットフォーム

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0、1.1、1.0
.NET Compact Framework
サポート対象 : 2.0、1.0

参照

関連項目
XmlElementAttribute クラス
XmlElementAttribute メンバ
System.Xml.Serialization 名前空間