mcs/class/System.Xml.Linq/Documentation/en/System.Xml.Linq/XStreamingElement.xml

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <Type Name="XStreamingElement" FullName="System.Xml.Linq.XStreamingElement">
   3   <TypeSignature Language="C#" Value="public class XStreamingElement" />
   4   <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit XStreamingElement extends System.Object" />
   5   <AssemblyInfo>
   6     <AssemblyName>System.Xml.Linq</AssemblyName>
   7     <AssemblyVersion>4.0.0.0</AssemblyVersion>
   8   </AssemblyInfo>
   9   <Base>
  10     <BaseTypeName>System.Object</BaseTypeName>
  11   </Base>
  12   <Interfaces />
  13   <Docs>
  14     <remarks>
  15       <attribution license="cc4" from="Microsoft" modified="false" />
  16       <para>This class allows you to create an XML tree that supports deferred streaming output. You use this class to create an XML tree in a very similar fashion to creating an XML tree using <see cref="T:System.Xml.Linq.XElement" />. However, there is a fundamental difference. When you use a LINQ query to specify content when creating an XML tree using <see cref="T:System.Xml.Linq.XElement" />, the query variable is iterated at the time of construction of the XML tree, and the results of the query are added to the XML tree. In contrast, when you create an XML tree using <see cref="T:System.Xml.Linq.XStreamingElement" />, a reference to the query variable is stored in the XML tree without being iterated. Queries are iterated only upon serialization. This allows you to create larger XML trees while maintaining a smaller memory footprint.</para>
  17       <para>If you are streaming from an input source, such as a text file, then you can read a very large text file, and generate a very large XML document while maintaining a small memory footprint.</para>
  18       <para>Another scenario is that you have a large XML tree that has been loaded into memory, and you want to create a transformed version of the document. If you create a new document using <see cref="T:System.Xml.Linq.XElement" />, then you will have two large XML trees in memory upon completion of the transformation. However, if you create the new XML tree using <see cref="T:System.Xml.Linq.XStreamingElement" />, then your working set will be effectively cut in half.</para>
  19       <para>Note that when debugging a program that uses <see cref="T:System.Xml.Linq.XStreamingElement" />, displaying the value of an object causes its <see cref="Overload:System.Xml.Linq.XStreamingElement.ToString" /> method to be called. This causes the XML to be serialized. If the semantics of your streaming element query are such that the streaming element can only be streamed once, this may cause undesirable behavior in your debugging experience.</para>
  20     </remarks>
  21     <summary>
  22       <attribution license="cc4" from="Microsoft" modified="false" />
  23       <para>Represents elements in an XML tree that supports deferred streaming output.</para>
  24     </summary>
  25   </Docs>
  26   <Members>
  27     <Member MemberName=".ctor">
  28       <MemberSignature Language="C#" Value="public XStreamingElement (System.Xml.Linq.XName name);" />
  29       <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Xml.Linq.XName name) cil managed" />
  30       <MemberType>Constructor</MemberType>
  31       <AssemblyInfo>
  32         <AssemblyVersion>4.0.0.0</AssemblyVersion>
  33       </AssemblyInfo>
  34       <Parameters>
  35         <Parameter Name="name" Type="System.Xml.Linq.XName" />
  36       </Parameters>
  37       <Docs>
  38         <remarks>
  39           <attribution license="cc4" from="Microsoft" modified="false" />
  40           <para>This constructor creates a streaming element with no content and no attributes.</para>
  41           <para>There is an implicit conversion from string to <see cref="T:System.Xml.Linq.XName" />. Typical use of this constructor is to specify a string as the parameter instead of creating a new <see cref="T:System.Xml.Linq.XName" />.</para>
  42         </remarks>
  43         <summary>
  44           <attribution license="cc4" from="Microsoft" modified="false" />
  45           <para>Initializes a new instance of the <see cref="T:System.Xml.Linq.XElement" /> class from the specified <see cref="T:System.Xml.Linq.XName" />.</para>
  46         </summary>
  47         <param name="name">
  48           <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.Xml.Linq.XName" /> that contains the name of the element.</param>
  49       </Docs>
  50     </Member>
  51     <Member MemberName=".ctor">
  52       <MemberSignature Language="C#" Value="public XStreamingElement (System.Xml.Linq.XName name, object content);" />
  53       <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Xml.Linq.XName name, object content) cil managed" />
  54       <MemberType>Constructor</MemberType>
  55       <AssemblyInfo>
  56         <AssemblyVersion>4.0.0.0</AssemblyVersion>
  57       </AssemblyInfo>
  58       <Parameters>
  59         <Parameter Name="name" Type="System.Xml.Linq.XName" />
  60         <Parameter Name="content" Type="System.Object" />
  61       </Parameters>
  62       <Docs>
  63         <remarks>
  64           <attribution license="cc4" from="Microsoft" modified="false" />
  65           <para>This constructor creates a streaming element with the specified content and attributes.</para>
  66           <para>There is an implicit conversion from string to <see cref="T:System.Xml.Linq.XName" />. Typical use of this constructor is to specify a string as the parameter instead of creating a new <see cref="T:System.Xml.Linq.XName" />.</para>
  67           <para>Queries are not iterated until the <see cref="T:System.Xml.Linq.XStreamingElement" /> is serialized. This is in contrast to using queries for content for an <see cref="T:System.Xml.Linq.XElement" />, where queries are iterated at the time of construction of the new <see cref="T:System.Xml.Linq.XElement" />.</para>
  68           <para>For details about the valid content that can be passed to this constructor, see <format type="text/html"><a href="aee2d319-5c5f-4b99-9bb4-2f58232577ae">Valid Content of XElement and XDocument Objects</a></format>.</para>
  69         </remarks>
  70         <summary>
  71           <attribution license="cc4" from="Microsoft" modified="false" />
  72           <para>Initializes a new instance of the <see cref="T:System.Xml.Linq.XStreamingElement" /> class with the specified name and content.</para>
  73         </summary>
  74         <param name="name">
  75           <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.Xml.Linq.XName" /> that contains the element name.</param>
  76         <param name="content">
  77           <attribution license="cc4" from="Microsoft" modified="false" />The contents of the element.</param>
  78       </Docs>
  79     </Member>
  80     <Member MemberName=".ctor">
  81       <MemberSignature Language="C#" Value="public XStreamingElement (System.Xml.Linq.XName name, object[] content);" />
  82       <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Xml.Linq.XName name, object[] content) cil managed" />
  83       <MemberType>Constructor</MemberType>
  84       <AssemblyInfo>
  85         <AssemblyVersion>4.0.0.0</AssemblyVersion>
  86       </AssemblyInfo>
  87       <Parameters>
  88         <Parameter Name="name" Type="System.Xml.Linq.XName" />
  89         <Parameter Name="content" Type="System.Object[]">
  90           <Attributes>
  91             <Attribute>
  92               <AttributeName>System.ParamArray</AttributeName>
  93             </Attribute>
  94           </Attributes>
  95         </Parameter>
  96       </Parameters>
  97       <Docs>
  98         <remarks>
  99           <attribution license="cc4" from="Microsoft" modified="false" />
 100           <para>This constructor creates a streaming element with the specified content and attributes.</para>
 101           <para>There is an implicit conversion from string to <see cref="T:System.Xml.Linq.XName" />. Typical use of this constructor is to specify a string as the parameter instead of creating a new <see cref="T:System.Xml.Linq.XName" />.</para>
 102           <para>Queries are not iterated until the <see cref="T:System.Xml.Linq.XStreamingElement" /> is serialized. This is in contrast to using queries for content for an <see cref="T:System.Xml.Linq.XElement" />, where queries are iterated at the time of construction of the new <see cref="T:System.Xml.Linq.XElement" />.</para>
 103           <para>For details about the valid content that can be passed to this function, see <format type="text/html"><a href="aee2d319-5c5f-4b99-9bb4-2f58232577ae">Valid Content of XElement and XDocument Objects</a></format>.</para>
 104         </remarks>
 105         <summary>
 106           <attribution license="cc4" from="Microsoft" modified="false" />
 107           <para>Initializes a new instance of the <see cref="T:System.Xml.Linq.XStreamingElement" /> class with the specified name and content.</para>
 108         </summary>
 109         <param name="name">
 110           <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.Xml.Linq.XName" /> that contains the element name.</param>
 111         <param name="content">
 112           <attribution license="cc4" from="Microsoft" modified="false" />The contents of the element.</param>
 113       </Docs>
 114     </Member>
 115     <Member MemberName="Add">
 116       <MemberSignature Language="C#" Value="public void Add (object content);" />
 117       <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Add(object content) cil managed" />
 118       <MemberType>Method</MemberType>
 119       <AssemblyInfo>
 120         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 121       </AssemblyInfo>
 122       <ReturnValue>
 123         <ReturnType>System.Void</ReturnType>
 124       </ReturnValue>
 125       <Parameters>
 126         <Parameter Name="content" Type="System.Object" />
 127       </Parameters>
 128       <Docs>
 129         <remarks>
 130           <attribution license="cc4" from="Microsoft" modified="false" />
 131           <para>This constructor adds the specified content and attributes to the <see cref="T:System.Xml.Linq.XStreamingElement" />. While it is often possible to construct the <see cref="T:System.Xml.Linq.XStreamingElement" /> in a single statement, it is sometimes more convenient to add content to the streaming element incrementally.</para>
 132           <para>Queries are not iterated until the <see cref="T:System.Xml.Linq.XStreamingElement" /> is serialized. This is in contrast to using queries for content for an <see cref="T:System.Xml.Linq.XElement" />, where queries are iterated at the time of construction of the new <see cref="T:System.Xml.Linq.XElement" />.</para>
 133           <para>For details about the valid content that can be passed to this function, see <format type="text/html"><a href="aee2d319-5c5f-4b99-9bb4-2f58232577ae">Valid Content of XElement and XDocument Objects</a></format>.</para>
 134         </remarks>
 135         <summary>
 136           <attribution license="cc4" from="Microsoft" modified="false" />
 137           <para>Adds the specified content as children to this <see cref="T:System.Xml.Linq.XStreamingElement" />.</para>
 138         </summary>
 139         <param name="content">
 140           <attribution license="cc4" from="Microsoft" modified="false" />Content to be added to the streaming element.</param>
 141       </Docs>
 142     </Member>
 143     <Member MemberName="Add">
 144       <MemberSignature Language="C#" Value="public void Add (object[] content);" />
 145       <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Add(object[] content) cil managed" />
 146       <MemberType>Method</MemberType>
 147       <AssemblyInfo>
 148         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 149       </AssemblyInfo>
 150       <ReturnValue>
 151         <ReturnType>System.Void</ReturnType>
 152       </ReturnValue>
 153       <Parameters>
 154         <Parameter Name="content" Type="System.Object[]">
 155           <Attributes>
 156             <Attribute>
 157               <AttributeName>System.ParamArray</AttributeName>
 158             </Attribute>
 159           </Attributes>
 160         </Parameter>
 161       </Parameters>
 162       <Docs>
 163         <remarks>
 164           <attribution license="cc4" from="Microsoft" modified="false" />
 165           <para>This constructor adds the specified content and attributes to the <see cref="T:System.Xml.Linq.XStreamingElement" />. While it is often possible to construct the <see cref="T:System.Xml.Linq.XStreamingElement" /> in a single statement, it is sometimes more convenient to add content to the streaming element incrementally.</para>
 166           <para>Queries are not iterated until the <see cref="T:System.Xml.Linq.XStreamingElement" /> is serialized. This is in contrast to using queries for content for an <see cref="T:System.Xml.Linq.XElement" />, where queries are iterated at the time of construction of the new <see cref="T:System.Xml.Linq.XElement" />.</para>
 167           <para>For details about the valid content that can be passed to this function, see <format type="text/html"><a href="aee2d319-5c5f-4b99-9bb4-2f58232577ae">Valid Content of XElement and XDocument Objects</a></format>.</para>
 168         </remarks>
 169         <summary>
 170           <attribution license="cc4" from="Microsoft" modified="false" />
 171           <para>Adds the specified content as children to this <see cref="T:System.Xml.Linq.XStreamingElement" />.</para>
 172         </summary>
 173         <param name="content">
 174           <attribution license="cc4" from="Microsoft" modified="false" />Content to be added to the streaming element.</param>
 175       </Docs>
 176     </Member>
 177     <Member MemberName="Name">
 178       <MemberSignature Language="C#" Value="public System.Xml.Linq.XName Name { get; set; }" />
 179       <MemberSignature Language="ILAsm" Value=".property instance class System.Xml.Linq.XName Name" />
 180       <MemberType>Property</MemberType>
 181       <AssemblyInfo>
 182         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 183       </AssemblyInfo>
 184       <ReturnValue>
 185         <ReturnType>System.Xml.Linq.XName</ReturnType>
 186       </ReturnValue>
 187       <Docs>
 188         <value>To be added.</value>
 189         <remarks>To be added.</remarks>
 190         <summary>
 191           <attribution license="cc4" from="Microsoft" modified="false" />
 192           <para>Gets or sets the name of this streaming element.</para>
 193         </summary>
 194       </Docs>
 195     </Member>
 196     <Member MemberName="Save">
 197       <MemberSignature Language="C#" Value="public void Save (System.IO.Stream stream);" />
 198       <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Save(class System.IO.Stream stream) cil managed" />
 199       <MemberType>Method</MemberType>
 200       <AssemblyInfo>
 201         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 202       </AssemblyInfo>
 203       <ReturnValue>
 204         <ReturnType>System.Void</ReturnType>
 205       </ReturnValue>
 206       <Parameters>
 207         <Parameter Name="stream" Type="System.IO.Stream" />
 208       </Parameters>
 209       <Docs>
 210         <remarks>
 211           <attribution license="cc4" from="Microsoft" modified="false" />
 212           <para>The serialized XML will be indented. All insignificant white space will be removed, and additional white space will be added so that the XML will be properly indented. The behavior of this method is that insignificant white space will not be preserved.</para>
 213           <para>If you want to control white space, use the overload of <see cref="Overload:System.Xml.Linq.XStreamingElement.Save" /> that takes <see cref="T:System.Xml.Linq.SaveOptions" /> as a parameter. Use the <see cref="F:System.Xml.Linq.SaveOptions.DisableFormatting" /> option to save unindented XML. This will cause the writer to write all white spaces exactly as represented in the XML tree.</para>
 214           <para>Use <see cref="F:System.Xml.Linq.SaveOptions.OmitDuplicateNamespaces" /> option if you want to remove duplicate namespace declarations.</para>
 215         </remarks>
 216         <summary>
 217           <attribution license="cc4" from="Microsoft" modified="false" />
 218           <para>Outputs this <see cref="T:System.Xml.Linq.XStreamingElement" /> to the specified <see cref="T:System.IO.Stream" />.</para>
 219         </summary>
 220         <param name="stream">
 221           <attribution license="cc4" from="Microsoft" modified="false" />The stream to output this <see cref="T:System.Xml.Linq.XDocument" /> to.</param>
 222       </Docs>
 223     </Member>
 224     <Member MemberName="Save">
 225       <MemberSignature Language="C#" Value="public void Save (System.IO.TextWriter textWriter);" />
 226       <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Save(class System.IO.TextWriter textWriter) cil managed" />
 227       <MemberType>Method</MemberType>
 228       <AssemblyInfo>
 229         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 230       </AssemblyInfo>
 231       <ReturnValue>
 232         <ReturnType>System.Void</ReturnType>
 233       </ReturnValue>
 234       <Parameters>
 235         <Parameter Name="textWriter" Type="System.IO.TextWriter" />
 236       </Parameters>
 237       <Docs>
 238         <remarks>
 239           <attribution license="cc4" from="Microsoft" modified="false" />
 240           <para>The serialized XML will be indented. All insignificant white space will be removed, and additional white space will be added so that the XML will be properly indented. The behavior of this method is that insignificant white space nodes in the XML tree will not be preserved.</para>
 241           <para>If you want to control white space, use one of the overloads of <see cref="Overload:System.Xml.Linq.XStreamingElement.Save" /> that take <see cref="T:System.Xml.Linq.SaveOptions" /> as a parameter. For more information, see <format type="text/html"><a href="093a7169-a04e-4638-b08c-d1cb98aa650d">Preserving White Space while Loading or Parsing XML</a></format> and <format type="text/html"><a href="fb146217-0a49-4efc-ac84-7265b91d3939">Preserving White Space While Serializing</a></format>.</para>
 242         </remarks>
 243         <summary>
 244           <attribution license="cc4" from="Microsoft" modified="false" />
 245           <para>Serialize this streaming element to a <see cref="T:System.IO.TextWriter" />.</para>
 246         </summary>
 247         <param name="textWriter">
 248           <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.IO.TextWriter" /> that the <see cref="T:System.Xml.Linq.XStreamingElement" /> will be written to.</param>
 249       </Docs>
 250     </Member>
 251     <Member MemberName="Save">
 252       <MemberSignature Language="C#" Value="public void Save (string fileName);" />
 253       <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Save(string fileName) cil managed" />
 254       <MemberType>Method</MemberType>
 255       <AssemblyInfo>
 256         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 257       </AssemblyInfo>
 258       <ReturnValue>
 259         <ReturnType>System.Void</ReturnType>
 260       </ReturnValue>
 261       <Parameters>
 262         <Parameter Name="fileName" Type="System.String" />
 263       </Parameters>
 264       <Docs>
 265         <remarks>
 266           <attribution license="cc4" from="Microsoft" modified="false" />
 267           <para>The serialized XML will be indented. All insignificant white space will be removed, and additional white space will be added so that the XML will be properly indented. The behavior of this method is that insignificant white space nodes in the XML tree will not be preserved.</para>
 268           <para>If you want to control white space, use one of the overloads of <see cref="Overload:System.Xml.Linq.XStreamingElement.Save" /> that take <see cref="T:System.Xml.Linq.SaveOptions" /> as a parameter. For more information, see <format type="text/html"><a href="093a7169-a04e-4638-b08c-d1cb98aa650d">Preserving White Space while Loading or Parsing XML</a></format> and <format type="text/html"><a href="fb146217-0a49-4efc-ac84-7265b91d3939">Preserving White Space While Serializing</a></format>.</para>
 269         </remarks>
 270         <summary>
 271           <attribution license="cc4" from="Microsoft" modified="false" />
 272           <para>Serialize this streaming element to a file.</para>
 273         </summary>
 274         <param name="fileName">
 275           <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.String" /> that contains the name of the file.</param>
 276       </Docs>
 277     </Member>
 278     <Member MemberName="Save">
 279       <MemberSignature Language="C#" Value="public void Save (System.Xml.XmlWriter writer);" />
 280       <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Save(class System.Xml.XmlWriter writer) cil managed" />
 281       <MemberType>Method</MemberType>
 282       <AssemblyInfo>
 283         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 284       </AssemblyInfo>
 285       <ReturnValue>
 286         <ReturnType>System.Void</ReturnType>
 287       </ReturnValue>
 288       <Parameters>
 289         <Parameter Name="writer" Type="System.Xml.XmlWriter" />
 290       </Parameters>
 291       <Docs>
 292         <remarks>To be added.</remarks>
 293         <summary>
 294           <attribution license="cc4" from="Microsoft" modified="false" />
 295           <para>Serialize this streaming element to an <see cref="T:System.Xml.XmlWriter" />.</para>
 296         </summary>
 297         <param name="writer">
 298           <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Xml.XmlWriter" /> that the <see cref="T:System.Xml.Linq.XElement" /> will be written to.</param>
 299       </Docs>
 300     </Member>
 301     <Member MemberName="Save">
 302       <MemberSignature Language="C#" Value="public void Save (System.IO.Stream stream, System.Xml.Linq.SaveOptions options);" />
 303       <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Save(class System.IO.Stream stream, valuetype System.Xml.Linq.SaveOptions options) cil managed" />
 304       <MemberType>Method</MemberType>
 305       <AssemblyInfo>
 306         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 307       </AssemblyInfo>
 308       <ReturnValue>
 309         <ReturnType>System.Void</ReturnType>
 310       </ReturnValue>
 311       <Parameters>
 312         <Parameter Name="stream" Type="System.IO.Stream" />
 313         <Parameter Name="options" Type="System.Xml.Linq.SaveOptions" />
 314       </Parameters>
 315       <Docs>
 316         <remarks>
 317           <attribution license="cc4" from="Microsoft" modified="false" />
 318           <para>By default the <paramref name="options" /> are set to <see cref="F:System.Xml.Linq.SaveOptions.None" />. This option will remove all extraneous insignificant white space, and add appropriate insignificant white space so that the XML is properly indented. </para>
 319           <para>If you want to save unindented XML, specify the <see cref="F:System.Xml.Linq.SaveOptions.DisableFormatting" /> flag for <paramref name="options" />. This will cause the writer to write all white spaces exactly as represented in the XML tree.</para>
 320           <para>Use <see cref="F:System.Xml.Linq.SaveOptions.OmitDuplicateNamespaces" /> option if you want to remove duplicate namespace declarations.</para>
 321         </remarks>
 322         <summary>
 323           <attribution license="cc4" from="Microsoft" modified="false" />
 324           <para>Outputs this <see cref="T:System.Xml.Linq.XStreamingElement" /> to the specified <see cref="T:System.IO.Stream" />, optionally specifying formatting behavior.</para>
 325         </summary>
 326         <param name="stream">
 327           <attribution license="cc4" from="Microsoft" modified="false" />The stream to output this <see cref="T:System.Xml.Linq.XDocument" /> to.</param>
 328         <param name="options">
 329           <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Xml.Linq.SaveOptions" /> object that specifies formatting behavior.</param>
 330       </Docs>
 331     </Member>
 332     <Member MemberName="Save">
 333       <MemberSignature Language="C#" Value="public void Save (System.IO.TextWriter textWriter, System.Xml.Linq.SaveOptions options);" />
 334       <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Save(class System.IO.TextWriter textWriter, valuetype System.Xml.Linq.SaveOptions options) cil managed" />
 335       <MemberType>Method</MemberType>
 336       <AssemblyInfo>
 337         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 338       </AssemblyInfo>
 339       <ReturnValue>
 340         <ReturnType>System.Void</ReturnType>
 341       </ReturnValue>
 342       <Parameters>
 343         <Parameter Name="textWriter" Type="System.IO.TextWriter" />
 344         <Parameter Name="options" Type="System.Xml.Linq.SaveOptions" />
 345       </Parameters>
 346       <Docs>
 347         <remarks>
 348           <attribution license="cc4" from="Microsoft" modified="false" />
 349           <para>If you want to save unindented XML, specify the <see cref="F:System.Xml.Linq.SaveOptions.DisableFormatting" /> flag for <paramref name="options" />. This will cause the writer to write all white space exactly as represented in the XML tree.</para>
 350           <para>If you want to save indented XML, do not specify the <see cref="F:System.Xml.Linq.SaveOptions.DisableFormatting" /> flag for <paramref name="options" />. This will remove all extraneous insignificant white space, and add appropriate insignificant white space so that the XML is properly indented. This is the default behavior, and the behavior of the overloads of the <see cref="Overload:System.Xml.Linq.XElement.Save" /> methods that do not take <paramref name="options" /> as a parameter.</para>
 351           <para>For more information, see <format type="text/html"><a href="093a7169-a04e-4638-b08c-d1cb98aa650d">Preserving White Space while Loading or Parsing XML</a></format> and <format type="text/html"><a href="fb146217-0a49-4efc-ac84-7265b91d3939">Preserving White Space While Serializing</a></format>.</para>
 352         </remarks>
 353         <summary>
 354           <attribution license="cc4" from="Microsoft" modified="false" />
 355           <para>Serialize this streaming element to a <see cref="T:System.IO.TextWriter" />, optionally disabling formatting.</para>
 356         </summary>
 357         <param name="textWriter">
 358           <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.IO.TextWriter" /> to output the XML to.</param>
 359         <param name="options">
 360           <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Xml.Linq.SaveOptions" /> that specifies formatting behavior.</param>
 361       </Docs>
 362     </Member>
 363     <Member MemberName="Save">
 364       <MemberSignature Language="C#" Value="public void Save (string fileName, System.Xml.Linq.SaveOptions options);" />
 365       <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Save(string fileName, valuetype System.Xml.Linq.SaveOptions options) cil managed" />
 366       <MemberType>Method</MemberType>
 367       <AssemblyInfo>
 368         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 369       </AssemblyInfo>
 370       <ReturnValue>
 371         <ReturnType>System.Void</ReturnType>
 372       </ReturnValue>
 373       <Parameters>
 374         <Parameter Name="fileName" Type="System.String" />
 375         <Parameter Name="options" Type="System.Xml.Linq.SaveOptions" />
 376       </Parameters>
 377       <Docs>
 378         <remarks>
 379           <attribution license="cc4" from="Microsoft" modified="false" />
 380           <para>If you want to save unindented XML, specify the <see cref="F:System.Xml.Linq.SaveOptions.DisableFormatting" /> flag for <paramref name="options" />. This will cause the writer to write all white space exactly as represented in the XML tree.</para>
 381           <para>If you want to save indented XML, do not specify the <see cref="F:System.Xml.Linq.SaveOptions.DisableFormatting" /> flag for <paramref name="options" />. This will remove all extraneous insignificant white space, and add appropriate insignificant white space so that the XML is properly indented. This is the default behavior, and the behavior of the overloads of the <see cref="Overload:System.Xml.Linq.XElement.Save" /> methods that do not take <paramref name="options" /> as a parameter.</para>
 382           <para>For more information, see <format type="text/html"><a href="093a7169-a04e-4638-b08c-d1cb98aa650d">Preserving White Space while Loading or Parsing XML</a></format> and <format type="text/html"><a href="fb146217-0a49-4efc-ac84-7265b91d3939">Preserving White Space While Serializing</a></format>.</para>
 383         </remarks>
 384         <summary>
 385           <attribution license="cc4" from="Microsoft" modified="false" />
 386           <para>Serialize this streaming element to a file, optionally disabling formatting.</para>
 387         </summary>
 388         <param name="fileName">
 389           <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.String" /> that contains the name of the file.</param>
 390         <param name="options">
 391           <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Xml.Linq.SaveOptions" /> object that specifies formatting behavior.</param>
 392       </Docs>
 393     </Member>
 394     <Member MemberName="ToString">
 395       <MemberSignature Language="C#" Value="public override string ToString ();" />
 396       <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance string ToString() cil managed" />
 397       <MemberType>Method</MemberType>
 398       <AssemblyInfo>
 399         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 400       </AssemblyInfo>
 401       <ReturnValue>
 402         <ReturnType>System.String</ReturnType>
 403       </ReturnValue>
 404       <Parameters />
 405       <Docs>
 406         <remarks>
 407           <attribution license="cc4" from="Microsoft" modified="false" />
 408           <para>Note that when debugging a program that uses <see cref="T:System.Xml.Linq.XStreamingElement" />, displaying the value of an object causes its <see cref="Overload:System.Xml.Linq.XStreamingElement.ToString" /> method to be called. This causes the XML to be serialized. If the semantics of your streaming element query are such that the streaming element can only be streamed once, this may cause undesirable behavior in your debugging experience.</para>
 409         </remarks>
 410         <summary>
 411           <attribution license="cc4" from="Microsoft" modified="false" />
 412           <para>Returns the formatted (indented) XML for this streaming element.</para>
 413         </summary>
 414         <returns>
 415           <attribution license="cc4" from="Microsoft" modified="false" />
 416           <para>A <see cref="T:System.String" /> containing the indented XML.</para>
 417         </returns>
 418       </Docs>
 419     </Member>
 420     <Member MemberName="ToString">
 421       <MemberSignature Language="C#" Value="public string ToString (System.Xml.Linq.SaveOptions options);" />
 422       <MemberSignature Language="ILAsm" Value=".method public hidebysig instance string ToString(valuetype System.Xml.Linq.SaveOptions options) cil managed" />
 423       <MemberType>Method</MemberType>
 424       <AssemblyInfo>
 425         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 426       </AssemblyInfo>
 427       <ReturnValue>
 428         <ReturnType>System.String</ReturnType>
 429       </ReturnValue>
 430       <Parameters>
 431         <Parameter Name="options" Type="System.Xml.Linq.SaveOptions" />
 432       </Parameters>
 433       <Docs>
 434         <remarks>
 435           <attribution license="cc4" from="Microsoft" modified="false" />
 436           <para>Note that when debugging a program that uses <see cref="T:System.Xml.Linq.XStreamingElement" />, displaying the value of an object causes its <see cref="Overload:System.Xml.Linq.XStreamingElement.ToString" /> method to be called. This causes the XML to be serialized. If the semantics of your streaming element query are such that the streaming element can only be streamed once, this may cause undesirable behavior in your debugging experience.</para>
 437         </remarks>
 438         <summary>
 439           <attribution license="cc4" from="Microsoft" modified="false" />
 440           <para>Returns the XML for this streaming element, optionally disabling formatting.</para>
 441         </summary>
 442         <returns>
 443           <attribution license="cc4" from="Microsoft" modified="false" />
 444           <para>A <see cref="T:System.String" /> containing the XML.</para>
 445         </returns>
 446         <param name="options">
 447           <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Xml.Linq.SaveOptions" /> that specifies formatting behavior.</param>
 448       </Docs>
 449     </Member>
 450     <Member MemberName="WriteTo">
 451       <MemberSignature Language="C#" Value="public void WriteTo (System.Xml.XmlWriter writer);" />
 452       <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void WriteTo(class System.Xml.XmlWriter writer) cil managed" />
 453       <MemberType>Method</MemberType>
 454       <AssemblyInfo>
 455         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 456       </AssemblyInfo>
 457       <ReturnValue>
 458         <ReturnType>System.Void</ReturnType>
 459       </ReturnValue>
 460       <Parameters>
 461         <Parameter Name="writer" Type="System.Xml.XmlWriter" />
 462       </Parameters>
 463       <Docs>
 464         <remarks>To be added.</remarks>
 465         <summary>
 466           <attribution license="cc4" from="Microsoft" modified="false" />
 467           <para>Writes this streaming element to an <see cref="T:System.Xml.XmlWriter" />.</para>
 468         </summary>
 469         <param name="writer">
 470           <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.Xml.XmlWriter" /> into which this method will write.</param>
 471       </Docs>
 472     </Member>
 473   </Members>
 474 </Type>