Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
ResXFileRef Class

ResXFileRef Class

Represents a link to an external resource.


Namespace:  System.Resources
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)

[PermissionSetAttribute(SecurityAction.InheritanceDemand, Name = "FullTrust")]
[PermissionSetAttribute(SecurityAction.LinkDemand, Name = "FullTrust")]
public class ResXFileRef

The ResXFileRef type exposes the following members.

Public methodResXFileRef(String, String)Creates a new instance of the ResXFileRef class that references the specified file.
Public methodResXFileRef(String, String, Encoding)Initializes a new instance of the ResXFileRef class that references the specified file.

Public propertyFileNameGets the file name specified in the current ResXFileRef constructor.
Public propertyTextFileEncodingGets the encoding specified in the current ResXFileRef constructor.
Public propertyTypeNameGets the type name specified in the current ResXFileRef constructor.

Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringGets the text representation of the current ResXFileRef object. (Overrides Object.ToString().)

The ResXFileRef class is used to include references to files in an XML resource (.resx) file. A ResXFileRef object represents a link to an external resource in an XML resource (.resx) file. You add the ResXFileRef object to a .resx file by calling the ResXResourceWriter.AddResource(ResXDataNode) method.

In a data entry in a .resx file, the type is ResXFileRef, and the value is the path location on disk. When the resource manager deserializes the object, the ResXFileRef performs the I/O to get the file. The following is an example of a .resx file.

 <data name="iconclip" type="System.Resources.ResXFileRef, System.Windows.Forms">
  <value>lookout.bmp;System.Drawing.Bitmap, System.Drawing</value>
 <data name="mailbackground" type="System.Resources.ResXFileRef, System.Windows.Forms">
  <value>mailbackground.bmp;System.Drawing.Bitmap, System.Drawing</value>
 <data name="xplogo" type="System.Resources.ResXFileRef, System.Windows.Forms">
  <value>xplogo.png;System.Drawing.Bitmap, System.Drawing</value>

To add a ResXFileRef object to a .resx file programmatically, you call the ResXDataNode.ResXDataNode(String, ResXFileRef) constructor to instantiate a ResXDataNode object. You then pass this ResXDataNode object to the ResXResourceWriter.AddResource method.

When you compile a .resx file with Resgen.exe (Resource File Generator), the resources specified in the .resx file are embedded in the resulting document resource file.

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0, 1.1

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

  • InheritanceDemand 

    for full trust for inheritors. This class cannot be inherited by partially trusted code.

  • LinkDemand 

    for full trust for the immediate caller. This class cannot be used by partially trusted code.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
© 2015 Microsoft