Clase SPUserResource

Artículo
05/13/2015

Representa un recurso localizable definidas por el usuario.

Jerarquía de la herencia

System.Object
Microsoft.SharePoint.SPUserResource

Espacio de nombres: Microsoft.SharePoint
Ensamblado: Microsoft.SharePoint (en Microsoft.SharePoint.dll)

Sintaxis

'Declaración
Public NotInheritable Class SPUserResource
'Uso
Dim instance As SPUserResource

public sealed class SPUserResource

Comentarios

Un recurso de usuario es una cadena que contiene el texto que se usa en la interfaz de usuario multilingüe (MUI). Por ejemplo, un recurso podría representar la descripción de un sitio Web. En este caso, un objeto único SPUserResource que representa la descripción va a contener texto utilizado para cada una de las referencias culturales compatibles con el sitio Web.

Cuando se crea un nuevo recurso, es el texto de todas las referencias culturales en el idioma predeterminado del sitio Web. Posteriormente, una persona puede traducir el texto de una referencia cultural determinada y agregar la traducción al recurso, reemplazando el texto sin traducir. Una manera de hacerlo es establecer la propiedad Thread.CurrentUICulture del subproceso en ejecución actualmente en la referencia cultural deseada y, a continuación, establece la recursos propiedad del objeto Value en la cadena localizada. Otra técnica consiste en llamar al método SetValueForUICulture , que especifica la referencia cultural y el valor localizado.

Ejemplos

En el siguiente ejemplo es una aplicación de consola que imprima los datos desde el objeto SPUserResource devuelto por la propiedad TitleResource de un objeto SPWeb . En primer lugar, la aplicación imprime el nombre del idioma asociado con el subproceso en ejecución y el correspondiente valor de recurso. A continuación, se imprime el nombre del idioma predeterminado para el sitio Web y su correspondiente valor de recurso. Por último, si está habilitada la interfaz de usuario multilingüe para el sitio Web, la aplicación imprime los nombres y valores de recursos para cada idioma alternativo que admite el sitio.

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

namespace ConsoleApp
{
    class Program
    {
        static void Main(string[] args)
        {
            using (SPSite site = new SPSite("https://localhost"))
            {
                using (SPWeb web = site.RootWeb)
                {
                    // Get the user resource for the Web site's title.
                    SPUserResource resource = web.TitleResource;

                    string format = "Language: {0} | Value: {1}";

                    // Display the value of the resource in the language of the current thread.
                    Console.WriteLine("Current Thread");
                    Console.WriteLine(format, CultureInfo.CurrentCulture.Name, resource.Value);

                    // Display the value for the default language.
                    CultureInfo uiDefault = web.UICulture;
                    Console.WriteLine("\nWeb Site Default");
                    Console.WriteLine(format, uiDefault.Name, resource.GetValueForUICulture(uiDefault));

                    if (web.IsMultilingual)
                    {
                        // Display the value of the resource for each supported language.
                        Console.WriteLine("\nAlternate Languages");

                        IEnumerable<CultureInfo> cultures = web.SupportedUICultures;
                        foreach (CultureInfo culture in cultures)
                        {
                            if (culture.LCID == uiDefault.LCID)
                                continue;

                            string value = resource.GetValueForUICulture(culture);
                            Console.WriteLine(format, culture.Name, value);
                        }
                    }
                    else
                    {
                        Console.WriteLine("\nMUI is not enabled.");
                    }
                }
            }
            Console.Write("\nPress ENTER to continue....");
            Console.Read();
        }
    }
}

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

Module ConsoleApp

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

                ' Get the user resource for the Web site's title.
                Dim resource As SPUserResource = web.TitleResource

                Dim format As String = "Language: {0} | Value: {1}"

                ' Display the value of the resource in the language of the current thread.
                Console.WriteLine("Current Thread")
                Console.WriteLine(format, CultureInfo.CurrentCulture.Name, resource.Value)

                ' Display the value for the default language.
                Dim uiDefault As CultureInfo = web.UICulture
                Console.WriteLine(vbLf & "Web Site Default")
                Console.WriteLine(format, uiDefault.Name, resource.GetValueForUICulture(uiDefault))

                If web.IsMultilingual Then
                    ' Display the value of the resource for each supported language.
                    Console.WriteLine(vbLf & "Alternate Languages")

                    Dim cultures As IEnumerable(Of CultureInfo) = web.SupportedUICultures
                    For Each culture As CultureInfo In cultures
                        If culture.LCID = uiDefault.LCID Then
                            Continue For
                        End If

                        Dim value As String = resource.GetValueForUICulture(culture)
                        Console.WriteLine(format, culture.Name, value)
                    Next
                Else
                    Console.WriteLine(vbLf & "MUI is not enabled.")
                End If

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

Seguridad para subprocesos

Los miembros static (Shared en Visual Basic) públicos de este tipo son seguros para subprocesos. No se garantiza que los miembros de instancias sean seguros para los subprocesos.