Route.Constraints プロパティ

定義

名前空間:

System.Web.Routing

アセンブリ:

System.Web.dll

URL パラメーターの有効な値を指定する式のディクショナリを取得または設定します。

public:
 property System::Web::Routing::RouteValueDictionary ^ Constraints { System::Web::Routing::RouteValueDictionary ^ get(); void set(System::Web::Routing::RouteValueDictionary ^ value); };

public System.Web.Routing.RouteValueDictionary Constraints { get; set; }

member this.Constraints : System.Web.Routing.RouteValueDictionary with get, set

Public Property Constraints As RouteValueDictionary

プロパティ値

RouteValueDictionary

パラメーター名と式が含まれるオブジェクト。

例

次の例では、オブジェクトを作成Routeし、、、DataTokensおよび Defaults プロパティを設定するConstraints方法を示します。

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

次の例は、 Route プロパティに Constraints 値の クラスのインスタンスを持つ という名前 httpMethod のパラメーターを HttpMethodConstraint 含む オブジェクトを示しています。

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

public static void RegisterRoutes(RouteCollection routes)
{
    string[] allowedMethods = { "GET", "POST" };
    HttpMethodConstraint methodConstraints = new HttpMethodConstraint(allowedMethods);

    Route reportRoute = new Route("{locale}/{year}", new ReportRouteHandler());
    reportRoute.Constraints = new RouteValueDictionary { { "httpMethod", methodConstraints } };

    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
    Dim allowedMethods() As String = {"GET", "POST"}
    Dim methodConstraints As HttpMethodConstraint  
    
    methodConstraints = New HttpMethodConstraint(allowedMethods)
    
    Dim constraintValues = New With {.httpMethod = methodConstraints}
    
    urlPattern = "{locale}/{year}"
    
    reportRoute = New Route(urlPattern, New ReportRouteHandler)
    reportRoute.Constraints = New RouteValueDictionary(constraintValues)
    
    routes.Add(reportRoute)
End Sub

注釈

Constraintsプロパティを使用すると、ルートによって処理される URL パラメーターの許容される値を制限できます。 オブジェクトを RouteValueDictionary プロパティに Constraints 割り当てます。 オブジェクト内の RouteValueDictionary 各要素には、パラメーターの名前と次のいずれかが含まれます。

• 正規表現を定義する文字列。 正規表現では大文字と小文字が区別されません。

• インターフェイスを実装し、 メソッドを IRouteConstraint 含む Match オブジェクト。

HttpMethodConstraint クラスは、IRouteConstraint インターフェイスを実装します。 クラスの HttpMethodConstraint インスタンスを制約として含めて、ルートに許容される HTTP 動詞を指定できます。

こちらもご覧ください

• ASP.NET ルーティング