System.Web.SiteMapNode.GetImplicitResourceString Method

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

Syntax

protected string GetImplicitResourceString (string attributeName)

Parameters

attributeName
The System.Web.SiteMapNode attribute to localize.

Returns

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

Remarks

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

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

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

Note:

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

Requirements

Namespace: System.Web
Assembly: System.Web (in System.Web.dll)
Assembly Versions: 2.0.0.0
Since: .NET 2.0