SiteMapNode.GetImplicitResourceString(String) Method

Reference

Definition

Namespace:: System.Web

Assembly:: System.Web.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gets a localized string based on the attribute name and ResourceKey property that is specified by the SiteMapProvider by which the SiteMapNode is tracked.

protected:
 System::String ^ GetImplicitResourceString(System::String ^ attributeName);

protected string GetImplicitResourceString (string attributeName);

member this.GetImplicitResourceString : string -> string

Protected Function GetImplicitResourceString (attributeName As String) As String

Parameters

attributeName: String

The SiteMapNode attribute to localize.

Returns

String

A string representing the localized attribute. The default is null.

Exceptions

ArgumentNullException

attributeName is null.

Remarks

The GetImplicitResourceString method is invoked in the get accessor of the Title property, the Description property, and any custom attributes that are defined in the Attributes property. The SiteMapProvider provider by which the SiteMapNode object is tracked must have its EnableLocalization property set to true for the GetImplicitResourceString method to be called. If the EnableLocalization is set to false, localization is not performed and the GetImplicitResourceString method is never called.

If the GetImplicitResourceString method returns a string that is not empty, this becomes the value of the Title, Description, or custom attribute property.

The GetImplicitResourceString method uses the value of the ResourceKey property to localize the attribute. If the ResourceKey is not specified, the GetImplicitResourceString returns null.

Note

The XmlSiteMapProvider class imposes the restriction that the SiteMapNode object cannot define both implicit resource expressions and explicit resource expressions for attributes. However, a custom provider implementation can choose to allow both.

Applies to