SiteMapNode.GetExplicitResourceString メソッド

.NET Framework クラス ライブラリ リファレンス

SiteMapNode.GetExplicitResourceString メソッド

メモ : このメソッドは、.NET Framework version 2.0 で新しく追加されたものです。

ローカライズされた文字列を、ローカライズする SiteMapNode 属性、リソースが見つからない場合に返す既定の文字列、およびリソースが見つからない場合に例外をスローするかどうかを示すブール値に基づいて取得します。

名前空間: System.Web
アセンブリ: System.Web (system.web.dll 内)
構文

Visual Basic (宣言)

Protected Function GetExplicitResourceString
 ( _
    attributeName As String, _
    defaultValue As String, _
    throwIfNotFound As Boolean _
) As String

Visual Basic (使用法)

Dim attributeName As String
Dim defaultValue As String
Dim throwIfNotFound As Boolean
Dim returnValue As String

returnValue = Me.GetExplicitResourceString(attributeName, defaultValue,
 throwIfNotFound)

C#

protected string GetExplicitResourceString
 (
    string attributeName,
    string defaultValue,
    bool throwIfNotFound
)

C++

protected:
String^ GetExplicitResourceString (
    String^ attributeName, 
    String^ defaultValue, 
    bool throwIfNotFound
)

J#

protected String GetExplicitResourceString (
    String attributeName, 
    String defaultValue, 
    boolean throwIfNotFound
)

JScript

protected function GetExplicitResourceString
 (
    attributeName : String, 
    defaultValue : String, 
    throwIfNotFound : boolean
) : String

パラメータ

attributeName

ローカライズする SiteMapNode 属性。

defaultValue

一致するリソースが見つからない場合に返す既定値。

throwIfNotFound

attributeName にリソースが明示的に定義されており、defaultValue が null 参照 (Visual Basic では Nothing) で、ローカライズされた値が見つからない場合に InvalidOperationException をスローする場合は true。それ以外の場合は false。

戻り値
ローカライズされた属性を表す文字列。

例外

例外の種類	条件
ArgumentNullException	attributeName が null 参照 (Visual Basic では Nothing) です。
InvalidOperationException	一致するリソース オブジェクトが見つからず、throwIfNotFound が true です。

解説

GetExplicitResourceString メソッドは、Title プロパティと Description プロパティ、および Attributes プロパティで定義されているすべてのカスタム属性の get アクセサ内で呼び出されます。SiteMapNode を追跡する SiteMapProvider オブジェクトでは、EnableLocalization プロパティが true に設定されている必要があります。これは、GetExplicitResourceString メソッドがローカライズされた文字列を返すようにするためです。EnableLocalization が false に設定されている場合、ローカリゼーションは実行されず、GetExplicitResourceString メソッドは呼び出されません。

Title プロパティと Description プロパティ、および Attributes プロパティに定義されているすべてのカスタム属性は、最初に GetImplicitResourceString メソッドを呼び出します。このメソッドが null 参照 (Visual Basic では Nothing) を返す場合、GetExplicitResourceString メソッドが、defaultValue に明示的なリソース式 (定義されていると想定) の既定値、および throwIfNotFound に true が設定されて呼び出されます。

メモ
XmlSiteMapProvider クラスには制約があり、SiteMapNode オブジェクトは、さまざまな属性に定義されている暗黙のリソース式と明示的なリソース式の両方の構築に使用する情報であるリソース キーを定義できません。ただし、カスタム プロバイダ実装では両方を可能にすることを選択できます。

GetExplicitResourceString メソッドは、SiteMapNode オブジェクトの初期化に使用するリソース キーの NameValueCollection コレクションを使用します。リソース キーのコレクションが指定されていなかった場合、GetExplicitResourceString は null 参照 (Visual Basic では Nothing) を返します。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
SiteMapNode クラス
SiteMapNode メンバ
System.Web 名前空間
EnableLocalization
GetImplicitResourceString