Creare i file di risorse per le app .NET

È possibile includere risorse, ad esempio stringhe, immagini o dati di oggetti, all'interno di file di risorse per renderli facilmente disponibili per l'applicazione. In .NET Framework è possibile creare file di risorse in cinque modi diversi:

  • Creare un file di testo contenente risorse stringa. È possibile usare generatore di file di risorse (resgen.exe) per convertire il file di testo in un file di risorse binario (con estensione resources). È quindi possibile incorporare il file di risorse binario in un file eseguibile dell'applicazione o in una libreria di applicazioni usando un compilatore di linguaggio oppure incorporarlo in un assembly satellite usando Assembly Linker (Al.exe). Per altre informazioni, vedere la sezione Risorse nei file di testo.

  • Creare un file di risorse XML con estensione resx contenente stringhe, immagini o dati di oggetto. È possibile usare generatore di file di risorse (resgen.exe) per convertire il file con estensione resx in un file di risorse binario (con estensione resources). È quindi possibile incorporare il file di risorse binario in un file eseguibile o in una libreria dell'applicazione tramite un compilatore del linguaggio. In alternativa, è possibile incorporare il file di risorse in un assembly satellite tramite Assembly Linker (Al.exe). Per altre informazioni, vedere la sezione Risorse nei file con estensione resx.

  • Creare un file di risorse XML con estensione resx a livello di codice usando tipi nello spazio dei nomi System.Resources. È possibile creare un file con estensione resx, enumerarne le risorse e recuperare risorse specifiche in base al nome. Per altre informazioni, vedere Uso dei file RESX a livello di codice.

  • Creare un file di risorse binario con estensione resources a livello di codice. È quindi possibile incorporare il file in un file eseguibile o in una libreria dell'applicazione tramite un compilatore del linguaggio. In alternativa, è possibile incorporare il file di risorse in un assembly satellite tramite Assembly Linker (Al.exe). Per altre informazioni, vedere la sezione Risorse in file con estensione resources.

  • Usare Visual Studio per creare un file di risorse e includerlo nel progetto. Visual Studio è dotato di un editor di risorse che consente di aggiungere, eliminare e modificare risorse. In fase di compilazione il file di risorse viene automaticamente convertito in un file binario con estensione resources e incorporato in un assembly dell'applicazione o in un assembly satellite. Per altre informazioni, vedere la sezione File di risorse in Visual Studio.

Risorse in file di testo

È possibile usare file di testo (con estensione txt o restext) per archiviare solo risorse stringa. Per le risorse non di tipo stringa, usare file con estensione resx o crearle a livello di codice. I file di testo che contengono risorse stringa hanno il formato seguente:

# This is an optional comment.
name = value

; This is another optional comment.
name = value

; The following supports conditional compilation if X is defined.
#ifdef X
name1=value1
name2=value2
#endif

# The following supports conditional compilation if Y is undefined.
#if !Y
name1=value1
name2=value2
#endif

Il formato dei file di risorse con estensione txt e restext è identico. L'estensione restext serve semplicemente a rendere immediatamente identificabili i file di testo come file di risorse basati su testo.

Le risorse stringa sono visualizzate come coppie name/value, dove name è una stringa che identifica la risorsa e value è la stringa di risorsa che viene restituita quando si passa name a un metodo di recupero quale ResourceManager.GetString. name e value devono essere separati da un segno di uguale (=). Ad esempio:

FileMenuName=File
EditMenuName=Edit
ViewMenuName=View
HelpMenuName=Help

Attenzione

Non usare file di risorse per archiviare password, informazioni sensibili per la sicurezza o dati personali.

Stringhe vuote, ovvero risorse il cui valore è String.Empty, sono consentite nei file di testo. Ad esempio:

EmptyString=

A partire da .NET Framework 4.5 e in tutte le versioni di .NET Core, i file di testo supportano la compilazione condizionale con i costrutti #ifdef symbol... #endif e symbol ... #if ! #endif . È quindi possibile usare /define l'opzione con generatore di file di risorse ( resgen.exe) per definire i simboli. Ogni risorsa richiede il proprio #ifdef costrutto simbolo... #endif o simbolo #if ! #endif . Se si usa un'istruzione #ifdef e simbolo è definito, la risorsa associata è inclusa nel file con estensione resources. In caso contrario, non è inclusa. Se si usa un'istruzione #if ! e simbolo non è definito, la risorsa associata è inclusa nel file con estensione resources. In caso contrario, non è inclusa.

Nei file di testo i commenti sono facoltativi e sono preceduti da un punto e virgola (;) o da un segno di cancelletto (#) all'inizio della riga. Le righe che contengono i commenti possono trovarsi in qualsiasi punto del file. I commenti non vengono inclusi in un file con estensione resources compilato creato tramite il generatore di file di risorse (resgen.exe).

Eventuali righe vuote nel file di testo sono considerate spazi e vengono ignorate.

Nell'esempio seguente sono definite due risorse stringa denominate OKButton e CancelButton.

#Define resources for buttons in the user interface.
OKButton=OK
CancelButton=Cancel

Se il file di testo contiene occorrenze duplicate del nome , generatore di file di risorse (resgen.exe) visualizza un avviso e ignora il secondo nome.

value non può contenere caratteri di nuova riga, ma è possibile usare caratteri di escape in stile linguaggio C, ad esempio per rappresentare una nuova riga \n e per rappresentare una \t scheda. È anche possibile includere un carattere barra rovesciata se è preceduto da caratteri di escape (ad esempio, " \ \ "). Sono anche consentite le stringhe vuote.

Salvare le risorse in formato file di testo usando la codifica UTF-8 o utf-16 in ordine di byte little-endian o big-endian. Tuttavia, il generatore di file di risorse (resgen.exe),che converte un file .txt in un file con estensione resources, considera i file come UTF-8 per impostazione predefinita. Se si vuole che Resgen.exe riconosca un file come salvato con la codifica UTF-16, è necessario includere un byte order mark Unicode (U + FEFF) all'inizio del file.

Per incorporare un file di risorse in formato testo in un assembly .NET, è necessario convertirlo in un file di risorse binario (con estensione resources) usando il generatore di file di risorse (resgen.exe). È quindi possibile incorporare il file con estensione resources in un assembly .NET tramite un compilatore del linguaggio. In alternativa, è possibile incorporare il file in un assembly satellite tramite Assembly Linker (Al.exe).

Nell'esempio seguente viene usato un file di risorse in formato testo denominato GreetingResources.txt per un'applicazione console "Hello World" semplice. Il file di testo definisce due stringhe, e , che richiede all'utente di prompt immettere il nome e visualizzare un messaggio di greeting saluto.

# GreetingResources.txt
# A resource file in text format for a "Hello World" application.
#
# Initial prompt to the user.
prompt=Enter your name:
# Format string to display the result.
greeting=Hello, {0}!

Il file di testo viene convertito in un file con estensione resources tramite il comando seguente:

resgen GreetingResources.txt

Nell'esempio seguente viene illustrato il codice sorgente per un'applicazione console che usa il file con estensione resources per visualizzare messaggi per l'utente.

using System;
using System.Reflection;
using System.Resources;

public class Example
{
   public static void Main()
   {
      ResourceManager rm = new ResourceManager("GreetingResources",
                               typeof(Example).Assembly);
      Console.Write(rm.GetString("prompt"));
      string name = Console.ReadLine();
      Console.WriteLine(rm.GetString("greeting"), name);
   }
}
// The example displays output like the following:
//       Enter your name: Wilberforce
//       Hello, Wilberforce!
Imports System.Reflection
Imports System.Resources

Module Example
    Public Sub Main()
        Dim rm As New ResourceManager("GreetingResources",
                                      GetType(Example).Assembly())
        Console.Write(rm.GetString("prompt"))
        Dim name As String = Console.ReadLine()
        Console.WriteLine(rm.GetString("greeting"), name)
    End Sub
End Module
' The example displays output like the following:
'       Enter your name: Wilberforce
'       Hello, Wilberforce!

Se si usa Visual Basic e il file di codice sorgente è denominato Greeting.vb, il comando seguente crea un file eseguibile che include il file con estensione resources incorporato:

vbc greeting.vb -resource:GreetingResources.resources

Se si usa C# e il file di codice sorgente è denominato Greeting.cs, il comando seguente crea un file eseguibile che include il file con estensione resources incorporato:

csc greeting.cs -resource:GreetingResources.resources

Risorse nei file con estensione resx

A differenza dei file di testo, che possono archiviare solo risorse stringa, i file di risorse XML con estensione resx possono archiviare stringhe, dati binari quali immagini, icone e clip audio e oggetti a livello di codice. Un file con estensione resx contiene un'intestazione standard che descrive il formato delle voci di risorsa e specifica le informazioni del controllo delle versioni per l'XML usato per l'analisi dei dati. I dati del file di risorse seguono l'intestazione XML. Ogni elemento di dati è costituito da una coppia nome/valore contenuta in un tag data. Il relativo attributo name definisce il nome della risorsa e il tag value annidato contiene il valore della risorsa stessa. Per i dati di tipo stringa, il tag value contiene la stringa.

Il tag data seguente, ad esempio, definisce una risorsa stringa denominata prompt il cui valore è "Enter your name:".

<data name="prompt" xml:space="preserve">
  <value>Enter your name:</value>
</data>

Avviso

Non usare file di risorse per archiviare password, informazioni sensibili per la sicurezza o dati personali.

Per gli oggetti risorsa, il tag dati include un attributo type che indica il tipo di dati della risorsa. Per gli oggetti costituiti da dati binari, il tag data include anche un attributo mimetype, che indica il tipo base64 dei dati binari.

Nota

Tutti i file con estensione resx usano un formattatore di serializzazione binario per generare e analizzare i dati binari relativi a un tipo specifico. Di conseguenza, un file con estensione resx può perdere di validità se il formato di serializzazione binario di un oggetto diventa incompatibile.

Nell'esempio seguente viene illustrata una parte di un file con estensione resx che include una risorsa Int32 e un'immagine bitmap.

<data name="i1" type="System.Int32, mscorlib">
  <value>20</value>
</data>

<data name="flag" type="System.Drawing.Bitmap, System.Drawing,
    Version=1.0.5000.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a"
    mimetype="application/x-microsoft.net.object.bytearray.base64">
  <value>
    AAEAAAD/////AQAAAAAAAAAMAgAAADtTeX…
  </value>
</data>

Importante

Poiché i file con estensione resx devono essere costituiti da codice XML ben formato in un formato predefinito, non è consigliabile usare i file con estensione resx manualmente, specialmente se tali file contengono risorse diverse da stringhe. Visual Studio offre invece un'interfaccia trasparente per la creazione e la modifica di file con estensione resx. Per altre informazioni, vedere la sezione File di risorse in Visual Studio. È anche possibile creare e modificare i file con estensione resx a livello di codice. Per altre informazioni, vedere Usare i file con estensione resx a livello di codice.

Risorse nei file con estensione resources

È possibile usare la classe System.Resources.ResourceWriter per creare a livello di codice un file di risorse binario con estensione resources direttamente dal codice. È anche possibile usare generatore di file di risorse (resgen.exe) per creare un file con estensione resources da un file di testo o da un file con estensione resx. Oltre a dati di tipo stringa, il file con estensione resources può contenere dati binari (matrici di byte) e dati di oggetto. Per creare un file con estensione resources a livello di codice è necessaria la procedura seguente:

  1. Creare un oggetto ResourceWriter con un nome file univoco. A tale scopo, specificare un nome file o un flusso di file per un costruttore della classe ResourceWriter.

  2. Chiamare uno degli overload del metodo ResourceWriter.AddResource per ogni risorsa denominata da aggiungere al file. La risorsa può essere una stringa, un oggetto o una raccolta di dati binari (una matrice di byte).

  3. Chiamare il metodo ResourceWriter.Close per scrivere le risorse nel file e chiudere l'oggetto ResourceWriter.

Nota

Non usare file di risorse per archiviare password, informazioni sensibili per la sicurezza o dati personali.

Nell'esempio seguente viene creato a livello di codice un file con estensione resources denominato CarResources.resources contenente sei stringhe, un'icona e due oggetti definiti dall'applicazione, ovvero due oggetti Automobile. La classe , definita e di cui viene creata un'istanza nell'esempio, viene contrassegnata con l'attributo , che consente di rendere persistente la classe dal formattatore Automobile SerializableAttribute di serializzazione binaria.

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 (ResourceWriter rw = new ResourceWriter(@".\CarResources.resources"))
      {
         rw.AddResource("Title", "Classic American Cars");
         rw.AddResource("HeaderString1", "Make");
         rw.AddResource("HeaderString2", "Model");
         rw.AddResource("HeaderString3", "Year");
         rw.AddResource("HeaderString4", "Doors");
         rw.AddResource("HeaderString5", "Cylinders");
         rw.AddResource("Information", SystemIcons.Information);
         rw.AddResource("EarlyAuto1", car1);
         rw.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 rw As New ResourceWriter(".\CarResources.resources")
            rw.AddResource("Title", "Classic American Cars")
            rw.AddResource("HeaderString1", "Make")
            rw.AddResource("HeaderString2", "Model")
            rw.AddResource("HeaderString3", "Year")
            rw.AddResource("HeaderString4", "Doors")
            rw.AddResource("HeaderString5", "Cylinders")
            rw.AddResource("Information", SystemIcons.Information)
            rw.AddResource("EarlyAuto1", car1)
            rw.AddResource("EarlyAuto2", car2)
        End Using
    End Sub
End Module

Dopo aver creato il file con estensione resources, è possibile incorporarlo in un eseguibile di runtime o in una libreria, includendo l'opzione /resource del compilatore del linguaggio, oppure in un assembly satellite tramite Assembly Linker (Al.exe).

File di risorse in Visual Studio

Quando si aggiunge un file di risorse a un progetto di Visual Studio, Visual Studio crea un file con estensione resx nella directory del progetto. In Visual Studio sono disponibili editor di risorse che consentono di aggiungere stringhe, immagini e oggetti binari. Poiché gli editor vengono progettati per gestire solo dati statici, non possono essere usati per archiviare oggetti a livello di codice, ma è necessario scrivere i dati degli oggetti in un file con estensione resx o resources a livello di codice. Per altre informazioni, vedere Usare i file con estensione resx a livello di codice e la sezione Risorse nei file con estensione resources.

Se si aggiungono risorse localizzate, assegnarvi lo stesso nome di file radice del file di risorse principale. È necessario designare anche le impostazioni cultura nel nome del file. Se ad esempio si aggiunge un file di risorse denominato Resources.resx, è possibile creare anche file di risorse denominati Resources.en-US.resx e Resources.fr-FR.resx per le risorse localizzate rispettivamente per le impostazioni cultura inglesi (Stati Uniti) e francesi (Francia). È necessario designare anche le impostazioni cultura predefinite dell'applicazione. Si tratta delle impostazioni cultura di cui si usano le risorse se non è possibile trovare le risorse localizzate per impostazioni cultura particolari. Per specificare le impostazioni cultura predefinite, in Esplora soluzioni in Visual Studio fare clic con il pulsante destro del mouse sul nome del progetto, scegliere Applicazione, fare clic su Informazioni assembly e selezionare la lingua e le impostazioni cultura appropriate nell'elenco Lingua neutra.

In fase di compilazione, Visual Studio prima converte i file con estensione resx di un progetto in file di risorse binari con estensione resources e li archivia in una sottodirectory della directory obj del progetto. Visual Studio incorpora ogni file di risorse che non contiene risorse localizzate nell'assembly principale generato dal progetto. Se tutti i file di risorse contengono risorse localizzate, Visual Studio li incorpora in assembly satellite separati per ognuna delle impostazioni cultura localizzate e archivia quindi ogni assembly satellite in una directory il cui nome corrisponde alle impostazioni cultura localizzate. Ad esempio, le risorse localizzate per l'inglese (Stati Uniti) vengono archiviate in un assembly satellite nella sottodirectory en-US.

Vedi anche