Route.Defaults プロパティ

定義

名前空間:

System.Web.Routing

アセンブリ:

System.Web.dll

URL にすべてのパラメーターが含まれていない場合に使用する値を取得または設定します。

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

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

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

Public Property Defaults 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 プロパティ内のパターンの一部ではないパラメーターをプロパティに含む オブジェクト Defaults を Url 示しています。

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 { { "months", "all" } };
    
    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 {.months = "all"})
    
    routes.Add(reportRoute)
End Sub

注釈

Defaults URL にパラメーターのセグメントが含まれていない場合は、 プロパティを使用して URL パラメーターの値を設定できます。 オブジェクトを RouteValueDictionary プロパティに Defaults 割り当てます。 オブジェクト内の RouteValueDictionary 各要素には、パラメーターの名前と、パラメーターがない場合に使用する値が含まれます。

プロパティでセグメントとして定義されていないパラメーターの既定値を Url 含めることができます。 ルーティング ASP.NET 要求を処理する場合、この既定値は常にルート ハンドラーに渡されます。 URL を作成し、セグメントとして定義されていない既定のパラメーターの値を含めると、指定した値がルートの既定値と一致する場合にのみ、ルートは一致と見なされます。

こちらもご覧ください

• ASP.NET ルーティング