ApiExplorerSettingsAttribute Class

Article
2012-08-15

This attribute can be used on the controllers and actions to influence the behavior of ApiExplorer.

Inheritance Hierarchy

System.Object
System.Attribute
System.Web.Http.Description.ApiExplorerSettingsAttribute

Namespace: System.Web.Http.Description
Assembly: System.Web.Http (in System.Web.Http.dll)

Syntax

'Declaration
<AttributeUsageAttribute(AttributeTargets.Class Or AttributeTargets.Method, AllowMultiple := False)> _
Public NotInheritable Class ApiExplorerSettingsAttribute _
    Inherits Attribute
'Usage
Dim instance As ApiExplorerSettingsAttribute

[AttributeUsageAttribute(AttributeTargets.Class|AttributeTargets.Method, AllowMultiple = false)]
public sealed class ApiExplorerSettingsAttribute : Attribute

[AttributeUsageAttribute(AttributeTargets::Class|AttributeTargets::Method, AllowMultiple = false)]
public ref class ApiExplorerSettingsAttribute sealed : public Attribute

[<SealedAttribute>]
[<AttributeUsageAttribute(AttributeTargets.Class|AttributeTargets.Method, AllowMultiple = false)>]
type ApiExplorerSettingsAttribute =  
    class 
        inherit Attribute 
    end

public final class ApiExplorerSettingsAttribute extends Attribute

The ApiExplorerSettingsAttribute type exposes the following members.

Constructors

	Name	Description
	ApiExplorerSettingsAttribute	Initializes a new instance of the ApiExplorerSettingsAttribute class.

Top

Properties

	Name	Description
	IgnoreApi	Gets or sets a value indicating whether to exclude the controller or action from the ApiDescription instances generated by ApiExplorer.
	TypeId	(Inherited from Attribute.)

Top

Methods

	Name	Description
	Equals	(Inherited from Attribute.)
	Finalize	(Inherited from Object.)
	GetHashCode	(Inherited from Attribute.)
	GetType	(Inherited from Object.)
	IsDefaultAttribute	(Inherited from Attribute.)
	Match	(Inherited from Attribute.)
	MemberwiseClone	(Inherited from Object.)
	ToString	(Inherited from Object.)

Top

Explicit Interface Implementations

	Name	Description
	_Attribute.GetIDsOfNames	(Inherited from Attribute.)
	_Attribute.GetTypeInfo	(Inherited from Attribute.)
	_Attribute.GetTypeInfoCount	(Inherited from Attribute.)
	_Attribute.Invoke	(Inherited from Attribute.)

Top

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Share via