ResXResourceWriter.AddResource Method

Reference

Definition

Namespace:: System.Resources

Assembly:: System.Windows.Forms.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Adds a resource to the list of resources to write.

Overloads

AddResource(String, Object)	Adds a named resource specified as an object to the list of resources to write.
AddResource(String, String)	Adds a string resource to the resources.
AddResource(ResXDataNode)	Adds a named resource specified in a ResXDataNode object to the list of resources to write.
AddResource(String, Byte[])	Adds a named resource specified as a byte array to the list of resources to write.

AddResource(String, Object)

Source:: ResXResourceWriter.cs

Source:: ResXResourceWriter.cs

Source:: ResXResourceWriter.cs

Adds a named resource specified as an object to the list of resources to write.

public:
 virtual void AddResource(System::String ^ name, System::Object ^ value);

public void AddResource (string name, object value);

public void AddResource (string name, object? value);

abstract member AddResource : string * obj -> unit
override this.AddResource : string * obj -> unit

Public Sub AddResource (name As String, value As Object)

Parameters

name: String

The name of the resource.

value: Object

The value of the resource.

Implements

AddResource(String, Object)

Examples

The following example creates a .resx file named CarResources.resx that stores six strings, an icon, and two application-defined objects (two Automobile objects). To store the icon and the Automobile objects, it calls the AddResource(String, Object) method. Note that the Automobile class, which is defined and instantiated in the example, is tagged with the SerializableAttribute attribute.

using System;
using System.Drawing;
using System.Resources;

[Serializable()] public class Automobile
{
   private string carMake;
   private string carModel;
   private int carYear;
   private int carDoors;
   private int carCylinders;

   public Automobile(string make, string model, int year) :
                     this(make, model, year, 0, 0)
   { }

   public Automobile(string make, string model, int year,
                     int doors, int cylinders)
   {
      this.carMake = make;
      this.carModel = model;
      this.carYear = year;
      this.carDoors = doors;
      this.carCylinders = cylinders;
   }

   public string Make {
      get { return this.carMake; }
   }

   public string Model {
      get {return this.carModel; }
   }

   public int Year {
      get { return this.carYear; }
   }

   public int Doors {
      get { return this.carDoors; }
   }

   public int Cylinders {
      get { return this.carCylinders; }
   }
}

public class Example
{
   public static void Main()
   {
      // Instantiate an Automobile object.
      Automobile car1 = new Automobile("Ford", "Model N", 1906, 0, 4);
      Automobile car2 = new Automobile("Ford", "Model T", 1909, 2, 4);
      // Define a resource file named CarResources.resx.
      using (ResXResourceWriter resx = new ResXResourceWriter(@".\CarResources.resx"))
      {
         resx.AddResource("Title", "Classic American Cars");
         resx.AddResource("HeaderString1", "Make");
         resx.AddResource("HeaderString2", "Model");
         resx.AddResource("HeaderString3", "Year");
         resx.AddResource("HeaderString4", "Doors");
         resx.AddResource("HeaderString5", "Cylinders");
         resx.AddResource("Information", SystemIcons.Information);
         resx.AddResource("EarlyAuto1", car1);
         resx.AddResource("EarlyAuto2", car2);
      }
   }
}

Imports System.Drawing
Imports System.Resources

<Serializable()> Public Class Automobile
   Private carMake As String
   Private carModel As String
   Private carYear As Integer
   Private carDoors AS Integer
   Private carCylinders As Integer
   
   Public Sub New(make As String, model As String, year As Integer) 
      Me.New(make, model, year, 0, 0)   
   End Sub
   
   Public Sub New(make As String, model As String, year As Integer, 
                  doors As Integer, cylinders As Integer)
      Me.carMake = make
      Me.carModel = model
      Me.carYear = year
      Me.carDoors = doors
      Me.carCylinders = cylinders
   End Sub

   Public ReadOnly Property Make As String
      Get
         Return Me.carMake
      End Get   
   End Property       
   
   Public ReadOnly Property Model As String
      Get
         Return Me.carModel
      End Get   
   End Property       
   
   Public ReadOnly Property Year As Integer
      Get
         Return Me.carYear
      End Get   
   End Property       
   
   Public ReadOnly Property Doors As Integer
      Get
         Return Me.carDoors
      End Get   
   End Property       
   
   Public ReadOnly Property Cylinders As Integer
      Get
         Return Me.carCylinders
      End Get   
   End Property       
End Class

Module Example
   Public Sub Main()
      ' Instantiate an Automobile object.
      Dim car1 As New Automobile("Ford", "Model N", 1906, 0, 4)
      Dim car2 As New Automobile("Ford", "Model T", 1909, 2, 4)
      ' Define a resource file named CarResources.resx.
      Using resx As New ResXResourceWriter(".\CarResources.resx")
         resx.AddResource("Title", "Classic American Cars")
         resx.AddResource("HeaderString1", "Make")
         resx.AddResource("HeaderString2", "Model")
         resx.AddResource("HeaderString3", "Year")
         resx.AddResource("HeaderString4", "Doors")
         resx.AddResource("HeaderString5", "Cylinders")
         resx.AddResource("Information", SystemIcons.Information) 
         resx.AddResource("EarlyAuto1", car1)
         resx.AddResource("EarlyAuto2", car2)  
      End Using
   End Sub
End Module

Remarks

The resource is not written until Generate is called. The resource that was added must be serializable.

If the resource being added is a string, it is written as a string; otherwise, the resource is serialized and stored in a binary format.

Applies to

AddResource(String, String)

Source:: ResXResourceWriter.cs

Source:: ResXResourceWriter.cs

Source:: ResXResourceWriter.cs

Adds a string resource to the resources.

public:
 virtual void AddResource(System::String ^ name, System::String ^ value);

public void AddResource (string name, string value);

public void AddResource (string name, string? value);

abstract member AddResource : string * string -> unit
override this.AddResource : string * string -> unit

Public Sub AddResource (name As String, value As String)

Parameters

name: String

The name of the resource.

value: String

The value of the resource.

Implements

AddResource(String, String)

Examples

using System;
using System.Drawing;
using System.Resources;

[Serializable()] public class Automobile
{
   private string carMake;
   private string carModel;
   private int carYear;
   private int carDoors;
   private int carCylinders;

   public Automobile(string make, string model, int year) :
                     this(make, model, year, 0, 0)
   { }

   public Automobile(string make, string model, int year,
                     int doors, int cylinders)
   {
      this.carMake = make;
      this.carModel = model;
      this.carYear = year;
      this.carDoors = doors;
      this.carCylinders = cylinders;
   }

   public string Make {
      get { return this.carMake; }
   }

   public string Model {
      get {return this.carModel; }
   }

   public int Year {
      get { return this.carYear; }
   }

   public int Doors {
      get { return this.carDoors; }
   }

   public int Cylinders {
      get { return this.carCylinders; }
   }
}

public class Example
{
   public static void Main()
   {
      // Instantiate an Automobile object.
      Automobile car1 = new Automobile("Ford", "Model N", 1906, 0, 4);
      Automobile car2 = new Automobile("Ford", "Model T", 1909, 2, 4);
      // Define a resource file named CarResources.resx.
      using (ResXResourceWriter resx = new ResXResourceWriter(@".\CarResources.resx"))
      {
         resx.AddResource("Title", "Classic American Cars");
         resx.AddResource("HeaderString1", "Make");
         resx.AddResource("HeaderString2", "Model");
         resx.AddResource("HeaderString3", "Year");
         resx.AddResource("HeaderString4", "Doors");
         resx.AddResource("HeaderString5", "Cylinders");
         resx.AddResource("Information", SystemIcons.Information);
         resx.AddResource("EarlyAuto1", car1);
         resx.AddResource("EarlyAuto2", car2);
      }
   }
}

Imports System.Drawing
Imports System.Resources

<Serializable()> Public Class Automobile
   Private carMake As String
   Private carModel As String
   Private carYear As Integer
   Private carDoors AS Integer
   Private carCylinders As Integer
   
   Public Sub New(make As String, model As String, year As Integer) 
      Me.New(make, model, year, 0, 0)   
   End Sub
   
   Public Sub New(make As String, model As String, year As Integer, 
                  doors As Integer, cylinders As Integer)
      Me.carMake = make
      Me.carModel = model
      Me.carYear = year
      Me.carDoors = doors
      Me.carCylinders = cylinders
   End Sub

   Public ReadOnly Property Make As String
      Get
         Return Me.carMake
      End Get   
   End Property       
   
   Public ReadOnly Property Model As String
      Get
         Return Me.carModel
      End Get   
   End Property       
   
   Public ReadOnly Property Year As Integer
      Get
         Return Me.carYear
      End Get   
   End Property       
   
   Public ReadOnly Property Doors As Integer
      Get
         Return Me.carDoors
      End Get   
   End Property       
   
   Public ReadOnly Property Cylinders As Integer
      Get
         Return Me.carCylinders
      End Get   
   End Property       
End Class

Module Example
   Public Sub Main()
      ' Instantiate an Automobile object.
      Dim car1 As New Automobile("Ford", "Model N", 1906, 0, 4)
      Dim car2 As New Automobile("Ford", "Model T", 1909, 2, 4)
      ' Define a resource file named CarResources.resx.
      Using resx As New ResXResourceWriter(".\CarResources.resx")
         resx.AddResource("Title", "Classic American Cars")
         resx.AddResource("HeaderString1", "Make")
         resx.AddResource("HeaderString2", "Model")
         resx.AddResource("HeaderString3", "Year")
         resx.AddResource("HeaderString4", "Doors")
         resx.AddResource("HeaderString5", "Cylinders")
         resx.AddResource("Information", SystemIcons.Information) 
         resx.AddResource("EarlyAuto1", car1)
         resx.AddResource("EarlyAuto2", car2)  
      End Using
   End Sub
End Module

Note that the Automobile class, which is defined and instantiated in the example, is tagged with the SerializableAttribute attribute.

Remarks

The resource is not written until Generate is called.

Applies to

AddResource(ResXDataNode)

Source:: ResXResourceWriter.cs

Source:: ResXResourceWriter.cs

Source:: ResXResourceWriter.cs

Adds a named resource specified in a ResXDataNode object to the list of resources to write.

public:
 void AddResource(System::Resources::ResXDataNode ^ node);

public void AddResource (System.Resources.ResXDataNode node);

member this.AddResource : System.Resources.ResXDataNode -> unit

Public Sub AddResource (node As ResXDataNode)

Parameters

node: ResXDataNode

A ResXDataNode object that contains a resource name/value pair.

Applies to

AddResource(String, Byte[])

Source:: ResXResourceWriter.cs

Source:: ResXResourceWriter.cs

Source:: ResXResourceWriter.cs

Adds a named resource specified as a byte array to the list of resources to write.

public:
 virtual void AddResource(System::String ^ name, cli::array <System::Byte> ^ value);

public void AddResource (string name, byte[] value);

public void AddResource (string name, byte[]? value);

abstract member AddResource : string * byte[] -> unit
override this.AddResource : string * byte[] -> unit

Public Sub AddResource (name As String, value As Byte())

Parameters

name: String

The name of the resource.

value: Byte[]

The value of the resource to add as an 8-bit unsigned integer array.

Implements

AddResource(String, Byte[])

Remarks

The resource is not written until Generate is called.

The resource is serialized and stored in a binary format.

Applies to

Share via

ResXResourceWriter.AddResource Method

Definition

Overloads

AddResource(String, Object)

Parameters

Implements

Examples

Remarks

Applies to

AddResource(String, String)

Parameters

Implements

Examples

Remarks

Applies to

AddResource(ResXDataNode)

Parameters

Applies to

AddResource(String, Byte[])

Parameters

Implements

Remarks

Applies to

Additional resources