Get custom attributes via ActionExecutingContext from controller .Net Core

Question

This used used to work with earlier version of .Net. What's the equivalent in .net core terms. Now I get following error:

'ActionDescriptor' does not contain a definition for 'GetCustomAttributes' and no extension method 'GetCustomAttributes' accepting a first argument of type 'ActionDescriptor' could be found

public virtual void SetupMetadata(ActionExecutingContext filterContext)
{
    var myAttr = filterContext.ActionDescriptor.GetCustomAttributes(typeof(MyAttribute), false);
    if (myAttr.Length == 1)
        //do something
}

Attribute definition:

public class MyAttribute : Attribute
{
    private readonly string _parameter;

    public PageTitleAttribute(string parameter)
    {
        _parameter = parameter;
    }

    public string Parameter { get { return _parameter; } }
}

Code Usage:

[MyAttribute("Attribute value is set here")]
public ActionResult About()
{
    ViewBag.Message = "Your application description page.";
    return View();
}

user869375 · Accepted Answer · 2017-01-23 10:25:42Z

33

Hope to help others, here's what i did:

var attrib = (filterContext.ActionDescriptor as ControllerActionDescriptor).MethodInfo.GetCustomAttributes<MyAttribute>().FirstOrDefault();

answered Jan 23, 2017 at 10:25

user869375

2,4296 gold badges29 silver badges48 bronze badges

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

1 Comment

Roman Starkov Over a year ago

For those looking to do the same for a parameter: cast a ControllerActionDescriptor.Parameters to ControllerParameterDescriptor which has a ParameterInfo for all the usual reflection information.

Ryan Davis · Accepted Answer · 2018-02-20 23:06:03Z

16

Another option without needing a runtime cast:

public class MyAttribute :  Microsoft.AspNetCore.Mvc.Filters.ActionFilterAttribute {
  // same content as in the question
}

By inheriting from ActionFilterAttribute, your attribute will now appear in the ActionDescriptor.FilterDescriptors collection, and you can search that:

public virtual void SetupMetadata(ActionExecutingContext filterContext)
{
    var myAttr = filterContext.ActionDescriptor
        .FilterDescriptors
        .Where(x => x.Filter is MyAttribute)
        .ToArray();
    if (myAttr.Length == 1) {
        //do something
    }
}

I'm unsure if this is dirtier or cleaner than casting to ControllerActionDescriptor, but it's an option if you control the attribute.

answered Feb 20, 2018 at 23:06

Ryan Davis

7218 silver badges12 bronze badges

1 Comment

An0d Over a year ago

A more direct way could be bool isAttributeSet = filterContext.ActionDescriptor.FilterDescriptors.Any(fd => fd.Filter is MyAttribute);

Rodion Mostovoi · Accepted Answer · 2020-06-03 12:43:05Z

9

For ASP.NET Core 3+:

    var filters = context.Filters;
    // And filter it like this: 
    var filtered = filters.OfType<OurFilterType>();

edited Jun 3, 2020 at 12:43

answered Jun 3, 2020 at 0:10

Rodion Mostovoi

1,65115 silver badges18 bronze badges

Comments

Darth Sonic · Accepted Answer · 2020-01-27 11:46:40Z

3

Why not use:

filterContext.ActionDescriptor.ControllerDescriptor.GetCustomAttributes(typeof(MyAttribute), false).Any()

answered Jan 27, 2020 at 11:46

Darth Sonic

1058 bronze badges

1 Comment

Mohammad Barbast Over a year ago

This just gets controller's attributes not action's attributes.

Collectives™ on Stack Overflow

Get custom attributes via ActionExecutingContext from controller .Net Core

4 Answers 4

1 Comment

1 Comment

Comments

1 Comment

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

4 Answers 4

1 Comment

1 Comment

Comments

1 Comment

Your Answer

Sign up or log in

Post as a guest

Linked

Related