Поделиться через


Класс ResourcesAttribute

Производные от Object.Attribute и определяет, как должно быть локализовано свойство.

Иерархия наследования

System.Object
  System.Attribute
    Microsoft.SharePoint.WebPartPages.ResourcesAttribute

Пространство имен:  Microsoft.SharePoint.WebPartPages
Сборка:  Microsoft.SharePoint (в Microsoft.SharePoint.dll)

Синтаксис

'Декларация
<AttributeUsageAttribute(AttributeTargets.Property Or AttributeTargets.Field)> _
<AspNetHostingPermissionAttribute(SecurityAction.LinkDemand, Level := AspNetHostingPermissionLevel.Minimal)> _
Public NotInheritable Class ResourcesAttribute _
    Inherits Attribute
'Применение
Dim instance As ResourcesAttribute
[AttributeUsageAttribute(AttributeTargets.Property|AttributeTargets.Field)]
[AspNetHostingPermissionAttribute(SecurityAction.LinkDemand, Level = AspNetHostingPermissionLevel.Minimal)]
public sealed class ResourcesAttribute : Attribute

Замечания

Во время выполнения для класса ResourcesAttribute выглядит CustomPropertyToolPart . Если найдено, CustomPropertyToolPart проходит через метод LoadResource (необходимо переопределить этот метод) с использованием значений ресурса из ResourcesAttribute. Если ресурс не найден, CustomPropertyToolPart пользовательский интерфейс создается со значениями по умолчанию. В противном случае CustomPropertyToolPart пользовательский интерфейс создается с локализованными значениями. Microsoft платформа.NET Framework предоставляет значения локализации подпись свойства, описания и метка категории. Имя базового свойства не будет локализовано. Если не определен класс ResourcesAttribute , CustomPropertyToolPart пользовательский интерфейс будет восстановлено нелокализованное метаданных (то есть, CategoryAttribute, DescriptionAttribute, FriendlyNameAttributeи внутреннее имя свойства).

Примеры

В следующем примере кода показано, как локализовать пользовательские свойства при отображении пользовательского интерфейса CustomPropertyToolPart .

'----------------------------------------------------------------------
'
' Code Summary: How to localize your custom property when displayed in the Property Grid. 
' FriendlyName, Description, and Category are localized.
'----------------------------------------------------------------------
Imports System
Imports System.IO
Imports System.Web.UI
Imports System.Web.UI.WebControls
Imports System.ComponentModel
Imports Microsoft.SharePoint.WebPartPages
Imports Microsoft.SharePoint
Imports System.Xml.Serialization
Imports System.Collections.Specialized
Imports System.Collections
Imports System.Resources
Imports System.Reflection
Imports System.Drawing
Imports System.Globalization
Imports System.Runtime.InteropServices

Namespace WebControlLibrary4
   '/ <summary>
   '/ Summary description for WPLocalizedResource.
   '/ </summary>
   <GuidAttribute("9ED54F84-A89D-4fcd-A854-44251E925C55"), 
      XmlRoot([Namespace] := "foo"), 
      ToolboxData("<{0}:WPLocalizedResource 
      runat=server></{0}:WPLocalizedResource>")>  _
   Public Class WPLocalizedResource
      Inherits Microsoft.SharePoint.WebPartPages.WebPart
      
      Private Const c_MyText_Localized As String = "My Localized Property"
      Private _myText_Localized As String
      
      Public Sub New()
         _myText_Localized = c_MyText_Localized
      End Sub
      
      'RESOURCES LOCALIZATION
      'Property that is localized. Use the ResourceAttibute.
      '[ResourcesAttribute (PropertyNameID=1, CategoryID=2, DescriptionID=3)]
      
      <ResourcesAttribute("1", "2", "3"), Category("Cool Properties"), 
         DefaultValue(c_MyText_Localized), 
         WebPartStorage(Storage.Personal), 
         FriendlyNameAttribute("My Text Localized"), 
         Description("MyText Localized")>  _
      Public Property MyText_Localized() As String
         Get
            Return _myText_Localized
         End Get
         Set
            _myText_Localized = value
         End Set
      End Property
      
      Public Overrides Function LoadResource(myID As String) As String
         Dim rm As New ResourceManager("WebControlLibrary4.Resource1", 
            [Assembly].GetExecutingAssembly())
         Return rm.GetString(myID)
      End Function
            
      'RENDER THE WEBPART
      Protected Overrides Sub RenderWebPart(output As HtmlTextWriter)
         output.Write(("<br>Localized Resource Property Value: " + 
            Me.MyText_Localized))
      End Sub
   End Class
End Namespace
//---------------------------------------------------------------------
//
// Code Summary: How to localize your custom property when displayed in the Property Grid. 
// FriendlyName, Description, and Category are localized.
//---------------------------------------------------------------------

using System;
using System.IO;
using System.Web.UI;
using System.Web.UI.WebControls;
using System.ComponentModel;
using Microsoft.SharePoint.WebPartPages;
using Microsoft.SharePoint;
using System.Xml.Serialization;
using System.Collections.Specialized;
using System.Collections;
using System.Resources;
using System.Reflection;
using System.Drawing;
using System.Globalization;
using System.Runtime.InteropServices;

namespace WebControlLibrary4
{
    /// <summary>
    /// Summary description for WPLocalizedResource.
    /// </summary>
    [GuidAttribute("9ED54F84-A89D-4fcd-A854-44251E925C55")]
    [XmlRoot(Namespace="foo")]
    [ToolboxData("<{0}:WPLocalizedResource 
        runat=server></{0}:WPLocalizedResource>")]
    public class WPLocalizedResource : 
        Microsoft.SharePoint.WebPartPages.WebPart
    {

        const string c_MyText_Localized = "My Localized Property";
        private string _myText_Localized;

        public WPLocalizedResource() 
        {
            _myText_Localized = c_MyText_Localized;
        }

        //RESOURCES LOCALIZATION
        //Property that is localized. Use the ResourceAttibute.
        //[ResourcesAttribute (PropertyNameID=1, CategoryID=2, DescriptionID=3)]
        [ResourcesAttribute ("1","2","3")]
        [Category("Cool Properties")]
        [DefaultValue(c_MyText_Localized), 
            WebPartStorage(Storage.Personal)]
        [FriendlyNameAttribute("My Text Localized"), 
            Description("MyText Localized")]
        public string MyText_Localized
        {
            get
            {
                return _myText_Localized;
            }
            set
            {
                _myText_Localized = value;
            }
        }
        public override string LoadResource (string myID)
        {
            ResourceManager rm = new ResourceManager
                ("WebControlLibrary4.Resource1",
                Assembly.GetExecutingAssembly());
            return rm.GetString(myID);
        }
            
        //RENDER THE WEBPART
        protected override void RenderWebPart(HtmlTextWriter output)
        {
            output.Write("<br>Localized Resource Property Value: " + 
                this.MyText_Localized);
        }
    }
}

Потокобезопасность

Любые общедоступные элементы static (Shared в Visual Basic) этого типа являются потокобезопасными. Не гарантируется, что любые элементы экземпляров потокобезопасны.

См. также

Справочные материалы

Элементы ResourcesAttribute

Пространство имен Microsoft.SharePoint.WebPartPages