SPUtility.GetLocalizedString - Méthode

Article
05/12/2015

Récupère la valeur d'une chaîne de ressource nommée à partir du fichier de ressources pour une langue spécifique.

Espace de noms : Microsoft.SharePoint.Utilities
Assembly : Microsoft.SharePoint (dans Microsoft.SharePoint.dll)

Syntaxe

'Déclaration
Public Shared Function GetLocalizedString ( _
    source As String, _
    defaultResourceFile As String, _
    language As UInteger _
) As String
'Utilisation
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
)

Paramètres

source
Type : System.String

Une expression de ressource ASP.NET dans le formulaire $Resources:keyname, où keyname est le nom de la moitié d'une paire nom/valeur dans un fichier de ressources (.resx).

defaultResourceFile
Type : System.String

Le nom de fichier de base du fichier de ressources de langue qui contient une valeur de chaîne localisée. Par exemple, si vous disposez d'une série de ressources fichiers nommés myresources.en-us.resx, myresources.es-es.resx, myresources.de-de.resx, et ainsi de suite, la valeur à passer dans ce paramètre est myresources.

language
Type : System.UInt32

LCID de la langue cible. Pour une liste, consultez la rubrique de vue d'ensemble de la classe CultureInfo .

Valeur renvoyée

Type : System.String
La valeur de chaîne pour la langue spécifiée. Si une valeur ne peut pas être trouvée dans la langue demandée, la valeur de la langue indifférente est renvoyée. Si un fichier de ressources pour la langue indifférente n'existe pas ou le nom de ressource spécifié n'existe pas, la chaîne source est retournée sans localisation.

Remarques

Cette méthode peut récupérer une valeur de chaîne à partir d'un fichier de ressources que se trouve dans le dossier de ressources qui est juste en dessous de la racine d'installation SharePoint Foundation . Le jeton de ce Visual Studio utilise pour ce dossier est {SharePointRoot}\Resources. Le chemin d'accès complet est %ProgramFiles%\Common Files\Microsoft Shared\web server extensions\15\ressources.

Exemples

L'exemple suivant est une application console qui énumère les langues prises en charge par un site Web. Pour chaque langue, l'application obtient la valeur de la ressource nommée « onet_TeamSite » à partir du fichier de ressource avec le nom de fichier de base « core ».

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