WebPart.LoadResource Method
Returns a string that describes the localized name, category, and description of the specified resource.
Namespace: Microsoft.SharePoint.WebPartPages
Assembly: Microsoft.SharePoint (in Microsoft.SharePoint.dll)
Available in Sandboxed Solutions: No
Syntax
'Declaration
Public Overridable Function LoadResource ( _
id As String _
) As String
'Usage
Dim instance As WebPart
Dim id As String
Dim returnValue As String
returnValue = instance.LoadResource(id)
public virtual string LoadResource(
string id
)
Parameters
id
Type: System.StringA string that specifies the identifier for the resource.
Return Value
Type: System.String
A string that specifies the localized Name, Category, and Description property values of the resource as defined by the ResourcesAttribute of the resource.
Examples
The following code example shows a Web Part that overrides the LoadResource method. For this example to work, you must add a resource (.resx) to your assembly project. To do that in Microsoft Visual Studio 2005, right-click your assembly in Solution Explorer, point to Add, and then click Add New Item. In the Add New Item dialog box, select Assembly Resource File, and then click Open.
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
Namespace WebControlLibrary4
'/ <summary>
'/ Summary description for WPLocalizedResource.
'/ </summary>
<XmlRoot([Namespace] := "MyNamespace"), 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 'LoadResource
'----------------------RENDER------------------------------------------
Protected Overrides Sub RenderWebPart(output As HtmlTextWriter)
output.Write(("<br>Localized Resource Property Value: " + Me.MyText_Localized))
End Sub
End Class
End Namespace
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;
namespace WebControlLibrary4
{
/// <summary>
/// Summary description for WPLocalizedResource.
/// </summary>
[XmlRoot(Namespace="MyNamespace")]
[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------------------------------------------
protected override void RenderWebPart(HtmlTextWriter output)
{
output.Write("<br>Localized Resource Property Value: " + this.MyText_Localized);
}
}
}