How can I get the current route name with ASP.NET Core?

Question

I have an application that is written on the top of ASP.NET Core 2.2 framework.

I have the following controller

public class TestController : Controller
{
    [Route("some-parameter-3/{name}/{id:int}/{page:int?}", Name = "SomeRoute3Name")]
    [Route("some-parameter-2/{name}/{id:int}/{page:int?}", Name = "SomeRoute2Name")]
    [Route("some-parameter-1/{name}/{id:int}/{page:int?}", Name = "SomeRoute1Name")]
    public ActionResult Act(ActVM viewModel)
    {
        // switch the logic based on the route name

        return View(viewModel);
    }
}

How can I get the route name in the action and/or the view?

Kirk Larkin · Accepted Answer · 2020-01-28 21:49:38Z

18

Inside of a controller, you can read the AttributeRouteInfo from the ControllerContext's ActionDescriptor. AttributeRouteInfo has a Name property, which holds the value you're looking for:

public ActionResult Act(ActVM viewModel)
{
    switch (ControllerContext.ActionDescriptor.AttributeRouteInfo.Name)
    {
        // ...
    }

    return View(viewModel);
}

Inside of a Razor view, the ActionDescriptor is available via the ViewContext property:

@{
    var routeName = ViewContext.ActionDescriptor.AttributeRouteInfo.Name;
}

edited Jan 28, 2020 at 21:49

answered Jul 13, 2019 at 20:01

Kirk Larkin

94.4k17 gold badges235 silver badges214 bronze badges

Sign up to request clarification or add additional context in comments.

Comments

Dave de Jong · Accepted Answer · 2021-03-27 14:09:58Z

14

For me the answer by @krik-larkin didn't work as AttributeRouteInfo was always null in my case.

I used the following code instead:

var endpoint = HttpContext.GetEndpoint() as RouteEndpoint;
var routeNameMetadata = endpoint?.Metadata.OfType<RouteNameMetadata>().SingleOrDefault();
var routeName = routeNameMetadata?.RouteName;

answered Mar 27, 2021 at 14:09

Dave de Jong

1,0648 silver badges14 bronze badges

2 Comments

Andrey Kusnetsov Over a year ago

Exactly same in my situation. This should be marked as answer. Thank you

CrossBound Over a year ago

Works like a champ in .NET 8

stackunderflow · Accepted Answer · 2021-12-13 11:55:29Z

2

Small correction to Kirk Larkin answer. Sometimes you have to use Template property instead of Name:

var ari = ControllerContext.ActionDescriptor.AttributeRouteInfo;
var route = ari.Name ?? ari.Template;

answered Dec 13, 2021 at 11:55

stackunderflow

314 bronze badges

Comments

Lurch · Accepted Answer · 2023-04-21 12:16:26Z

2

For .NET 6:

Accepted answer not working for me neither.

This worked however:

var routeName = (HttpContext.GetEndpoint() as RouteEndpoint).RoutePattern.RawText;

answered Apr 21, 2023 at 12:16

Lurch

212 bronze badges

Collectives™ on Stack Overflow

How can I get the current route name with ASP.NET Core?

4 Answers 4

Comments

2 Comments

Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

4 Answers 4

Comments

2 Comments

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related