Interface ISegment

Interface used when routing requests.

Namespace: EPiServer.Web.Routing.Segments
Assembly: EPiServer.dll
Version: 8.11.0
Syntax
public interface ISegment

Properties

Name

The name of a segment. It is used to determine if a specific segment should be used when routing.

Declaration
string Name { get; }
Property Value
Type Description
System.String

Methods

AppendTrailingSlash(RequestContext, RouteValueDictionary)

Called for the last segment that outputs anything in virtualpath. The segment implementation can then decide wether a trailing slash should be added.

Declaration
bool AppendTrailingSlash(RequestContext requestContext, RouteValueDictionary values)
Parameters
Type Name Description
System.Web.Routing.RequestContext requestContext

The request context.

System.Web.Routing.RouteValueDictionary values

The values.

Returns
Type Description
System.Boolean

GetVirtualPathSegment(RequestContext, RouteValueDictionary, HashSet<String>)

Gets the virtual path segment.

Declaration
string GetVirtualPathSegment(RequestContext requestContext, RouteValueDictionary values, HashSet<string> usedRouteValueKeys)
Parameters
Type Name Description
System.Web.Routing.RequestContext requestContext

The request context.

System.Web.Routing.RouteValueDictionary values

The route values.

System.Collections.Generic.HashSet<System.String> usedRouteValueKeys

Route values that are handled and should not be added to the query string.

Returns
Type Description
System.String

A path segment string.

RouteDataMatch(SegmentContext)

Route incoming segment.

Declaration
bool RouteDataMatch(SegmentContext context)
Parameters
Type Name Description
SegmentContext context

Routing context

Returns
Type Description
System.Boolean

True if the segment part matches the pattern

Extension Methods