Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

RouteOptions Class

Definition

Namespace:
Microsoft.AspNetCore.Routing
Assembly:
Microsoft.AspNetCore.Routing.dll
Package:
Microsoft.AspNetCore.Routing v1.0.0
Package:
Microsoft.AspNetCore.Routing v1.1.0
Package:
Microsoft.AspNetCore.App.Ref v10.0.0
Package:
Microsoft.AspNetCore.App.Ref v11.0.0-preview.4.26230.115
Package:
Microsoft.AspNetCore.Routing v2.0.0
Package:
Microsoft.AspNetCore.Routing v2.1.0
Package:
Microsoft.AspNetCore.Routing v2.2.0
Package:
Microsoft.AspNetCore.App.Ref v3.0.1
Package:
Microsoft.AspNetCore.App.Ref v3.1.10
Package:
Microsoft.AspNetCore.App.Ref v5.0.0
Package:
Microsoft.AspNetCore.App.Ref v6.0.36
Package:
Microsoft.AspNetCore.App.Ref v7.0.5
Package:
Microsoft.AspNetCore.App.Ref v8.0.19
Package:
Microsoft.AspNetCore.App.Ref v9.0.8
Source:
RouteOptions.cs
Source:
RouteOptions.cs
Source:
RouteOptions.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Represents the configurable options on a route.

public ref class RouteOptions
public class RouteOptions
type RouteOptions = class
Public Class RouteOptions
Inheritance
RouteOptions

Constructors

Name Description
RouteOptions()

Properties

Name Description
AppendTrailingSlash

Gets or sets a value indicating whether a trailing slash should be appended to the generated URLs.
ConstraintMap

Gets or sets a collection of constraints on the current route.
LowercaseQueryStrings

Gets or sets a value indicating whether a generated query strings are lowercase. This property will not be used unless LowercaseUrls is also true.
LowercaseUrls

Gets or sets a value indicating whether all generated paths URLs are lowercase. Use LowercaseQueryStrings to configure the behavior for query strings.
SuppressCheckForUnhandledSecurityMetadata

Gets or sets a value that indicates if the check for unhandled security endpoint metadata is suppressed.

Endpoints can be associated with metadata such as authorization, or CORS, that needs to be handled by a specific middleware to be actionable. If the middleware is not configured, such metadata will go unhandled.

When false, prior to the execution of the endpoint, routing will verify that all known security-specific metadata has been handled. Setting this property to true suppresses this check.

Methods

Name Description
SetParameterPolicy(String, Type)

Adds or overwrites the parameter policy with the associated route pattern token.
SetParameterPolicy<T>(String)

Adds or overwrites the parameter policy with the associated route pattern token.

Applies to

Feedback

Was this page helpful?