SiteMapNode.GetExplicitResourceString(String, String, Boolean) Метод

Определение

Возвращает локализованную строку, основываясь на атрибуте SiteMapNode для локализации или используемую по умолчанию строку, если ресурс не найден, и логическую величину, показывающую, выдается ли исключение, если ресурс не найден.Retrieves a localized string based on a SiteMapNode attribute to localize, a default string to return if no resource is found, and a Boolean value indicating whether to throw an exception if no resource is found.

protected:
 System::String ^ GetExplicitResourceString(System::String ^ attributeName, System::String ^ defaultValue, bool throwIfNotFound);
protected string GetExplicitResourceString (string attributeName, string defaultValue, bool throwIfNotFound);
member this.GetExplicitResourceString : string * string * bool -> string
Protected Function GetExplicitResourceString (attributeName As String, defaultValue As String, throwIfNotFound As Boolean) As String

Параметры

attributeName
String

Атрибут SiteMapNode для локализации.The SiteMapNode attribute to localize.

defaultValue
String

Значение по умолчанию для возврата, если ресурс не найден.The default value to return if a matching resource is not found.

throwIfNotFound
Boolean

Значение true, чтобы выдавать исключение InvalidOperationException, если явный ресурс описан для параметра attributeName, параметру defaultValue присвоено значение null и локализованное значение не найдено; в противном случае — значение false.true to throw an InvalidOperationException, if an explicit resource is defined for attributeName, defaultValue is null, and a localized value is not found; otherwise, false.

Возвращаемое значение

String

Строка, представляющая локализованный атрибут.A string representing the localized attribute.

Исключения

attributeName имеет значение null.attributeName is null.

Соответствующий объект ресурса не найден, и параметру throwIfNotFound присвоено значение true.A matching resource object was not found and throwIfNotFound is true.

Комментарии

GetExplicitResourceStringМетод вызывается в get методе доступа Title свойства, Description Свойства и любых пользовательских атрибутов, определенных в Attributes свойстве.The GetExplicitResourceString 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. SiteMapProviderДля объекта, по которому SiteMapNode производится трассировка, свойство должно иметь EnableLocalization значение, чтобы true GetExplicitResourceString метод возвращал локализованную строку.The SiteMapProvider object by which the SiteMapNode is tracked must have its EnableLocalization property set to true for the GetExplicitResourceString method to return a localized string. Если параметр EnableLocalization имеет значение false , локализация не выполняется и GetExplicitResourceString метод никогда не вызывается.If the EnableLocalization is set to false, localization is not performed and the GetExplicitResourceString method is never called.

TitleСвойство, Description свойство и все пользовательские атрибуты, определенные в Attributes свойстве, сначала вызывают GetImplicitResourceString метод.The Title property, the Description property, and any custom attributes that are defined in the Attributes property first invoke the GetImplicitResourceString method. Если он возвращает null , метод вызывается с параметром, равным GetExplicitResourceString defaultValue значению по умолчанию из явного выражения ресурса (при условии, что оно определено) и throwIfNotFound имеет значение true .If it returns null, the GetExplicitResourceString method is invoked with defaultValue set to the value of the default value from the explicit resource expression (assuming one was defined) and throwIfNotFound set to true.

Примечание

XmlSiteMapProviderКласс накладывает ограничение, что SiteMapNode объект не может определить как неявные выражения ресурсов, так и явные выражения ресурсов для атрибутов.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.

GetExplicitResourceStringМетод использует NameValueCollection коллекцию ключей ресурсов, SiteMapNode с которыми был инициализирован объект.The GetExplicitResourceString method uses the NameValueCollection collection of resource keys that the SiteMapNode object was initialized with. Если коллекция ключей ресурсов не указана, GetExplicitResourceString возвращается значение null .If a collection of resource keys was not specified, the GetExplicitResourceString returns null.

Применяется к

См. также раздел