Try our conversational search powered by Generative AI!

AI OnAI Off

Class SiteRedirect

Page extension to support preview navigation between enterpsrise sites

Inheritance
System.Object
SiteRedirect
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.PageExtensions
Assembly: EPiServer.Cms.AspNet.dll
Version: 11.20.7
Syntax
[PagePlugIn("SiteRedirect", "Enterprise Edition support for redirection between pages that belong to different web sites.")]
public class SiteRedirect

Constructors

SiteRedirect(IContentRepository)

Initializes a new instance of the SiteRedirect class.

Declaration
public SiteRedirect(IContentRepository contentRepository)
Parameters
Type Name Description
IContentRepository contentRepository

The page repository.

Properties

EnterpriseSettings

Gets or sets the page enterprise service.

Declaration
[Obsolete("Not used anymore")]
protected Injected<IEnterpriseSettings> EnterpriseSettings { get; set; }
Property Value
Type Description
Injected<IEnterpriseSettings>

The page enterprise service.

IsRedirectEnabled

Gets a value indicating whether the currently executing Page instance has site redirect enabled.

Declaration
public static bool IsRedirectEnabled { get; }
Property Value
Type Description
System.Boolean

true if this instance has redirect enabled; otherwise, false.

OptionFlag

Flag value to determine if this plug in should be enabled.

Declaration
public static int OptionFlag { get; }
Property Value
Type Description
System.Int32

Page

Gets or sets the page for which this extension instance is loaded

Declaration
public PageBase Page { get; }
Property Value
Type Description
PageBase

The page.

Methods

Attach(PageBase)

Attach to a PageBase class.

Declaration
public void Attach(PageBase page)
Parameters
Type Name Description
PageBase page

The page to attach to.

Initialize(Int32)

Method called at system startup to initialize this plug in.

Declaration
public static void Initialize(int optionFlag)
Parameters
Type Name Description
System.Int32 optionFlag

The option flag value assigned to this plug in.
Remarks

Using the plugin attribute [PagePlugIn] requires the class to contain a static void method named "Initialize" which will be called to attach to suitable event handlers.

Initialize(Int32, IContentRepository)

Method called at system startup to initialize this plug in.

Declaration
public static void Initialize(int optionFlag, IContentRepository contentRepository)
Parameters
Type Name Description
System.Int32 optionFlag

The option flag value assigned to this plug in.
IContentRepository contentRepository

The page repository.
Remarks

Using the plugin attribute [PagePlugIn] requires the class to contain a static void method named "Initialize" which will be called to attach to suitable event handlers.

Extension Methods