TemplateControl.GetLocalResourceObject Method (String)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

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

Namespace:   System.Web.UI
Assembly:  System.Web (in System.Web.dll)

Protected Function GetLocalResourceObject (
	resourceKey As String
) As Object

Parameters

resourceKey
Type: System.String

A string representing a ResourceKey.

Return Value

Type: System.Object

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

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

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.

<%@ Page Language="VB" 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 Sub Page_Load(ByVal sender As Object, ByVal e As System.EventArgs)

    Dim localresourcestring As String
    Dim globalresourcestring As String

    ' Get the local resource string.
    Try

      localresourcestring = "Found the local resource string and it's value is: " & _
        Convert.ToString(GetLocalResourceObject("LocalResourceString1")) & "."

    Catch

      localresourcestring = "Could not find local resource."

    End Try

    ' 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: " & _
        Convert.ToString(GetGlobalResourceObject("MyResource", "GlobalResourceString1")) & "."

    Catch

      globalresourcestring = "Could not find global resource."

    End Try

    LocalResourceMessage.InnerText = localresourcestring
    GlobalResourceMessage.InnerText = globalresourcestring

  End Sub
</script>

<html xmlns="http://www.w3.org/1999/xhtml" >
<head id="Head1" 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>

.NET Framework
Available since 2.0
Return to top
Show: