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 にリソースが明示的に定義されており、InvalidOperationExceptionattributeName で、ローカライズされた値が見つからない場合に defaultValue をスローする場合は null。それ以外の場合は falsetrue 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.

例外

attributeNamenull です。attributeName is null.

一致するリソース オブジェクトが見つからず、throwIfNotFoundtrue です。A matching resource object was not found and throwIfNotFound is true.

注釈

GetExplicitResourceString メソッドは、Title プロパティの get アクセサー、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. GetExplicitResourceString メソッドがローカライズされた文字列を返すには、SiteMapNode の追跡に使用する SiteMapProvider オブジェクトの EnableLocalization プロパティを true に設定する必要があります。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. EnableLocalizationfalseに設定されている場合、ローカリゼーションは実行されず、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が返された場合は、明示的なリソース式 (定義されている場合) の既定値の値に設定された defaultValue を使用して GetExplicitResourceString メソッドが呼び出され、throwIfNotFoundtrueに設定されます。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 メソッドは、SiteMapNode オブジェクトが初期化されたリソースキーの NameValueCollection コレクションを使用します。The GetExplicitResourceString method uses the NameValueCollection collection of resource keys that the SiteMapNode object was initialized with. リソースキーのコレクションが指定されていない場合、GetExplicitResourceStringnullを返します。If a collection of resource keys was not specified, the GetExplicitResourceString returns null.

適用対象

こちらもご覧ください