How to: Localize a widget

Alex Crome — Sun, 28 Aug 2011 18:48:23 GMT

Current Revision posted to Telligent Evolution 5.x Developer Documentation by Alex Crome on 8/28/2011 1:48:23 PM

When you localize a widget, it pulls the language information from the language folder. If you put the language information in the Resources.xml file in the folder, then you do not have to specify which file to pull resources from in the code file. However, if you put your language specific text into a custom file, for example NewWidget_Resources.xml, then you will need to use the following procedure.

To localize a widget:

Create a resource file in the ~/Languages/{Your Language}/ folder. When you create a resource file, you ensure that it will not be overwritten. The resource file in the following example is called NewWidget.xml.

<?xml version="1.0" encoding="UTF-8" ?>

<root>
  <resource name="NewWidget_MyInfoConfigurableWidget_FragmentName">My Info 2 (From Resource File)</resource>
  <resource name="NewWidget_MyInfoConfigurableWidget_FragmentDescription">This widget displays my personal information. (Configurable)</resource>
  <resource name="NewWidget_MyInfoConfigurableWidget_Title">Widget Title</resource>
  <resource name="NewWidget_MyInfoConfigurableWidget_YourName_Title">Name</resource>
  <resource name="NewWidget_MyInfoConfigurableWidget_YourName_Default">Your Name</resource>
  <resource name="NewWidget_MyInfoConfigurableWidget_Location_Title">Location</resource>
  <resource name="NewWidget_MyInfoConfigurableWidget_Location_Default">Your Location</resource>
  <resource name="NewWidget_MyInfoConfigurableWidget_Occupation_Title">Occupation</resource>
  <resource name="NewWidget_MyInfoConfigurableWidget_Occupation_Default">Your Occupation</resource>
</root>

In the widget code file, use the CommunityServer.Components.ResourceManager class to retrieve localized strings from your Resource file (~/Languages/{your language}/{YourFile.xml}).

public override stringFragmentDescription
{
    get
    {
        CommunityServer.Components.ResourceManager.GetString(
                "NewWidget_MyInfoConfigurableWidget_FragmentDescription"
                , "NewWidget.xml");
    }
}

In the User Control section, use the <CSControl:ResourceControl.. /> to retrieve localized strings from your Resource file:

<%@ Control Language="C#"AutoEventWireup="true" %>
<div>
    <p>
        <b><CSControl:ResourceControl runat="server"ResourceName="NewWidget_MyInfoConfigurableWidget_YourName_Title" ResourceFile="NewWidget.xml" /></b>
        <cscontrol:configurablecontentfragmentdata property="Name"runat="server" />
    </p>
    <p>
        <b><CSControl:ResourceControl runat="server"ResourceName="NewWidget_MyInfoConfigurableWidget_Location_Title" ResourceFile="NewWidget.xml" /></b>
        <cscontrol:configurablecontentfragmentdata property="Location"runat="server" />
    </p>
    <p>
        <b><CSControl:ResourceControl runat="server"ResourceName="NewWidget_MyInfoConfigurableWidget_Occupation_Title" ResourceFile="NewWidget.xml" /></b>
        <cscontrol:configurablecontentfragmentdata property="Occupation"runat="server" />
    </p>
</div>

Ensure the the strings are set up in the resources.xml file. Based on the same code above, the widget may look something like this:

Tags: how to, Localization, widgets

How to: Localize a widget

Rob Howard — Thu, 14 Oct 2010 17:19:30 GMT

Revision 6 posted to Telligent Evolution 5.x Developer Documentation by Rob Howard on 10/14/2010 12:19:30 PM

To localize a widget:

Create a resource file in the ~/Languages/{Your Language}/ folder. When you create a resource file, you ensure that it will not be overwritten. The resource file in the following example is called NewWidget.xml.

<?xml version="1.0" encoding="UTF-8" ?>

<root>
  <resource name="NewWidget_MyInfoConfigurableWidget_FragmentName">My Info 2 (From Resource File)</resource>
  <resource name="NewWidget_MyInfoConfigurableWidget_FragmentDescription">This widget displays my personal information. (Configurable)</resource>
  <resource name="NewWidget_MyInfoConfigurableWidget_Title">Widget Title</resource>
  <resource name="NewWidget_MyInfoConfigurableWidget_YourName_Title">Name</resource>
  <resource name="NewWidget_MyInfoConfigurableWidget_YourName_Default">Your Name</resource>
  <resource name="NewWidget_MyInfoConfigurableWidget_Location_Title">Location</resource>
  <resource name="NewWidget_MyInfoConfigurableWidget_Location_Default">Your Location</resource>
  <resource name="NewWidget_MyInfoConfigurableWidget_Occupation_Title">Occupation</resource>
  <resource name="NewWidget_MyInfoConfigurableWidget_Occupation_Default">Your Occupation</resource>
</root>

In the widget code file, use the CommunityServer.Components.ResourceManager class to retrieve localized strings from your Resource file (~/Languages/{your language}/{YourFile.xml}).

public override stringFragmentDescription
{
    get
    {
        CommunityServer.Components.ResourceManager.GetString(
                "NewWidget_MyInfoConfigurableWidget_FragmentDescription"
                , "NewWidget.xml");
    }
}

In the User Control section, use the <CSControl:ResourceControl.. /> to retrieve localized strings from your Resource file:

<%@ Control Language="C#"AutoEventWireup="true" %>
<div>
    <p>
        <b><CSControl:ResourceControl runat="server"ResourceName="NewWidget_MyInfoConfigurableWidget_YourName_Title" ResourceFile="NewWidget.xml" /></b>
        <cscontrol:configurablecontentfragmentdata property="Name"runat="server" />
    </p>
    <p>
        <b><CSControl:ResourceControl runat="server"ResourceName="NewWidget_MyInfoConfigurableWidget_Location_Title" ResourceFile="NewWidget.xml" /></b>
        <cscontrol:configurablecontentfragmentdata property="Location"runat="server" />
    </p>
    <p>
        <b><CSControl:ResourceControl runat="server"ResourceName="NewWidget_MyInfoConfigurableWidget_Occupation_Title" ResourceFile="NewWidget.xml" /></b>
        <cscontrol:configurablecontentfragmentdata property="Occupation"runat="server" />
    </p>
</div>

Ensure the the strings are set up in the resources.xml file. Based on the same code above, the widget may look something like this:

Tags: widgets, Localization, how to

How to: Localize a widget

Rob Howard — Tue, 05 Oct 2010 17:52:11 GMT

Revision 5 posted to Telligent Evolution 5.x Developer Documentation by Rob Howard on 10/5/2010 12:52:11 PM

To localize a widget:

Create a resource file in the ~/Languages/{Your Language}/ folder. When you create a resource file, you ensure that it will not be overwritten. The resource file in the following example is called NewWidget.xml.

<?xml version="1.0" encoding="UTF-8" ?>

<root>
  <resource name="NewWidget_MyInfoConfigurableWidget_FragmentName">My Info 2 (From Resource File)</resource>
  <resource name="NewWidget_MyInfoConfigurableWidget_FragmentDescription">This widget displays my personal information. (Configurable)</resource>
  <resource name="NewWidget_MyInfoConfigurableWidget_Title">Widget Title</resource>
  <resource name="NewWidget_MyInfoConfigurableWidget_YourName_Title">Name</resource>
  <resource name="NewWidget_MyInfoConfigurableWidget_YourName_Default">Your Name</resource>
  <resource name="NewWidget_MyInfoConfigurableWidget_Location_Title">Location</resource>
  <resource name="NewWidget_MyInfoConfigurableWidget_Location_Default">Your Location</resource>
  <resource name="NewWidget_MyInfoConfigurableWidget_Occupation_Title">Occupation</resource>
  <resource name="NewWidget_MyInfoConfigurableWidget_Occupation_Default">Your Occupation</resource>
</root>

In the widget code file, use the CommunityServer.Components.ResourceManager class to retrieve localized strings from your Resource file (~/Languages/{your language}/{YourFile.xml}).

public override stringFragmentDescription
{
    get
    {
        CommunityServer.Components.ResourceManager.GetString(
                "NewWidget_MyInfoConfigurableWidget_FragmentDescription"
                , "NewWidget.xml");
    }
}

In the User Control section, use the <CSControl:ResourceControl.. /> to retrieve localized strings from your Resource file:

<%@ Control Language="C#"AutoEventWireup="true" %>
<div>
    <p>
        <b><CSControl:ResourceControl runat="server"ResourceName="NewWidget_MyInfoConfigurableWidget_YourName_Title" ResourceFile="NewWidget.xml" /></b>
        <cscontrol:configurablecontentfragmentdata property="Name"runat="server" />
    </p>
    <p>
        <b><CSControl:ResourceControl runat="server"ResourceName="NewWidget_MyInfoConfigurableWidget_Location_Title" ResourceFile="NewWidget.xml" /></b>
        <cscontrol:configurablecontentfragmentdata property="Location"runat="server" />
    </p>
    <p>
        <b><CSControl:ResourceControl runat="server"ResourceName="NewWidget_MyInfoConfigurableWidget_Occupation_Title" ResourceFile="NewWidget.xml" /></b>
        <cscontrol:configurablecontentfragmentdata property="Occupation"runat="server" />
    </p>
</div>

Ensure the the strings are set up in the resources.xml file. Based on the same code above, the widget may look something like this:

Tags: widget, localize, how to

Localize a widget

Alex Crome — Fri, 16 Apr 2010 12:07:15 GMT

Revision 4 posted to Telligent Evolution 5.x Developer Documentation by Alex Crome on 4/16/2010 7:07:15 AM

To localize a widget:

Create a resource file in the ~/Languages/{Your Language}/ folder. When you create a resource file, you ensure that it will not be overwritten. The resource file in the following example is called NewWidget.xml.

<?xml version="1.0" encoding="UTF-8" ?>

<root>
  <resource name="NewWidget_MyInfoConfigurableWidget_FragmentName">My Info 2 (From Resource File)</resource>
  <resource name="NewWidget_MyInfoConfigurableWidget_FragmentDescription">This widget displays my personal information. (Configurable)</resource>
  <resource name="NewWidget_MyInfoConfigurableWidget_Title">Widget Title</resource>
  <resource name="NewWidget_MyInfoConfigurableWidget_YourName_Title">Name</resource>
  <resource name="NewWidget_MyInfoConfigurableWidget_YourName_Default">Your Name</resource>
  <resource name="NewWidget_MyInfoConfigurableWidget_Location_Title">Location</resource>
  <resource name="NewWidget_MyInfoConfigurableWidget_Location_Default">Your Location</resource>
  <resource name="NewWidget_MyInfoConfigurableWidget_Occupation_Title">Occupation</resource>
  <resource name="NewWidget_MyInfoConfigurableWidget_Occupation_Default">Your Occupation</resource>
</root>

In the widget code file, use the CommunityServer.Components.ResourceManager class to retrieve localized strings from your Resource file (~/Languages/{your language}/{YourFile.xml}).

public override stringFragmentDescription
{
    get
    {
        CommunityServer.Components.ResourceManager.GetString(
                "NewWidget_MyInfoConfigurableWidget_FragmentDescription"
                , "NewWidget.xml");
    }
}

In the User Control section, use the <CSControl:ResourceControl.. /> to retrieve localized strings from your Resource file:

<%@ Control Language="C#"AutoEventWireup="true" %>
<div>
    <p>
        <b><CSControl:ResourceControl runat="server"ResourceName="NewWidget_MyInfoConfigurableWidget_YourName_Title" ResourceFile="NewWidget.xml" /></b>
        <cscontrol:configurablecontentfragmentdata property="Name"runat="server" />
    </p>
    <p>
        <b><CSControl:ResourceControl runat="server"ResourceName="NewWidget_MyInfoConfigurableWidget_Location_Title" ResourceFile="NewWidget.xml" /></b>
        <cscontrol:configurablecontentfragmentdata property="Location"runat="server" />
    </p>
    <p>
        <b><CSControl:ResourceControl runat="server"ResourceName="NewWidget_MyInfoConfigurableWidget_Occupation_Title" ResourceFile="NewWidget.xml" /></b>
        <cscontrol:configurablecontentfragmentdata property="Occupation"runat="server" />
    </p>
</div>

Ensure the the strings are set up in the resources.xml file. Based on the same code above, the widget may look something like this:

Tags: widget, localize

Localize a widget

Alex Crome — Thu, 10 Dec 2009 14:48:45 GMT

Revision 3 posted to Telligent Evolution 5.x Developer Documentation by Alex Crome on 12/10/2009 8:48:45 AM

To localize a widget:

Create a resource file in the ~/Languages/{Your Language}/ folder. When you create a resource file, you ensure that it will not be overwritten. The resource file in the following example is called NewWidget.xml.

<?xml version="1.0" encoding="UTF-8" ?>
<root>
  <resource name="NewWidget_MyInfoConfigurableWidget_FragmentName">My Info 2 (From Resource File)</resource>
  <resource name="NewWidget_MyInfoConfigurableWidget_FragmentDescription">This widget displays my personal information. (Configurable)</resource>
  <resource name="NewWidget_MyInfoConfigurableWidget_Title">Widget Title</resource>
  <resource name="NewWidget_MyInfoConfigurableWidget_YourName_Title">Name</resource>
  <resource name="NewWidget_MyInfoConfigurableWidget_YourName_Default">Your Name</resource>
  <resource name="NewWidget_MyInfoConfigurableWidget_Location_Title">Location</resource>
  <resource name="NewWidget_MyInfoConfigurableWidget_Location_Default">Your Location</resource>
  <resource name="NewWidget_MyInfoConfigurableWidget_Occupation_Title">Occupation</resource>
  <resource name="NewWidget_MyInfoConfigurableWidget_Occupation_Default">Your Occupation</resource>
</root>

In the widget code file, use the CommunityServer.Components.ResourceManager class to retrieve localized strings from your Resource file (~/Languages/{your language}/{YourFile.xml}).

public override stringFragmentDescription
{
    get { returnResourceManager.GetString("NewWidget_MyInfoConfigurableWidget_FragmentDescription", "NewWidget.xml"); }
}

In the User Control section, use the <CSControl:ResourceControl.. /> to retrieve localized strings from your Resource file:

<%@ Control Language="C#"AutoEventWireup="true" %>
<div>
    <p>
        <b><CSControl:ResourceControl runat="server"ResourceName="NewWidget_MyInfoConfigurableWidget_YourName_Title" ResourceFile="NewWidget.xml" /></b>
        <cscontrol:configurablecontentfragmentdata property="Name"runat="server" />
    </p>
    <p>
        <b><CSControl:ResourceControl runat="server"ResourceName="NewWidget_MyInfoConfigurableWidget_Location_Title" ResourceFile="NewWidget.xml" /></b>
        <cscontrol:configurablecontentfragmentdata property="Location"runat="server" />
    </p>
    <p>
        <b><CSControl:ResourceControl runat="server"ResourceName="NewWidget_MyInfoConfigurableWidget_Occupation_Title" ResourceFile="NewWidget.xml" /></b>
        <cscontrol:configurablecontentfragmentdata property="Occupation"runat="server" />
    </p>
</div>

Ensure the the strings are set up in the resources.xml file. Based on the same code above, the widget may look something like this:

Tags: widget, localize

Localize a widget

Alex Crome — Mon, 31 Aug 2009 10:36:57 GMT

Revision 2 posted to Telligent Evolution 5.x Developer Documentation by Alex Crome on 8/31/2009 5:36:57 AM

To localize a widget:

Create a resource file in the ~/Languages/{Your Language}/ folder. When you create a resource file, you ensure that it will not be overwritten. The resource file in the following example is called NewWidget.xml.

<?xml version="1.0" encoding="UTF-8" ?>
<root>
  <resource name="NewWidget_MyInfoConfigurableWidget_FragmentName">My Info 2 (From Resource File)</resource>
  <resource name="NewWidget_MyInfoConfigurableWidget_FragmentDescription">This widget displays my personal information. (Configurable)</resource>
  <resource name="NewWidget_MyInfoConfigurableWidget_Title">Widget Title</resource>
  <resource name="NewWidget_MyInfoConfigurableWidget_YourName_Title">Name</resource>
  <resource name="NewWidget_MyInfoConfigurableWidget_YourName_Default">Your Name</resource>
  <resource name="NewWidget_MyInfoConfigurableWidget_Location_Title">Location</resource>
  <resource name="NewWidget_MyInfoConfigurableWidget_Location_Default">Your Location</resource>
  <resource name="NewWidget_MyInfoConfigurableWidget_Occupation_Title">Occupation</resource>
  <resource name="NewWidget_MyInfoConfigurableWidget_Occupation_Default">Your Occupation</resource>
</root>

In the widget code file, use the CommunityServer.Components.ResourceManager class to retrieve localized strings from your Resource file (~/Languages/{your language}/{YourFile.xml}).

public override stringFragmentDescription
{
    get { returnResourceManager.GetString("NewWidget_MyInfoConfigurableWidget_FragmentDescription", "NewWidget.xml"); }
}

In the User Control section, use the <CSControl:ResourceControl.. /> to retrieve localized strings from your Resource file:

<%@ Control Language="C#"AutoEventWireup="true" %>
<div>
    <p>
        <b><CSControl:ResourceControl runat="server"ResourceName="NewWidget_MyInfoConfigurableWidget_YourName_Title" ResourceFile="NewWidget.xml" /></b>
        <cscontrol:configurablecontentfragmentdata property="Name"runat="server" />
    </p>
    <p>
        <b><CSControl:ResourceControl runat="server"ResourceName="NewWidget_MyInfoConfigurableWidget_Location_Title" ResourceFile="NewWidget.xml" /></b>
        <cscontrol:configurablecontentfragmentdata property="Location"runat="server" />
    </p>
    <p>
        <b><CSControl:ResourceControl runat="server"ResourceName="NewWidget_MyInfoConfigurableWidget_Occupation_Title" ResourceFile="NewWidget.xml" /></b>
        <cscontrol:configurablecontentfragmentdata property="Occupation"runat="server" />
    </p>
</div>

Ensure the the strings are set up in the resources.xml file. Based on the same code above, the widget may look something like this:

Tags: widget, localize

Localize a widget

Tim Yates — Wed, 26 Aug 2009 19:39:50 GMT

Revision 1 posted to Telligent Evolution 5.x Developer Documentation by Tim Yates on 8/26/2009 2:39:50 PM

To localize a widget:

Create a resource.xml file in the ~/Languages/{Your Language}/ folder. When you create a resource.xml file, you ensure that it will not be overwritten. The resource file in the following example is called NewWidget.xml.

<?xml version="1.0" encoding="UTF-8" ?>
<root>
  <resource name="NewWidget_MyInfoConfigurableWidget_FragmentName">My Info 2 (From Resource File)</resource>
  <resource name="NewWidget_MyInfoConfigurableWidget_FragmentDescription">This widget displays my personal information. (Configurable)</resource>
  <resource name="NewWidget_MyInfoConfigurableWidget_Title">Widget Title</resource>
  <resource name="NewWidget_MyInfoConfigurableWidget_YourName_Title">Name</resource>
  <resource name="NewWidget_MyInfoConfigurableWidget_YourName_Default">Your Name</resource>
  <resource name="NewWidget_MyInfoConfigurableWidget_Location_Title">Location</resource>
  <resource name="NewWidget_MyInfoConfigurableWidget_Location_Default">Your Location</resource>
  <resource name="NewWidget_MyInfoConfigurableWidget_Occupation_Title">Occupation</resource>
  <resource name="NewWidget_MyInfoConfigurableWidget_Occupation_Default">Your Occupation</resource>
</root>

In the widget code file, use the CommunityServer.Components.ResourceManager class to retrieve localized strings from your Resource file (~/Languages/{your language}/{YourFile.xml}).

public override stringFragmentDescription
{
    get { returnResourceManager.GetString("NewWidget_MyInfoConfigurableWidget_FragmentDescription", "NewWidget.xml"); }
}

In the User Control section, use the <CSControl:ResourceControl.. /> to retrieve localized strings from your Resource file:

<%@ Control Language="C#"AutoEventWireup="true" %>
<div>
    <p>
        <b><CSControl:ResourceControl runat="server"ResourceName="NewWidget_MyInfoConfigurableWidget_YourName_Title" ResourceFile="NewWidget.xml" /></b>
        <cscontrol:configurablecontentfragmentdata property="Name"runat="server" />
    </p>
    <p>
        <b><CSControl:ResourceControl runat="server"ResourceName="NewWidget_MyInfoConfigurableWidget_Location_Title" ResourceFile="NewWidget.xml" /></b>
        <cscontrol:configurablecontentfragmentdata property="Location"runat="server" />
    </p>
    <p>
        <b><CSControl:ResourceControl runat="server"ResourceName="NewWidget_MyInfoConfigurableWidget_Occupation_Title" ResourceFile="NewWidget.xml" /></b>
        <cscontrol:configurablecontentfragmentdata property="Occupation"runat="server" />
    </p>
</div>

Ensure the the strings are set up in the resources.xml file. Based on the same code above, the widget may look something like this:

Tags: widget, localize