AI OnAI Off

Class PartialRouteData

When an outgoing virtual path is extended through implementations of GetPartialVirtualPath(TRoutedData, String, RouteValueDictionary, RequestContext) this states the partial virtual path and the ContentReference for the content that should be used for base path.

Inheritance
System.Object
PartialRouteData
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: EPiServer.Web.Routing
Assembly: EPiServer.dll
Version: 8.11.0
Syntax
public class PartialRouteData

Constructors

PartialRouteData()

Initializes a new instance of the PartialRouteData class.

Declaration
public PartialRouteData()

Properties

AdditionalUsedValues

Gets any additional used values consumed by the partial router. Generally you don't need to add anything to this, but you can add a key to mark data that would otherwise appear on the querystring as consumed.

Declaration
public HashSet<string> AdditionalUsedValues { get; }
Property Value
Type Description
System.Collections.Generic.HashSet<System.String>

The additional used values.

BasePathRoot

Gets or sets the base path root of the generated virtual path.

Declaration
public ContentReference BasePathRoot { get; set; }
Property Value
Type Description
ContentReference

The base path root.
Remarks

An example would be the generation of an url like http://sitehost/aPage/extendedPart/extendedContent/ where http://sitehost/aPage/ is the url for a page and 'extendedPart/extendedContent/' is an extension. In the example the BasePathRoot is set as a reference to the page that matches the url http://sitehost/aPage/.

PartialVirtualPath

Gets or sets the partial virtual path for the generated virtual path.

Declaration
public string PartialVirtualPath { get; set; }
Property Value
Type Description
System.String

The partial virtual path.
Remarks

An example would be the generation of an url like http://sitehost/aPage/extendedPart/extendedContent/ where http://sitehost/aPage/ is the url for a page and 'extendedPart/extendedContent/' is an extension. In the example the implementation could return PartialVirtualPath as 'extendedPart/extendedContent/'.

Extension Methods