TemplateControl.GetLocalResourceObject Method

Definition

Gets a page-level resource.

Overloads

GetLocalResourceObject(String)

Gets a page-level resource object based on the specified ResourceKey property.

GetLocalResourceObject(String, Type, String)

Gets a page-level resource object based on the specified ResourceKey property, object type, and property name.

GetLocalResourceObject(String)

Gets a page-level resource object based on the specified ResourceKey property.

C#
protected object GetLocalResourceObject(string resourceKey);

Parameters

resourceKey
String

A string representing a ResourceKey.

Returns

An object representing the requested resource object; otherwise, null.

Examples

The following code example demonstrates how to use the GetLocalResourceObject method to access a string named LocalResourceString1 from a local page resource that is located in the App_LocalResources folder.

ASP.NET (C#)
<%@ Page Language="C#" Culture="auto" UICulture="auto" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<script runat="server">

  protected void Page_Load(object sender, EventArgs e)
  {
    string localresourcestring;
    string globalresourcestring;
    
    // Get the local resource string.
    try
    {
      localresourcestring = "Found the local resource string and it's value is: " + 
        (String)GetLocalResourceObject("LocalResourceString1") + ".";
    }
    catch
    {
      localresourcestring = "Could not find local resource.";
    }
    
    // Get the global resource string.
    try
    {
      // Look in the global resource file called MyResource.resx.
      globalresourcestring = "Found the global resource string and it's value is: " +
        (String)GetGlobalResourceObject("MyResource", "GlobalResourceString1") + ".";
    }
    catch
    {
      globalresourcestring = "Could not find global resource.";
    }

    LocalResourceMessage.InnerText = localresourcestring;
    GlobalResourceMessage.InnerText = globalresourcestring;

  }
</script>

<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
    <title>TemplateControl GetGlobalResourceObject and GetLocalResourceObject Example</title>
</head>
<body>
    <form id="form1" runat="server">
    <div>
    <h3>TemplateControl GetGlobalResourceObject and GetLocalResourceObject Example</h3>
      <span id="LocalResourceMessage"
            runat="server"/>
      <br />
      <span id="GlobalResourceMessage"
            runat="server" />
    </div>
    </form>
</body>
</html>

Remarks

Local resource files are stored in the App_LocalResources directory. For more information, see Resources in ASP.NET Applications

See also

Applies to

.NET Framework 4.8.1 and other versions
Product Versions
.NET Framework 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1

GetLocalResourceObject(String, Type, String)

Gets a page-level resource object based on the specified ResourceKey property, object type, and property name.

C#
protected object GetLocalResourceObject(string resourceKey, Type objType, string propName);

Parameters

resourceKey
String

A string representing a ResourceKey.

objType
Type

The type of the resource object to get.

propName
String

The property name of the resource object to get.

Returns

An object representing the requested resource object; otherwise, null.

Remarks

Local resource files are stored in the App_LocalResources directory. For more information, see Resources in ASP.NET Applications

See also

Applies to

.NET Framework 4.8.1 and other versions
Product Versions
.NET Framework 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1