ResourceManager.GetString Method (String, CultureInfo)

Gets the value of the String resource localized for the specified culture.

Namespace:  System.Resources
Assembly:  mscorlib (in mscorlib.dll)

Syntax

'Declaration
Public Overridable Function GetString ( _
    name As String, _
    culture As CultureInfo _
) As String
public virtual string GetString(
    string name,
    CultureInfo culture
)

Parameters

  • culture
    Type: System.Globalization.CultureInfo
    The culture for which the resource is localized. Note that if the resource is not localized for this culture, the lookup will fall back using the culture's Parent property, stopping after looking in the neutral culture.
    If this value is nulla null reference (Nothing in Visual Basic), the CultureInfo is obtained using the culture's CurrentUICulture property.

Return Value

Type: System.String
The value of the resource localized for the specified culture. If a best match is not possible, nulla null reference (Nothing in Visual Basic) is returned.

Exceptions

Exception Condition
ArgumentNullException

The name parameter is nulla null reference (Nothing in Visual Basic).

InvalidOperationException

The value of the specified resource is not a String.

MissingManifestResourceException

No usable set of resources has been found, and there are no neutral culture resources.

Remarks

If the resource has not been localized for that culture, the resource that is returned is localized for a best match (this is accomplished using the culture's Parent property). Otherwise, nulla null reference (Nothing in Visual Basic) is returned.

If no usable set of resources has been found, the ResourceManager falls back on the neutral culture's resources, which are expected to be in the main assembly. If an appropriate culture resource has not been found, a MissingManifestResourceException is thrown.

For more information about how resources are found, see Localizing Silverlight-based Applications.

NoteNote:

The GetString method is thread-safe.

Caution noteCaution:

This method can throw more exceptions than are listed. One reason this might occur is if a method that this method calls throws an exception. For example, a FileLoadException might be thrown if an error was made deploying or installing a satellite assembly.

Examples

The following code example gets a string resource using the specified culture.

Imports System.Globalization
Imports System.Threading
Imports System.Resources
Imports System.Reflection

Class Example

   Public Shared Sub Demo(ByVal outputBlock As System.Windows.Controls.TextBlock)
      ' Create a resource manager to retrieve resources.
      Dim rm As New ResourceManager("items", _
         [Assembly].GetExecutingAssembly())

      ' Get the culture of the currently executing thread.
      ' The value of ci will determine the culture of
      ' the resources that the resource manager retrieves.
      Dim ci As CultureInfo = Thread.CurrentThread.CurrentCulture

      ' Retrieve the value of the string resource named 
      ' "welcome" localized for the culture specified by ci.
      Dim str As [String] = rm.GetString("welcome", ci)
      outputBlock.Text &= str & vbCrLf
   End Sub
End Class
using System;
using System.Globalization;
using System.Threading;
using System.Resources;
using System.Reflection;

class Example
{
   public static void Demo(System.Windows.Controls.TextBlock outputBlock)
   {
      // Create a resource manager to retrieve resources.
      ResourceManager rm = new ResourceManager("items",
         Assembly.GetExecutingAssembly());

      // Get the culture of the currently executing thread.
      // The value of ci will determine the culture of
      // the resources that the resource manager retrieves.
      CultureInfo ci = Thread.CurrentThread.CurrentCulture;

      // Retrieve the value of the string resource named 
      // "welcome", localized for the culture specified by ci.
      String str = rm.GetString("welcome", ci);
      outputBlock.Text += str + "\n";
   }
}

Version Information

Silverlight

Supported in: 5, 4, 3

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0

XNA Framework

Supported in: Xbox 360, Windows Phone OS 7.0

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.