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

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <Type Name="XDeclaration" FullName="System.Xml.Linq.XDeclaration">
   3   <TypeSignature Language="C#" Value="public class XDeclaration" />
   4   <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit XDeclaration 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>An XML declaration is used to declare the XML version, the encoding, and whether or not the XML document is standalone. This class represents the XML concept of an XML declaration. </para>
  17       <para>Just as in the XML standard, declarations are associated with a document. When you create a document, you have the option to specify the declaration for the document. The <see cref="T:System.Xml.Linq.XDocument" /> class contains the <see cref="P:System.Xml.Linq.XDocument.Declaration" /> property, which allows you to set or get the declaration. For information about how to serialize an XML tree with an XML declaration, see <format type="text/html"><a href="30f1b564-62b5-4e5d-9c36-884e51113feb">Saving With an XML Declaration</a></format>. </para>
  18     </remarks>
  19     <summary>
  20       <attribution license="cc4" from="Microsoft" modified="false" />
  21       <para>Represents an XML declaration.</para>
  22     </summary>
  23   </Docs>
  24   <Members>
  25     <Member MemberName=".ctor">
  26       <MemberSignature Language="C#" Value="public XDeclaration (System.Xml.Linq.XDeclaration other);" />
  27       <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Xml.Linq.XDeclaration other) cil managed" />
  28       <MemberType>Constructor</MemberType>
  29       <AssemblyInfo>
  30         <AssemblyVersion>4.0.0.0</AssemblyVersion>
  31       </AssemblyInfo>
  32       <Parameters>
  33         <Parameter Name="other" Type="System.Xml.Linq.XDeclaration" />
  34       </Parameters>
  35       <Docs>
  36         <remarks>
  37           <attribution license="cc4" from="Microsoft" modified="false" />
  38           <para>This constructor is primarily used internally to make a deep copy of an XML tree.</para>
  39         </remarks>
  40         <summary>
  41           <attribution license="cc4" from="Microsoft" modified="false" />
  42           <para>Initializes a new instance of the <see cref="T:System.Xml.Linq.XDeclaration" /> class from another <see cref="T:System.Xml.Linq.XDeclaration" /> object. </para>
  43         </summary>
  44         <param name="other">
  45           <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Xml.Linq.XDeclaration" /> used to initialize this <see cref="T:System.Xml.Linq.XDeclaration" /> object.</param>
  46       </Docs>
  47     </Member>
  48     <Member MemberName=".ctor">
  49       <MemberSignature Language="C#" Value="public XDeclaration (string version, string encoding, string standalone);" />
  50       <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string version, string encoding, string standalone) cil managed" />
  51       <MemberType>Constructor</MemberType>
  52       <AssemblyInfo>
  53         <AssemblyVersion>4.0.0.0</AssemblyVersion>
  54       </AssemblyInfo>
  55       <Parameters>
  56         <Parameter Name="version" Type="System.String" />
  57         <Parameter Name="encoding" Type="System.String" />
  58         <Parameter Name="standalone" Type="System.String" />
  59       </Parameters>
  60       <Docs>
  61         <remarks>To be added.</remarks>
  62         <summary>
  63           <attribution license="cc4" from="Microsoft" modified="false" />
  64           <para>Initializes a new instance of the <see cref="T:System.Xml.Linq.XDeclaration" /> class with the specified version, encoding, and standalone status.</para>
  65         </summary>
  66         <param name="version">
  67           <attribution license="cc4" from="Microsoft" modified="false" />The version of the XML, usually "1.0".</param>
  68         <param name="encoding">
  69           <attribution license="cc4" from="Microsoft" modified="false" />The encoding for the XML document.</param>
  70         <param name="standalone">
  71           <attribution license="cc4" from="Microsoft" modified="false" />A string containing "yes" or "no" that specifies whether the XML is standalone or requires external entities to be resolved.</param>
  72       </Docs>
  73     </Member>
  74     <Member MemberName="Encoding">
  75       <MemberSignature Language="C#" Value="public string Encoding { get; set; }" />
  76       <MemberSignature Language="ILAsm" Value=".property instance string Encoding" />
  77       <MemberType>Property</MemberType>
  78       <AssemblyInfo>
  79         <AssemblyVersion>4.0.0.0</AssemblyVersion>
  80       </AssemblyInfo>
  81       <ReturnValue>
  82         <ReturnType>System.String</ReturnType>
  83       </ReturnValue>
  84       <Docs>
  85         <value>To be added.</value>
  86         <remarks>
  87           <attribution license="cc4" from="Microsoft" modified="false" />
  88           <para>Any value returned by <see cref="P:System.Text.Encoding.WebName" /> is a valid value.</para>
  89           <para>If you read an encoded document, then this property will be set to the code page name.</para>
  90           <para>If you set this property to a valid code page name, then when serializing, LINQ to XML will serialize with the specified encoding.</para>
  91         </remarks>
  92         <summary>
  93           <attribution license="cc4" from="Microsoft" modified="false" />
  94           <para>Gets or sets the encoding for this document.</para>
  95         </summary>
  96       </Docs>
  97     </Member>
  98     <Member MemberName="Standalone">
  99       <MemberSignature Language="C#" Value="public string Standalone { get; set; }" />
 100       <MemberSignature Language="ILAsm" Value=".property instance string Standalone" />
 101       <MemberType>Property</MemberType>
 102       <AssemblyInfo>
 103         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 104       </AssemblyInfo>
 105       <ReturnValue>
 106         <ReturnType>System.String</ReturnType>
 107       </ReturnValue>
 108       <Docs>
 109         <value>To be added.</value>
 110         <remarks>
 111           <attribution license="cc4" from="Microsoft" modified="false" />
 112           <para>The valid values for standalone are "yes" or "no". These values are not enforced.</para>
 113         </remarks>
 114         <summary>
 115           <attribution license="cc4" from="Microsoft" modified="false" />
 116           <para>Gets or sets the standalone property for this document.</para>
 117         </summary>
 118       </Docs>
 119     </Member>
 120     <Member MemberName="ToString">
 121       <MemberSignature Language="C#" Value="public override string ToString ();" />
 122       <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance string ToString() cil managed" />
 123       <MemberType>Method</MemberType>
 124       <AssemblyInfo>
 125         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 126       </AssemblyInfo>
 127       <ReturnValue>
 128         <ReturnType>System.String</ReturnType>
 129       </ReturnValue>
 130       <Parameters />
 131       <Docs>
 132         <remarks>To be added.</remarks>
 133         <summary>
 134           <attribution license="cc4" from="Microsoft" modified="false" />
 135           <para>Provides the declaration as a formatted string.</para>
 136         </summary>
 137         <returns>
 138           <attribution license="cc4" from="Microsoft" modified="false" />
 139           <para>A <see cref="T:System.String" /> that contains the formatted XML string.</para>
 140         </returns>
 141       </Docs>
 142     </Member>
 143     <Member MemberName="Version">
 144       <MemberSignature Language="C#" Value="public string Version { get; set; }" />
 145       <MemberSignature Language="ILAsm" Value=".property instance string Version" />
 146       <MemberType>Property</MemberType>
 147       <AssemblyInfo>
 148         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 149       </AssemblyInfo>
 150       <ReturnValue>
 151         <ReturnType>System.String</ReturnType>
 152       </ReturnValue>
 153       <Docs>
 154         <value>To be added.</value>
 155         <remarks>
 156           <attribution license="cc4" from="Microsoft" modified="false" />
 157           <para>The value is usually "1.0". This value is not enforced.</para>
 158         </remarks>
 159         <summary>
 160           <attribution license="cc4" from="Microsoft" modified="false" />
 161           <para>Gets or sets the version property for this document.</para>
 162         </summary>
 163       </Docs>
 164     </Member>
 165   </Members>
 166 </Type>