Try our conversational search powered by Generative AI!

Class UrlSegmentGeneratorExtensions

Extends IUrlSegmentGenerator with convenient methods.

Inheritance
System.Object
UrlSegmentGeneratorExtensions
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
Assembly: EPiServer.dll
Version: 11.20.7
Syntax
public static class UrlSegmentGeneratorExtensions

Methods

Create(IUrlSegmentGenerator, String)

Creates a url friendly segment from the passed in string

Declaration
public static string Create(this IUrlSegmentGenerator urlSegmentGenerator, string proposedSegment)
Parameters
Type Name Description
IUrlSegmentGenerator urlSegmentGenerator

The url segment generator that is extended

System.String proposedSegment

The segment to generate a url friendly segment for

Returns
Type Description
System.String

A url friendly segment

Remarks

The default registered instance of UrlSegmentOptions is used where ValidCharacters specifies which characthers that are considered valid. CharacterMap specifies which character replacements.

IsValid(IUrlSegmentGenerator, String)

Determines if an url segment is considered url friendly

Declaration
public static bool IsValid(this IUrlSegmentGenerator urlSegmentGenerator, string segment)
Parameters
Type Name Description
IUrlSegmentGenerator urlSegmentGenerator

The url segment generator that is extended

System.String segment

The segment to validate

Returns
Type Description
System.Boolean

true if segment is considered valid else false

Remarks

The default registered instance of UrlSegmentOptions is used where ValidCharacters specifies which characthers that are considered valid.