Adding and Using a Custom Resource File

This topic takes a look at adding a custom resource file.

Two things are needed:

• An embedded resource (*.resx) file
• A ClientResources link in the namespace

Adding a resource file

1. Create an embedded resources file (in this example we have named the file Resources.resx)
   
   The name of the resource file should NOT contain characters like [. , ' ;] e.g: My.Resource.resx as these cause issues with how the resource file is mapped.
2. Edit the Resources file by adding the Welcome Message values as shown in the image below:
   
3. By default resource files (.resx) are already embedded, so we do not have to adjust that property.
4. Add a ClientResource definition to the namespace using the fully qualified name, as demonstrated in the sample code displayed below:
   
   Copy

   Adding a ClientResource definition

   1
   2
   3
   4
   5
   6
   7
   8
   9
   10
   11
   12
   13
   14
   15
   16
   17
   18
   19
   20
   21
   22
   23
   24
   25
   26
   27
   28
   29
   30
   using System;
   using System.Collections.Generic;
   using System.Linq;
   using System.Text;
   using System.Web;
   using System.Web.UI;
   using System.Web.UI.WebControls;
   
   // SourceCode namespaces used in the control
   using SourceCode.Forms.Controls.Web.SDK;
   using SourceCode.Forms.Controls.Web.SDK.Attributes;
   
   
   namespace SmartForms.CustomControls
   {
       //Link to the definition file
       [ControlTypeDefinition("CustomControlResource.Definition.xml")]
       public class ControlUsingResource : BaseControl
       {
           protected override void CreateChildControls()
           {
               Label label1 = new Label();
   
               // You will need to create an embedded resource file (in this example we have named the file Resource.resx)
               label1.Text = Resource.welcome;
               this.Controls.Add(label1);
           }
       }
   }
   

5. Build the modified custom control.
6. Register the control using the controlutil.exe 
7. Use the control on a View and run the view to see the welcome text as defined in the embedded Resource file