LoadOptions 列挙型

  • リファレンス

定義

名前空間:
System.Xml.Linq
アセンブリ:
System.Xml.XDocument.dll
アセンブリ:
System.Xml.Linq.dll
アセンブリ:
netstandard.dll

XML 解析時の読み込みオプションを指定します。

この列挙体は、メンバー値のビットごとの組み合わせをサポートしています。

public enum class LoadOptions
[System.Flags]
public enum LoadOptions
[<System.Flags>]
type LoadOptions = 
Public Enum LoadOptions
継承
Object
ValueType
Enum
LoadOptions
属性
FlagsAttribute

フィールド

None 0

意味のない空白を保持したり、ベース URI と行情報を読み込んだりしないでください。
PreserveWhitespace 1

解析の際に意味のない空白が保存されます。
SetBaseUri 2

XmlReader からベース URI 情報を要求し、BaseUri プロパティを介して使用できるようにします。
SetLineInfo 4

XmlReader から行情報を要求し、XObject 上のプロパティを介して使用できるようにします。

例

次の使用例は、ファイルから小さな XML ツリーを読み込み、基本 URI を設定し、行情報を保持するオプションを設定します。 次に、行情報を持たない別の要素を追加します。 次に、ツリー内の各要素の行情報を出力します。

string markup = @"<Root>  
    <Child1 />  
    <Child2 />  
    <Child4 />  
</Root>";  

File.WriteAllText("Test.xml", markup);  

XElement po = XElement.Load("Test.xml",  
    LoadOptions.SetBaseUri | LoadOptions.SetLineInfo);  

// add a node to the tree.  
// the newly added node will not have line information.  
po.Element("Child2").AddAfterSelf(new XElement("Child3"));  

string[] splitUri = po.BaseUri.Split('/');  
Console.WriteLine("BaseUri: {0}", splitUri[splitUri.Length - 1]);  
Console.WriteLine();  
Console.WriteLine("{0}{1}{2}",  
    "Element Name".PadRight(20),  
    "Line".PadRight(5),  
    "Position");  
Console.WriteLine("{0}{1}{2}",  
    "------------".PadRight(20),  
    "----".PadRight(5),  
    "--------");  
foreach (XElement e in po.DescendantsAndSelf())  
    Console.WriteLine("{0}{1}{2}",  
        ("".PadRight(e.Ancestors().Count() * 2) + e.Name).PadRight(20),  
        ((IXmlLineInfo)e).HasLineInfo() ?  
            ((IXmlLineInfo)e).LineNumber.ToString().PadRight(5) :  
            "",  
        ((IXmlLineInfo)e).HasLineInfo() ?  
            ((IXmlLineInfo)e).LinePosition.ToString() :  
            "No Line Information");  

Dim markup As String = _  
    "<Root>" + Environment.NewLine & _  
    "    <Child1 />" + Environment.NewLine & _  
    "    <Child2 />" + Environment.NewLine & _  
    "    <Child4 />" + Environment.NewLine & _  
    "</Root>"  

File.WriteAllText("Test.xml", markup)  

Dim po As XElement = XElement.Load("Test.xml", LoadOptions.SetBaseUri Or LoadOptions.SetLineInfo)  

' add a node to the tree.  
' the newly added node will not have line information.  
po.Element("Child2").AddAfterSelf(New XElement("Child3"))  

Dim splitUri() As String = po.BaseUri.Split("/"c)  
Console.WriteLine("BaseUri: {0}", splitUri(splitUri.Length - 1))  
Console.WriteLine()  
Console.WriteLine("{0}{1}{2}", _  
    "Element Name".PadRight(20), _  
    "Line".PadRight(5), _  
    "Position")  
Console.WriteLine("{0}{1}{2}", _  
    "------------".PadRight(20), _  
    "----".PadRight(5), _  
    "--------")  
For Each e As XElement In po.DescendantsAndSelf()  
    Console.WriteLine("{0}{1}{2}", _  
        ("".PadRight(e.Ancestors().Count() * 2) & e.Name.ToString).PadRight(20), _  
        IIf(DirectCast(e, IXmlLineInfo).HasLineInfo(), _  
            DirectCast(e, IXmlLineInfo).LineNumber.ToString().PadRight(5), _  
            ""), _  
        IIf(DirectCast(e, IXmlLineInfo).HasLineInfo(), _  
            DirectCast(e, IXmlLineInfo).LinePosition.ToString(), _  
            "No Line Information"))  
Next

この例を実行すると、次の出力が生成されます。

BaseUri: Test.xml  

Element Name        Line Position  
------------        ---- --------  
Root                1    2  
  Child1            2    6  
  Child2            3    6  
  Child3            No Line Information  
  Child4            4    6

注釈

読み込み時に空白を保持する場合、XML ツリー内のすべての重要でない空白は、そのまま XML ツリーに具体化されます。 空白を保持しない場合、重要でない空白はすべて破棄されます。

SetBaseUri フラグと SetLineInfo フラグを設定すると、パフォーマンスが低下します。

ベース URI と行情報は、XML ドキュメントを読み込んだ直後に正確です。 ドキュメントの読み込み後に XML ツリーを変更すると、ベース URI と行情報が意味をなさなくなる可能性があります。

基になる URI XmlReader または行の基本情報がない場合、SetBaseUri フラグと SetLineInfo フラグを設定しても効果はありません。

この型を使用すると、読み込みまたは解析時LINQ to XML空白を処理する方法を制御できます。 詳細については、「XML の 読み込みまたは解析中に空白を保持する 」および「 シリアル化中に空白を保持する」を参照してください。

適用対象

こちらもご覧ください