AI OnAI Off

Class PageEditing

Class that has helper functions for the EPiServer page editing view.

Inheritance
System.Object
PageEditing
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.Editor
Assembly: EPiServer.dll
Version: 8.11.0
Syntax
public class PageEditing

Constructors

PageEditing()

Declaration
public PageEditing()

Fields

DataEPiBlockId

Will be used to display the id of a block in edit mode.

Declaration
public const string DataEPiBlockId = "data-epi-block-id"
Field Value
Type Description
System.String

DataEPiBlockInfo

Will be used to display additional info of a block in edit mode.

Declaration
public const string DataEPiBlockInfo = "data-epi-block-info"
Field Value
Type Description
System.String

DataEPiBlockPersonalization

Will be used to configure personalization of blocks

Declaration
public const string DataEPiBlockPersonalization = "data-epi-block-personalization"
Field Value
Type Description
System.String

DataEPiContentName

Name of the content inside property

Declaration
public const string DataEPiContentName = "data-epi-content-name"
Field Value
Type Description
System.String

DataEPiEditContainerCssClass

Default CSS class for property edit container that is used to indicate property data rendering in on-page-editing mode.

Declaration
public const string DataEPiEditContainerCssClass = "epi-editContainer"
Field Value
Type Description
System.String

DataEPiFullRefreshPropertyNames

Name of the attribute that indicates which properties require a full refresh of the page to render a correct preview.

Declaration
public const string DataEPiFullRefreshPropertyNames = "data-epi-full-refresh-property-names"
Field Value
Type Description
System.String

DataEPiPropertyEditorSettings

Will be used to display any custom editor settings as a JSON formatted string.

Declaration
public const string DataEPiPropertyEditorSettings = "data-epi-property-editorsettings"
Field Value
Type Description
System.String

DataEPiPropertyName

Name of the attribute that indicates what property that the html is connected to.

Declaration
public const string DataEPiPropertyName = "data-epi-property-name"
Field Value
Type Description
System.String

DataEPiPropertyOverlaySettings

Will be used to display any custom overlay settings as a JSON formatted string.

Declaration
public const string DataEPiPropertyOverlaySettings = "data-epi-property-overlaysettings"
Field Value
Type Description
System.String

DataEPiPropertyRenderSettings

Prefix of the attribute that indicates any custom render setting for the property. The format on the client is 'data-epi-property-customsetting' where the value will be JSON notation. CustomSettings dictionary on e.g. EPiServer.Web.WebControls.Property

Declaration
public const string DataEPiPropertyRenderSettings = "data-epi-property-rendersettings"
Field Value
Type Description
System.String

DataEPiUseMvc

Name of the attribute that indicates if the property should use Mvc when doing a partial re-rendering.

Declaration
public const string DataEPiUseMvc = "data-epi-use-mvc"
Field Value
Type Description
System.String

EPiChannel

Name on the query parameter propagating the channel parameter in edit mode

Declaration
public const string EPiChannel = "epichannel"
Field Value
Type Description
System.String

EpiEditMode

Name on the query parameter indicating if the request is in edit mode.

Declaration
public const string EpiEditMode = "epieditmode"
Field Value
Type Description
System.String

EPiProjects

Name on the query parameter propagating the projects parameter in edit mode

Declaration
public const string EPiProjects = "epiprojects"
Field Value
Type Description
System.String

Properties

PageIsInEditMode

Gets a value indicating whether the page is in edit mode.

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

true if the page is in edit mode; otherwise, false.
Remarks

Use CurrentContextMode to get the specific ContextMode.

UseLegacyEditMode

Gets or sets the useLegacyEditMode for determining which edit mode is set to use. This avoid the risk of accessing to Settings.UseLegacyEditMode

Declaration
[Obsolete("The legacy edit mode has been removed")]
public static bool UseLegacyEditMode { get; set; }
Property Value
Type Description
System.Boolean

WorkspaceIsActivated

Gets a value indicating whether the workspace is activated.

Declaration
[Obsolete("Workspace functionality is not active")]
public static bool WorkspaceIsActivated { get; }
Property Value
Type Description
System.Boolean

true if the workspace is activated; otherwise, false.
Remarks

This affects if workspace versions or pages should be loaded.

Methods

GetChannel(HttpContextBase)

Gets the channel parameter.

Declaration
public static string GetChannel(HttpContextBase httpContext)
Parameters
Type Name Description
System.Web.HttpContextBase httpContext

The HTTP context.
Returns
Type Description
System.String

return the channel parameter

GetEditUrl(ContentReference)

Gets the edit URL for a content link.

Declaration
public static string GetEditUrl(ContentReference contentLink)
Parameters
Type Name Description
ContentReference contentLink

The content link.
Returns
Type Description
System.String

GetEditUrlForLanguage(ContentReference, String)

Gets the edit URL for a content link.

Declaration
public static string GetEditUrlForLanguage(ContentReference contentLink, string language)
Parameters
Type Name Description
ContentReference contentLink

The content link.
System.String language

The language.
Returns
Type Description
System.String

Extension Methods