SPUtility.GetLocalizedString method

發行項
05/05/2015

會從指定之語言的資源檔案擷取具名的資源字串值。

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

Syntax

'宣告
Public Shared Function GetLocalizedString ( _
    source As String, _
    defaultResourceFile As String, _
    language As UInteger _
) As String
'用途
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
)

參數

source
Type: System.String

在表單$Resources:keyname，其中keyname是名稱中的 ASP.NET 資源運算式一半的名稱/值組資源 (.resx) 檔案中。

defaultResourceFile
Type: System.String

包含當地語系化的字串值的語言資源檔基底檔案名稱。例如，如果您有一系列的資源檔名為myresources.en-us.resx、 myresources.es-es.resx、 myresources.de-de.resx，並等項目，將這個參數中傳遞的值是myresources。

language
Type: System.UInt32

目標語言的 LCID。如需清單，請參閱＜ CultureInfo類別的概觀主題。

傳回值

Type: System.String
指定之語言的字串值。如果要求的語言中找不到一個值，會傳回的值語言而異。如果語言而異的資源檔案不存在，或指定的資源名稱不存在，來源字串會傳回不當地語系化。

備註

此方法可以擷取的 string 值，從位於SharePoint Foundation安裝根目錄的正下方的 [資源] 資料夾中的資源檔案。這會將權杖該Visual Studio使用資料夾是{SharePointRoot}\Resources。完整的路徑是%ProgramFiles%\Common Files\Microsoft Shared\web server extensions\15\資源。

Examples

下列範例會為主控台應用程式，列舉網站所支援的語言。每種語言中，將應用程式會取得名為基底檔案名稱"核心""onet_TeamSite"從資源檔案之資源的值。

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