SPUtility.GetLocalizedString method

Artigo
05/12/2015

Recupera o valor de uma cadeia de caracteres de recurso nomeado do arquivo de recurso para um idioma especificado.

Namespace: Microsoft.SharePoint.Utilities
Assembly: Microsoft.SharePoint (in Microsoft.SharePoint.dll)

Syntax

'Declaração
Public Shared Function GetLocalizedString ( _
    source As String, _
    defaultResourceFile As String, _
    language As UInteger _
) As String
'Uso
Dim source As String
Dim defaultResourceFile As String
Dim language As UInteger
Dim returnValue As String

returnValue = SPUtility.GetLocalizedString(source, _
    defaultResourceFile, language)

public static string GetLocalizedString(
    string source,
    string defaultResourceFile,
    uint language
)

Parâmetros

source
Type: System.String

Uma expressão de recursos do ASP.NET no formulário $Resources:keyname, onde keyname é o nome metade de um par de nome/valor em um arquivo de recurso (. resx).

defaultResourceFile
Type: System.String

O nome de arquivo base do arquivo de recurso de idioma que contém um valor de cadeia de caracteres localizada. Por exemplo, se você tiver uma série de recurso arquivos nomeados myresources.en-us.resx, myresources.es-es.resx, myresources.de-de.resxe assim por diante, o valor para passar neste parâmetro é myresources.

language
Type: System.UInt32

O LCID do idioma de destino. Para obter uma lista, consulte o tópico Visão geral para a classe CultureInfo .

Valor retornado

Type: System.String
O valor de cadeia de caracteres para o idioma especificado. Se um valor não pode ser encontrado no idioma solicitado, o valor para o idioma constante será retornado. Se não existir um arquivo de recurso para o idioma constante ou o nome do recurso especificado não existir, a cadeia de caracteres de origem será retornada sem localização.

Comentários

Esse método pode recuperar um valor de cadeia de caracteres de um arquivo de recursos localizado na pasta de recursos que é logo abaixo da raiz de instalação SharePoint Foundation. O token que Visual Studio usa para essa pasta é {SharePointRoot}\Resources. O caminho completo é %ProgramFiles%\Common Files\Microsoft Shared\web server extensions\15\ recursos.

Examples

O exemplo a seguir é um aplicativo de console que enumera os idiomas aceitos por um site da Web. Para cada idioma, o aplicativo obtém o valor para o recurso chamado "onet_TeamSite" ao arquivo de recurso com o nome de arquivo base "principal".

using System;
using System.Collections.Generic;
using System.Globalization;
using Microsoft.SharePoint;
using Microsoft.SharePoint.Utilities;

namespace ConsoleApp
{
    class Program
    {
        static void Main(string[] args)
        {
            using (SPSite site = new SPSite("https://localhost"))
            {
                using (SPWeb web = site.RootWeb)
                {
                    if (web.IsMultilingual)
                    {
                        IEnumerable<CultureInfo> cultures = web.SupportedUICultures;
                        foreach (CultureInfo culture in cultures)
                        {
                            // Print the value of a language resource in the current language.
                            string str = "$Resources:onet_TeamWebSite";
                            string locStr = SPUtility.GetLocalizedString(str, "core", (uint)culture.LCID);

                            Console.WriteLine("{0}  {1}", culture.Name, locStr);
                        }
                    }
                }
            }
            Console.Write("\nPress ENTER to continue....");
            Console.ReadLine();
        }
    }
}

Imports System
Imports System.Collections.Generic
Imports System.Globalization
Imports Microsoft.SharePoint
Imports Microsoft.SharePoint.Utilities

Module ConsoleApp

    Sub Main()

        Using site As New SPSite("https://localhost")
            Using web As SPWeb = site.RootWeb

                Dim cultures As IEnumerable(Of CultureInfo) = web.SupportedUICultures
                For Each culture As CultureInfo In cultures

                    ' Print the value of a language resource in the current language.
                    Dim str As String = "$Resources:onet_TeamWebSite"
                    Dim locStr As String = SPUtility.GetLocalizedString(str, "core", CUInt(culture.LCID))

                    Console.WriteLine("{0}  {1}", culture.Name, locStr)

                Next

            End Using
        End Using

        Console.Write(vbCrLf & "Press ENTER to continue....")
        Console.Read()
    End Sub

End Module