mcs/class/Managed.Windows.Forms/Documentation/en/System.Resources/ResXFileRef.xml

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <Type Name="ResXFileRef" FullName="System.Resources.ResXFileRef">
   3   <TypeSignature Language="C#" Value="public class ResXFileRef" />
   4   <AssemblyInfo>
   5     <AssemblyName>System.Windows.Forms</AssemblyName>
   6     <AssemblyVersion>1.0.5000.0</AssemblyVersion>
   7     <AssemblyVersion>2.0.0.0</AssemblyVersion>
   8   </AssemblyInfo>
   9   <Base>
  10     <BaseTypeName>System.Object</BaseTypeName>
  11   </Base>
  12   <Interfaces />
  13   <Attributes>
  14     <Attribute>
  15       <AttributeName>System.ComponentModel.TypeConverter(typeof(System.Resources.ResXFileRef+Converter))</AttributeName>
  16     </Attribute>
  17   </Attributes>
  18   <Docs>
  19     <remarks>
  20       <attribution license="cc4" from="Microsoft" modified="false" />
  21       <para>The <see cref="T:System.Resources.ResXFileRef" /> class is used to include references to files in an XML resource (.resx) file. A <see cref="T:System.Resources.ResXFileRef" /> object represents a link to an external resource in an XML resource (.resx) file. You add the <see cref="T:System.Resources.ResXFileRef" /> object to a .resx file by calling the <see cref="M:System.Resources.ResXResourceWriter.AddResource(System.Resources.ResXDataNode)" /> method. </para>
  22       <para>In a data entry in a .resx file, the type is <see cref="T:System.Resources.ResXFileRef" />, and the value is the path location on disk. When the resource manager deserializes the object, the <see cref="T:System.Resources.ResXFileRef" /> performs the I/O to get the file. The following is an example of a .resx file. </para>
  23       <code> &lt;data name="iconclip" type="System.Resources.ResXFileRef, System.Windows.Forms"&gt;
  24   &lt;value&gt;lookout.bmp;System.Drawing.Bitmap, System.Drawing&lt;/value&gt;
  25  &lt;/data&gt;
  26  &lt;data name="mailbackground" type="System.Resources.ResXFileRef, System.Windows.Forms"&gt;
  27   &lt;value&gt;mailbackground.bmp;System.Drawing.Bitmap, System.Drawing&lt;/value&gt;
  28  &lt;/data&gt;
  29  &lt;data name="xplogo" type="System.Resources.ResXFileRef, System.Windows.Forms"&gt;
  30   &lt;value&gt;xplogo.png;System.Drawing.Bitmap, System.Drawing&lt;/value&gt;
  31  &lt;/data&gt;</code>
  32       <para>To add a <see cref="T:System.Resources.ResXFileRef" /> object to a .resx file programmatically, you call the <see cref="M:System.Resources.ResXDataNode.#ctor(System.String,System.Resources.ResXFileRef)" /> constructor to instantiate a <see cref="T:System.Resources.ResXDataNode" /> object. You then pass this <see cref="T:System.Resources.ResXDataNode" /> object to the <see cref="M:System.Resources.ResXResourceWriter.AddResource(System.Resources.ResXDataNode)" /> method. </para>
  33       <para>When you compile a .resx file with <format type="text/html"><a href="8ef159de-b660-4bec-9213-c3fbc4d1c6f4">Resgen.exe (Resource File Generator)</a></format>, the resources specified in the .resx file are embedded in the resulting document resource file.</para>
  34     </remarks>
  35     <summary>
  36       <attribution license="cc4" from="Microsoft" modified="false" />
  37       <para>Represents a link to an external resource.</para>
  38     </summary>
  39   </Docs>
  40   <Members>
  41     <Member MemberName=".ctor">
  42       <MemberSignature Language="C#" Value="public ResXFileRef (string fileName, string typeName);" />
  43       <MemberType>Constructor</MemberType>
  44       <Parameters>
  45         <Parameter Name="fileName" Type="System.String" />
  46         <Parameter Name="typeName" Type="System.String" />
  47       </Parameters>
  48       <Docs>
  49         <remarks>
  50           <attribution license="cc4" from="Microsoft" modified="false" />
  51           <para>The type referred to by the <paramref name="typeName" /> parameter must support a public constructor that accepts a <see cref="T:System.IO.Stream" /> object as a parameter.</para>
  52         </remarks>
  53         <summary>
  54           <attribution license="cc4" from="Microsoft" modified="false" />
  55           <para>Creates a new instance of the <see cref="T:System.Resources.ResXFileRef" /> class that references the specified file.</para>
  56         </summary>
  57         <param name="fileName">
  58           <attribution license="cc4" from="Microsoft" modified="false" />The file to reference. </param>
  59         <param name="typeName">
  60           <attribution license="cc4" from="Microsoft" modified="false" />The type of the resource that is referenced. </param>
  61       </Docs>
  62       <AssemblyInfo>
  63         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  64         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  65       </AssemblyInfo>
  66     </Member>
  67     <Member MemberName=".ctor">
  68       <MemberSignature Language="C#" Value="public ResXFileRef (string fileName, string typeName, System.Text.Encoding textFileEncoding);" />
  69       <MemberType>Constructor</MemberType>
  70       <AssemblyInfo>
  71         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  72       </AssemblyInfo>
  73       <Parameters>
  74         <Parameter Name="fileName" Type="System.String" />
  75         <Parameter Name="typeName" Type="System.String" />
  76         <Parameter Name="textFileEncoding" Type="System.Text.Encoding" />
  77       </Parameters>
  78       <Docs>
  79         <remarks>
  80           <attribution license="cc4" from="Microsoft" modified="false" />
  81           <para>The type referred to by the <paramref name="typeName" /> parameter must support a public constructor that accepts a <see cref="T:System.IO.Stream" /> object as a parameter.</para>
  82         </remarks>
  83         <summary>
  84           <attribution license="cc4" from="Microsoft" modified="false" />
  85           <para>Initializes a new instance of the <see cref="T:System.Resources.ResXFileRef" /> class that references the specified file. </para>
  86         </summary>
  87         <param name="fileName">
  88           <attribution license="cc4" from="Microsoft" modified="false" />The file to reference. </param>
  89         <param name="typeName">
  90           <attribution license="cc4" from="Microsoft" modified="false" />The type name of the resource that is referenced. </param>
  91         <param name="textFileEncoding">
  92           <attribution license="cc4" from="Microsoft" modified="false" />The encoding used in the referenced file.</param>
  93       </Docs>
  94     </Member>
  95     <Member MemberName="FileName">
  96       <MemberSignature Language="C#" Value="public string FileName { get; }" />
  97       <MemberType>Property</MemberType>
  98       <AssemblyInfo>
  99         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 100       </AssemblyInfo>
 101       <ReturnValue>
 102         <ReturnType>System.String</ReturnType>
 103       </ReturnValue>
 104       <Docs>
 105         <value>To be added.</value>
 106         <remarks>To be added.</remarks>
 107         <summary>
 108           <attribution license="cc4" from="Microsoft" modified="false" />
 109           <para>Gets the file name specified in the current <see cref="Overload:System.Resources.ResXFileRef.#ctor" /> constructor.</para>
 110         </summary>
 111       </Docs>
 112     </Member>
 113     <Member MemberName="TextFileEncoding">
 114       <MemberSignature Language="C#" Value="public System.Text.Encoding TextFileEncoding { get; }" />
 115       <MemberType>Property</MemberType>
 116       <AssemblyInfo>
 117         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 118       </AssemblyInfo>
 119       <ReturnValue>
 120         <ReturnType>System.Text.Encoding</ReturnType>
 121       </ReturnValue>
 122       <Docs>
 123         <value>To be added.</value>
 124         <remarks>To be added.</remarks>
 125         <summary>
 126           <attribution license="cc4" from="Microsoft" modified="false" />
 127           <para>Gets the encoding specified in the current <see cref="Overload:System.Resources.ResXFileRef.#ctor" /> constructor.</para>
 128         </summary>
 129       </Docs>
 130     </Member>
 131     <Member MemberName="ToString">
 132       <MemberSignature Language="C#" Value="public override string ToString ();" />
 133       <MemberType>Method</MemberType>
 134       <ReturnValue>
 135         <ReturnType>System.String</ReturnType>
 136       </ReturnValue>
 137       <Parameters />
 138       <Docs>
 139         <remarks>To be added.</remarks>
 140         <summary>
 141           <attribution license="cc4" from="Microsoft" modified="false" />
 142           <para>Gets the text representation of the current <see cref="T:System.Resources.ResXFileRef" /> object.</para>
 143         </summary>
 144         <returns>
 145           <attribution license="cc4" from="Microsoft" modified="false" />
 146           <para>A string that consists of the concatenated text representations of the parameters specified in the current <see cref="Overload:System.Resources.ResXFileRef.#ctor" /> constructor.</para>
 147         </returns>
 148       </Docs>
 149       <AssemblyInfo>
 150         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 151         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 152       </AssemblyInfo>
 153     </Member>
 154     <Member MemberName="TypeName">
 155       <MemberSignature Language="C#" Value="public string TypeName { get; }" />
 156       <MemberType>Property</MemberType>
 157       <AssemblyInfo>
 158         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 159       </AssemblyInfo>
 160       <ReturnValue>
 161         <ReturnType>System.String</ReturnType>
 162       </ReturnValue>
 163       <Docs>
 164         <value>To be added.</value>
 165         <remarks>To be added.</remarks>
 166         <summary>
 167           <attribution license="cc4" from="Microsoft" modified="false" />
 168           <para>Gets the type name specified in the current <see cref="Overload:System.Resources.ResXFileRef.#ctor" /> constructor. </para>
 169         </summary>
 170       </Docs>
 171     </Member>
 172   </Members>
 173 </Type>