RouteValueDictionary クラス

定義

ルートの既定値を定義する場合やルートに基づく URL を生成する場合など、ルーティング フレームワークのさまざまな場面で使用するキー/値ペアの大文字と小文字を区別しないコレクションを表します。Represents a case-insensitive collection of key/value pairs that you use in various places in the routing framework, such as when you define the default values for a route or when you generate a URL that is based on a route.

public ref class RouteValueDictionary : System::Collections::Generic::ICollection<System::Collections::Generic::KeyValuePair<System::String ^, System::Object ^>>, System::Collections::Generic::IDictionary<System::String ^, System::Object ^>, System::Collections::Generic::IEnumerable<System::Collections::Generic::KeyValuePair<System::String ^, System::Object ^>>
public class RouteValueDictionary : System.Collections.Generic.ICollection<System.Collections.Generic.KeyValuePair<string,object>>, System.Collections.Generic.IDictionary<string,object>, System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<string,object>>
type RouteValueDictionary = class
    interface IDictionary<string, obj>
    interface ICollection<KeyValuePair<string, obj>>
    interface seq<KeyValuePair<string, obj>>
    interface IEnumerable
Public Class RouteValueDictionary
Implements ICollection(Of KeyValuePair(Of String, Object)), IDictionary(Of String, Object), IEnumerable(Of KeyValuePair(Of String, Object))
継承
RouteValueDictionary
実装

オブジェクトをRoute作成する方法と、 DataTokens、、およびDefaultsConstraints各プロパティを設定する方法を次の例に示します。The following example shows how to create a Route object and how to set the Constraints, DataTokens, and Defaults properties.

void Application_Start(object sender, EventArgs e) 
{
    RegisterRoutes(RouteTable.Routes);
}

public static void RegisterRoutes(RouteCollection routes)
{
    Route reportRoute = new Route("{locale}/{year}", new ReportRouteHandler());
    reportRoute.Defaults = new RouteValueDictionary { { "locale", "en-US" }, { "year", DateTime.Now.Year.ToString() } };
    reportRoute.Constraints = new RouteValueDictionary { { "locale", "[a-z]{2}-[a-z]{2}" }, { "year", @"\d{4}" } };
    reportRoute.DataTokens = new RouteValueDictionary { { "format", "short" } };
    routes.Add(reportRoute);
}
Sub Application_Start(ByVal sender As Object, ByVal e As EventArgs)
    RegisterRoutes(RouteTable.Routes)
End Sub

Shared Sub RegisterRoutes(ByVal routes As RouteCollection)
    Dim urlPattern As String
    Dim reportRoute As Route
    
    urlPattern = "{locale}/{year}"
    
    reportRoute = New Route(urlPattern, New ReportRouteHandler)
    reportRoute.Defaults = New RouteValueDictionary(New With {.locale = "en-US", .year = DateTime.Now.Year.ToString()})
    reportRoute.Constraints = New RouteValueDictionary(New With {.locale = "[a-z]{2}-[a-z]{2}", .year = "\d{4}"})
    reportRoute.DataTokens = New RouteValueDictionary(New With {.format = "short"})

    routes.Add(reportRoute)
End Sub

注釈

RouteValueDictionaryクラスを使用すると、ASP.NET ルーティングを使用するために必要なキーと値のペアのコレクションを操作できます。The RouteValueDictionary class enables you to work with collections of key/value pairs that are required in order to use ASP.NET routing. RouteValueDictionaryオブジェクトを使用してConstraintsDataTokens、、およびDefaultsの各プロパティの値を定義します。You use the RouteValueDictionary object to define values for the Constraints, DataTokens, and Defaults properties. また、 GetVirtualPathメソッドをRouteValueDictionary呼び出し、パラメーターとしてオブジェクトをRouteValueDictionary渡すことによって、URL を生成するときにオブジェクトを使用します。You also use a RouteValueDictionary object when you generate a URL by calling the GetVirtualPath method and passing a RouteValueDictionary object as a parameter.

RouteValueDictionaryオブジェクト内のすべてのキーは一意である必要があります。Every key in a RouteValueDictionary object must be unique. クラスRouteValueDictionaryは、大文字と小文字を区別しない序数比較を使用します。The RouteValueDictionary class uses case-insensitive ordinal comparison. 詳細については、「OrdinalIgnoreCase」を参照してください。For more information, see OrdinalIgnoreCase. キーをにするnullことはできません。A key cannot be null.

コンストラクター

RouteValueDictionary()

RouteValueDictionary クラスの新しい空のインスタンスを初期化します。Initializes a new instance of the RouteValueDictionary class that is empty.

RouteValueDictionary(IDictionary<String,Object>)

RouteValueDictionary クラスの新しいインスタンスを初期化し、指定したコレクションから要素を追加します。Initializes a new instance of the RouteValueDictionary class and adds elements from the specified collection.

RouteValueDictionary(Object)

RouteValueDictionary クラスの新しいインスタンスを初期化し、指定したオブジェクトのプロパティに基づく値を追加します。Initializes a new instance of the RouteValueDictionary class and adds values that are based on properties from the specified object.

プロパティ

Count

コレクション内のキー/値ペアの数を取得します。Gets the number of key/value pairs that are in the collection.

Item[String]

指定したキーに関連付けられている値を取得または設定します。Gets or sets the value that is associated with the specified key.

Keys

ディクショナリ内のキーを含むコレクションを取得します。Gets a collection that contains the keys in the dictionary.

Values

ディクショナリ内の値を含むコレクションを取得します。Gets a collection that contains the values in the dictionary.

メソッド

Add(String, Object)

指定したキーを使用して、ディクショナリに指定の値を追加します。Adds the specified value to the dictionary by using the specified key.

Clear()

ディクショナリからすべてのキーと値を削除します。Removes all keys and values from the dictionary.

ContainsKey(String)

指定したキーがディクショナリに含まれているかどうかを判断します。Determines whether the dictionary contains the specified key.

ContainsValue(Object)

ディクショナリに特定の値が含まれているかどうかを判断します。Determines whether the dictionary contains a specific value.

Equals(Object)

指定されたオブジェクトが現在のオブジェクトと等しいかどうかを判定します。Determines whether the specified object is equal to the current object.

(継承元 Object)
GetEnumerator()

ディクショナリを反復処理するために使用できる列挙子を返します。Returns an enumerator that you can use to iterate through the dictionary.

GetHashCode()

既定のハッシュ関数として機能します。Serves as the default hash function.

(継承元 Object)
GetType()

現在のインスタンスの Type を取得します。Gets the Type of the current instance.

(継承元 Object)
MemberwiseClone()

現在の Object の簡易コピーを作成します。Creates a shallow copy of the current Object.

(継承元 Object)
Remove(String)

指定したキーを持つ値をディクショナリから削除します。Removes the value that has the specified key from the dictionary.

ToString()

現在のオブジェクトを表す string を返します。Returns a string that represents the current object.

(継承元 Object)
TryGetValue(String, Object)

指定したキーに値が関連付けられているかどうかを示す値を取得します。Gets a value that indicates whether a value is associated with the specified key.

明示的なインターフェイスの実装

ICollection<KeyValuePair<String,Object>>.Add(KeyValuePair<String,Object>)

このメンバーの詳細については、「Add(T)」をご覧ください。For a description of this member, see Add(T).

ICollection<KeyValuePair<String,Object>>.Contains(KeyValuePair<String,Object>)

このメンバーの説明については、Contains(T) のトピックを参照してください。For a description of this member, see Contains(T).

ICollection<KeyValuePair<String,Object>>.CopyTo(KeyValuePair<String,Object>[], Int32)

このメンバーの説明については、CopyTo(T[], Int32) のトピックを参照してください。For a description of this member, see CopyTo(T[], Int32).

ICollection<KeyValuePair<String,Object>>.IsReadOnly

このメンバーの詳細については、「IsReadOnly」をご覧ください。For a description of this member, see IsReadOnly.

ICollection<KeyValuePair<String,Object>>.Remove(KeyValuePair<String,Object>)

このメンバーの詳細については、「Remove(T)」をご覧ください。For a description of this member, see Remove(T).

IDictionary<String,Object>.Keys

このメンバーの詳細については、「Keys」をご覧ください。For a description of this member, see Keys.

IDictionary<String,Object>.Values

このメンバーの説明については、Values のトピックを参照してください。For a description of this member, see Values.

IEnumerable.GetEnumerator()

このメンバーの詳細については、「GetEnumerator()」をご覧ください。For a description of this member, see GetEnumerator().

IEnumerable<KeyValuePair<String,Object>>.GetEnumerator()

このメンバーの詳細については、「GetEnumerator()」をご覧ください。For a description of this member, see GetEnumerator().

拡張メソッド

CopyToDataTable<T>(IEnumerable<T>)

指定した入力 DataTable オブジェクトに応じて (ジェネリック パラメーター TDataRow)、IEnumerable<T> オブジェクトのコピーを格納する DataRow を返します。Returns a DataTable that contains copies of the DataRow objects, given an input IEnumerable<T> object where the generic parameter T is DataRow.

CopyToDataTable<T>(IEnumerable<T>, DataTable, LoadOption)

指定した入力 DataRow オブジェクトに応じて (ジェネリック パラメーター TDataTable)、指定した IEnumerable<T>DataRow オブジェクトをコピーします。Copies DataRow objects to the specified DataTable, given an input IEnumerable<T> object where the generic parameter T is DataRow.

CopyToDataTable<T>(IEnumerable<T>, DataTable, LoadOption, FillErrorEventHandler)

指定した入力 DataRow オブジェクトに応じて (ジェネリック パラメーター TDataTable)、指定した IEnumerable<T>DataRow オブジェクトをコピーします。Copies DataRow objects to the specified DataTable, given an input IEnumerable<T> object where the generic parameter T is DataRow.

Cast<TResult>(IEnumerable)

IEnumerable の要素を、指定した型にキャストします。Casts the elements of an IEnumerable to the specified type.

OfType<TResult>(IEnumerable)

指定された型に基づいて IEnumerable の要素をフィルター処理します。Filters the elements of an IEnumerable based on a specified type.

AsParallel(IEnumerable)

クエリの並列化を有効にします。Enables parallelization of a query.

AsQueryable(IEnumerable)

IEnumerableIQueryable に変換します。Converts an IEnumerable to an IQueryable.

Ancestors<T>(IEnumerable<T>)

ソース コレクション内のすべてのノードの先祖が格納された、要素のコレクションを返します。Returns a collection of elements that contains the ancestors of every node in the source collection.

Ancestors<T>(IEnumerable<T>, XName)

ソース コレクション内のすべてのノードの先祖が格納され、フィルター処理された要素のコレクションを返します。Returns a filtered collection of elements that contains the ancestors of every node in the source collection. 一致する XName を持つ要素のみがコレクションに含められます。Only elements that have a matching XName are included in the collection.

DescendantNodes<T>(IEnumerable<T>)

ソース コレクション内のすべてのドキュメントおよび要素の子孫ノードのコレクションを返します。Returns a collection of the descendant nodes of every document and element in the source collection.

Descendants<T>(IEnumerable<T>)

ソース コレクション内のすべての要素とドキュメントの子孫要素が格納された要素のコレクションを返します。Returns a collection of elements that contains the descendant elements of every element and document in the source collection.

Descendants<T>(IEnumerable<T>, XName)

ソース コレクション内のすべての要素とドキュメントの子孫要素が格納され、フィルター処理された要素のコレクションを返します。Returns a filtered collection of elements that contains the descendant elements of every element and document in the source collection. 一致する XName を持つ要素のみがコレクションに含められます。Only elements that have a matching XName are included in the collection.

Elements<T>(IEnumerable<T>)

ソース コレクション内のすべての要素およびドキュメントの子要素のコレクションを返します。Returns a collection of the child elements of every element and document in the source collection.

Elements<T>(IEnumerable<T>, XName)

ソース コレクション内のすべての要素およびドキュメントの、フィルター処理された子要素のコレクションを返します。Returns a filtered collection of the child elements of every element and document in the source collection. 一致する XName を持つ要素のみがコレクションに含められます。Only elements that have a matching XName are included in the collection.

InDocumentOrder<T>(IEnumerable<T>)

ソース コレクション内のすべてのノードがドキュメント順に並べ替えて格納された、ノードのコレクションを返します。Returns a collection of nodes that contains all nodes in the source collection, sorted in document order.

Nodes<T>(IEnumerable<T>)

ソース コレクション内のすべてのドキュメントおよび要素の子ノードのコレクションを返します。Returns a collection of the child nodes of every document and element in the source collection.

Remove<T>(IEnumerable<T>)

ソース コレクション内の親ノードからすべてのノードを削除します。Removes every node in the source collection from its parent node.

適用対象

こちらもご覧ください