XmlAttributes.XmlIgnore プロパティとは何？わかりやすく解説 Weblio辞書

すべての辞書から再検索する

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

索引トップ用語の索引ランキング

XmlAttributes.XmlIgnore プロパティ

XmlSerializer がパブリックフィールドまたは読み書き可能なパブリックプロパティをシリアル化するかどうかを指定する値を取得または設定します。

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

Visual Basic (宣言)

Public Property XmlIgnore As
 Boolean

Visual Basic (使用法)

Dim instance As XmlAttributes
Dim value As Boolean

value = instance.XmlIgnore

instance.XmlIgnore = value

public bool XmlIgnore { get;
 set; }

C++

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

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

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

JScript

public function get XmlIgnore
 () : boolean

public function set XmlIgnore
 (value : boolean)

プロパティ値
XmlSerializer でそのフィールドまたはプロパティをシリアル化しない場合は true。それ以外の場合は false。

解説

既定では、すべてのパブリックフィールドおよび読み書き可能なパブリックプロパティは XmlSerializer によってシリアル化されます。つまり、各パブリックフィールドまたはプロパティの値は、XML ドキュメントインスタンスの XML 要素または XML 属性として永続化されます。

フィールドまたはプロパティの既定のシリアル化をオーバーライドするには、XmlAttributes オブジェクトを作成し、その XmlIgnore プロパティを true に設定します。Add を使用して、オブジェクトを XmlAttributeOverrides オブジェクトに追加し、無視するフィールドまたはプロパティを含むオブジェクトの型、および無視するフィールドまたはプロパティの名前を指定します。

XmlIgnoreAttribute をフィールドまたはプロパティに適用すると、そのフィールドまたはプロパティは無視されます。ただし、この動作はオーバーライドできます。オーバーライドするには、XmlAttributes オブジェクトを作成し、その XmlIgnore プロパティを false に設定します。さらに、作成したオブジェクトを、フィールドまたはプロパティを含むオブジェクトの型、およびフィールドまたはプロパティの名前を指定して、XmlAttributeOverrides オブジェクトに追加します。

使用例

XmlIgnoreAttribute が適用されている Group という名前のメンバを含む Comment という名前のクラスをシリアル化する例を次に示します。この例では、XmlAttributes オブジェクトを作成し、XmlIgnore プロパティを false に設定して、XmlIgnoreAttribute をオーバーライドします。

Visual Basic

Imports System
Imports System.IO
Imports System.Xml.Serialization


' This is the class that will be serialized. 
Public Class Group
    ' The GroupName value will be serialized--unless it's overridden.
    Public GroupName As String
    
    ' This field will be ignored when serialized--
    '  unless it's overridden.
    <XmlIgnoreAttribute()> Public Comment As
 String
End Class


Public Class Test
    
    Public Shared Sub Main()
        Dim t As New Test()
        t.SerializeObject("IgnoreXml.xml")
    End Sub
    
    
    ' Return an XmlSerializer used for overriding.
    Public Function CreateOverrider() As
 XmlSerializer
        ' Create the XmlAttributeOverrides and XmlAttributes objects.
        Dim xOver As New
 XmlAttributeOverrides()
        Dim attrs As New
 XmlAttributes()
        
        ' Setting XmlIgnore to false overrides the XmlIgnoreAttribute
        ' applied to the Comment field. Thus it will be serialized.
        attrs.XmlIgnore = False
        xOver.Add(GetType(Group), "Comment",
 attrs)
        
        ' Use the XmlIgnore to instruct the XmlSerializer to ignore
        ' the GroupName instead. 
        attrs = New XmlAttributes()
        attrs.XmlIgnore = True
        xOver.Add(GetType(Group), "GroupName",
 attrs)
        
        Dim xSer As New
 XmlSerializer(GetType(Group), xOver)
        Return xSer
    End Function
    
    
    Public Sub SerializeObject(ByVal
 filename As String)
        ' Create an XmlSerializer instance.
        Dim xSer As XmlSerializer = CreateOverrider()
        
        ' Create the object to serialize and set its properties.
        Dim myGroup As New
 Group()
        myGroup.GroupName = ".NET"
        myGroup.Comment = "My Comment..."
        
        ' Writing the file requires a TextWriter.
        Dim writer As New
 StreamWriter(filename)
        
        ' Serialize the object and close the TextWriter.
        xSer.Serialize(writer, myGroup)
        writer.Close()
    End Sub
End Class

using System;
using System.IO;
using System.Xml.Serialization;

// This is the class that will be serialized. 
public class Group
{
   // The GroupName value will be serialized--unless it's overridden.
   public string GroupName;

   /* This field will be ignored when serialized--
      unless it's overridden. */
   [XmlIgnoreAttribute]
   public string Comment;
}

public class Test
{
   public static void Main()
   {
      Test t = new Test();
      t.SerializeObject("IgnoreXml.xml");
   }

   // Return an XmlSerializer used for overriding.
   public XmlSerializer CreateOverrider()
   {
      // Create the XmlAttributeOverrides and XmlAttributes objects.
      XmlAttributeOverrides xOver = new XmlAttributeOverrides();
      XmlAttributes attrs = new XmlAttributes();

      /* Setting XmlIgnore to false overrides the XmlIgnoreAttribute
         applied to the Comment field. Thus it will be serialized.*/
      attrs.XmlIgnore = false;
      xOver.Add(typeof(Group), "Comment", attrs);

      /* Use the XmlIgnore to instruct the XmlSerializer to ignore
         the GroupName instead. */
      attrs = new XmlAttributes();
      attrs.XmlIgnore = true;
      xOver.Add(typeof(Group), "GroupName", attrs);
      
      XmlSerializer xSer = new XmlSerializer(typeof(Group), xOver);
      return xSer;
   }

   public void SerializeObject(string
 filename)
   {
      // Create an XmlSerializer instance.
      XmlSerializer xSer = CreateOverrider();

      // Create the object to serialize and set its properties.
      Group myGroup = new Group();
      myGroup.GroupName = ".NET";
      myGroup.Comment = "My Comment...";
   
      // Writing the file requires a TextWriter.
      TextWriter writer = new StreamWriter(filename);

      // Serialize the object and close the TextWriter.
      xSer.Serialize(writer, myGroup);
      writer.Close();
   }
}

C++

#using <System.Xml.dll>
#using <System.dll>

using namespace System;
using namespace System::IO;
using namespace System::Xml::Serialization;

// This is the class that will be serialized. 
public ref class Group
{
public:

   // The GroupName value will be serialized--unless it's overridden.
   String^ GroupName;

   /* This field will be ignored when serialized--
      unless it's overridden. */

   [XmlIgnoreAttribute]
   String^ Comment;
};


// Return an XmlSerializer used for overriding.
XmlSerializer^ CreateOverrider()
{
   // Create the XmlAttributeOverrides and XmlAttributes objects.
   XmlAttributeOverrides^ xOver = gcnew XmlAttributeOverrides;
   XmlAttributes^ attrs = gcnew XmlAttributes;

   /* Setting XmlIgnore to false overrides the XmlIgnoreAttribute
      applied to the Comment field. Thus it will be serialized.*/
   attrs->XmlIgnore = false;
   xOver->Add( Group::typeid, "Comment", attrs );

   /* Use the XmlIgnore to instruct the XmlSerializer to ignore
      the GroupName instead. */
   attrs = gcnew XmlAttributes;
   attrs->XmlIgnore = true;
   xOver->Add( Group::typeid, "GroupName", attrs );
   XmlSerializer^ xSer = gcnew XmlSerializer( Group::typeid,xOver );
   return xSer;
}

void SerializeObject( String^ filename )
{
   // Create an XmlSerializer instance.
   XmlSerializer^ xSer = CreateOverrider();

   // Create the object to serialize and set its properties.
   Group^ myGroup = gcnew Group;
   myGroup->GroupName = ".NET";
   myGroup->Comment = "My Comment...";

   // Writing the file requires a TextWriter.
   TextWriter^ writer = gcnew StreamWriter( filename );

   // Serialize the object and close the TextWriter.
   xSer->Serialize( writer, myGroup );
   writer->Close();
}

int main()
{
   SerializeObject( "IgnoreXml.xml" );
}

import System.*;
import System.IO.*;
import System.Xml.Serialization.*;

// This is the class that will be serialized. 
public class Group
{
    // The GroupName value will be serialized--unless it's overridden.
    public String groupName;
    /* This field will be ignored when serialized--
       unless it's overridden. */
    /** @attribute XmlIgnoreAttribute()
     */
    public String comment;
} //Group

public class Test
{
    public static void main(String[]
 args)
    {
        Test t = new Test();
        t.SerializeObject("IgnoreXml.xml");
    } //main

    // Return an XmlSerializer used for overriding.
    public XmlSerializer CreateOverrider()
    {
        // Create the XmlAttributeOverrides and XmlAttributes objects.
        XmlAttributeOverrides xOver = new XmlAttributeOverrides();
        XmlAttributes attrs = new XmlAttributes();

        /* Setting XmlIgnore to false overrides the XmlIgnoreAttribute
           applied to the Comment field. Thus it will be serialized.*/
        attrs.set_XmlIgnore(false);
        xOver.Add(Group.class.ToType(), "Comment", attrs);

        /* Use the XmlIgnore to instruct the XmlSerializer to ignore
           the GroupName instead. */
        attrs = new XmlAttributes();
        attrs.set_XmlIgnore(true);
        xOver.Add(Group.class.ToType(), "GroupName",
 attrs);

        XmlSerializer xSer = new XmlSerializer(Group.class.ToType(),
 xOver);
        return xSer;
    } //CreateOverrider

    public void SerializeObject(String fileName)
    {
        // Create an XmlSerializer instance.
        XmlSerializer xSer = CreateOverrider();

        // Create the object to serialize and set its properties.
        Group myGroup = new Group();
        myGroup.groupName = ".NET";
        myGroup.comment = "My Comment...";

        // Writing the file requires a TextWriter.
        TextWriter writer = new StreamWriter(fileName);

        // Serialize the object and close the TextWriter.
        xSer.Serialize(writer, myGroup);
        writer.Close();
    } //SerializeObject
} //Test

プラットフォーム

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

参照

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

このページでは「.NET Framework クラスライブラリリファレンス」からXmlAttributes.XmlIgnore プロパティを検索した結果を表示しています。
Weblioに収録されているすべての辞書からXmlAttributes.XmlIgnore プロパティを検索する場合は、下記のリンクをクリックしてください。

全ての辞書からXmlAttributes.XmlIgnore プロパティを検索

>> 「XmlAttributes.XmlIgnore プロパティ」を含む用語の索引
XmlAttributes.XmlIgnore プロパティのページへのリンク

XmlAttributes.XmlIgnore プロパティとは？わかりやすく解説

XmlAttributes.XmlIgnore プロパティ

「XmlAttributes.XmlIgnore プロパティ」の関連用語


	© 2025 Microsoft.All rights reserved.

XmlAttributes.XmlIgnore プロパティとは？ わかりやすく解説

XmlAttributes.XmlIgnore プロパティ

急上昇のことば

「XmlAttributes.XmlIgnore プロパティ」の関連用語

XmlAttributes.XmlIgnore プロパティとは？わかりやすく解説