Try our conversational search powered by Generative AI!

AI OnAI Off

Class EditUrlArguments

This class supports the EPiServer infrastructure and is not intended to be used directly from your code.

Inheritance
System.Object
EditUrlArguments
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.Cms.AspNet.dll
Version: 11.20.7
Syntax
public class EditUrlArguments

Constructors

EditUrlArguments()

Declaration
public EditUrlArguments()

Properties

ForceEditHost

Gets or sets a value indicating whether to force the use of a edit host if present (but never primary site hosts)

Declaration
public bool ForceEditHost { get; set; }
Property Value
Type Description
System.Boolean
Remarks

The primary use case for this property is linking to edit mode from templates.

Note that the edit host will always be preferred if requested edit URL isn't for the current site.

ForceHost

Gets or sets a value indicating whether to force the use of a site host (prefers edit hosts but fallbacks to primary host)

Declaration
public bool ForceHost { get; set; }
Property Value
Type Description
System.Boolean
Remarks

The primary use case for this property is linking from external systems, such as links in e-mails.

If language is specified hosts from the specified language will used, but fallbacks to hosts not locked to languages.

Note that if no site can be detected an URL without host will be returned, use an overload that takes SiteDefinition to be sure a host can be resolved.

Language

Gets or sets the specific language that should be requested.

Declaration
public CultureInfo Language { get; set; }
Property Value
Type Description
System.Globalization.CultureInfo
Remarks

This property will add language information to the URL but also try to select a language specific host if matched with ForceHost property.

ModuleName

Gets or sets the name of the module that should be used for the edit URL. The default is 'CMS'.

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

ModuleRelativePath

Gets or sets a module relative path that should be used for the edit URL.

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

Extension Methods