Removed setting the InPreviewMode flag

The change we introduced from #117 to trick Umbraco in thinking that it
was in full preview mode has had some bad side-effects, see issues #123,
#124 and #125 for further details.

This change removes us manually setting the `InPreviewMode` property,
and adds "`dtgePreview`" to the partial-view's `ViewData`, so a
developer can detect whether its rendering in DTGE's preview mode or
not.

I'm unsure how this change will impact #117, there is an extra level of
complexity when attempting cross-package-compatibility, (in this case
Vorto).

Author: leekelleher

docs/developers-guide.md

@@ -4,12 +4,12 @@
 
 1. [Introduction](#introduction)
 2. [Getting Set Up](#getting-set-up)
-  a. [System Requirements](#system-requirements)
+    1. [System Requirements](#system-requirements)
 3. [Configuring The Doc Type Grid Editor](#configuring-the-doc-type-grid-editor)
 4. [Hooking Up The Doc Type Grid Editor](#hooking-up-the-doc-type-grid-editor)
 5. [Rendering a Doc Type Grid Editor](#rendering-a-doc-type-grid-editor)
-  a. [Rendering Alternative Preview Content](#rendering-alternative-preview-content)
-  b. [DocTypeGridEditorSurfaceController](#doctypegrideditorsurfacecontroller)
+    1. [Rendering Alternative Preview Content](#rendering-alternative-preview-content)
+    2. [DocTypeGridEditorSurfaceController](#doctypegrideditorsurfacecontroller)
 6. [Useful Links](#useful-links)
 
 ---
@@ -139,11 +139,11 @@ Because we treat your data as a standard `IPublishedContent` entity, that means
 
 #### Rendering Alternative Preview Content
 
-If your front end view is rather complex, you may decide that you want to feed the back office preview an alternative, less complex view. To do this, within your Razor view/partial, check `UmbracoContext.InPreviewMode` is set to true to detect being in preview mode to provide an alternative view.
+If your front end view is rather complex, you may decide that you want to feed the back office preview an alternative, less complex view. To do this, within your Razor view/partial, check `ViewData["dtgePreview"]` is set to true to detect being in preview mode to provide an alternative view.
 
 ```
 @inherits Umbraco.Web.Mvc.UmbracoViewPage
-@if (UmbracoContext.InPreviewMode)
+@if (ViewData["dtgePreview"] == true)
 {
 	// Render preview view
 }

src/Our.Umbraco.DocTypeGridEditor/Web/Controllers/DocTypeGridEditorApiController.cs

@@ -136,10 +136,6 @@ public HttpResponseMessage GetPreviewMarkup([FromBody] PreviewData data, [FromUr
                 System.Threading.Thread.CurrentThread.CurrentUICulture = culture;
             }
 
-            // Set DTGE's preview to be in "preview mode", (storing the original value in a temp variable for resetting it later).
-            var inPreviewMode = UmbracoContext.InPreviewMode;
-            UmbracoContext.InPreviewMode = true;
-
             // Get content node object
             var content = DocTypeGridEditorHelper.ConvertValueToContent(data.Id, data.ContentTypeAlias, data.Value);
 
@@ -157,9 +153,6 @@ public HttpResponseMessage GetPreviewMarkup([FromBody] PreviewData data, [FromUr
             var partialName = "~/App_Plugins/DocTypeGridEditor/Render/DocTypeGridEditorPreviewer.cshtml";
             var markup = Helpers.ViewHelper.RenderPartial(partialName, model, UmbracoContext.HttpContext);
 
-            // Restore the "preview mode" to its original value
-            UmbracoContext.InPreviewMode = inPreviewMode;
-
             // Return response
             var response = new HttpResponseMessage
             {

src/Our.Umbraco.DocTypeGridEditor/Web/Controllers/DocTypeGridEditorSurfaceController.cs

@@ -1,4 +1,5 @@
-using System.Web.Mvc;
+using System;
+using System.Web.Mvc;
 using Our.Umbraco.DocTypeGridEditor.Web.Helpers;
 using Umbraco.Core;
 using Umbraco.Core.Models;
@@ -29,7 +30,7 @@ public string PreviewViewPath
 
         public bool IsPreview
         {
-            get { return UmbracoContext.InPreviewMode; }
+            get { return ControllerContext.RouteData.Values.TryGetValue("dtgePreview", out object value) && Convert.ToBoolean(value); }
         }
 
         protected PartialViewResult CurrentPartialView(object model = null)
@@ -49,6 +50,8 @@ protected PartialViewResult CurrentPartialView(object model = null)
 
         protected override PartialViewResult PartialView(string viewName, object model)
         {
+            ViewData.Add("dtgePreview", IsPreview);
+
             if (IsPreview && string.IsNullOrWhiteSpace(PreviewViewPath) == false)
             {
                 var previewViewPath = GetFullViewPath(viewName, PreviewViewPath);

src/Our.Umbraco.DocTypeGridEditor/Web/Extensions/HtmlHelperExtensions.cs

@@ -1,6 +1,7 @@
 using System.Web;
 using System.Web.Mvc;
 using System.Web.Mvc.Html;
+using Our.Umbraco.DocTypeGridEditor.Extensions;
 using Our.Umbraco.DocTypeGridEditor.Web.Helpers;
 using Our.Umbraco.DocTypeGridEditor.Web.Mvc;
 using Umbraco.Core;
@@ -46,9 +47,12 @@ public static HtmlString RenderDocTypeGridEditorItem(
             {
                 dtgeModel = content,
                 dtgeViewPath = viewPath,
-                dtgePreviewViewPath = previewViewPath
+                dtgePreviewViewPath = previewViewPath,
+                dtgePreview = isPreview
             };
 
+            var viewData = new ViewDataDictionary() { { "dtgePreview", isPreview } };
+
             // Try looking for surface controller with action named after the editor alias
             if (string.IsNullOrWhiteSpace(editorAlias) == false && SurfaceControllerHelper.SurfaceControllerExists(controllerName, editorAlias, true))
             {
@@ -89,19 +93,19 @@ public static HtmlString RenderDocTypeGridEditorItem(
                 var fullPreviewViewPath = $"{previewViewPath}{editorAlias}.cshtml";
                 if (ViewHelper.ViewExists(helper.ViewContext, fullPreviewViewPath, true))
                 {
-                    return helper.Partial(fullPreviewViewPath, content);
+                    return helper.Partial(fullPreviewViewPath, content, viewData);
                 }
 
                 fullPreviewViewPath = $"{previewViewPath}{content.DocumentTypeAlias}.cshtml";
                 if (ViewHelper.ViewExists(helper.ViewContext, fullPreviewViewPath, true))
                 {
-                    return helper.Partial(fullPreviewViewPath, content);
+                    return helper.Partial(fullPreviewViewPath, content, viewData);
                 }
 
                 fullPreviewViewPath = $"{previewViewPath}Default.cshtml";
                 if (ViewHelper.ViewExists(helper.ViewContext, fullPreviewViewPath, true))
                 {
-                    return helper.Partial(fullPreviewViewPath, content);
+                    return helper.Partial(fullPreviewViewPath, content, viewData);
                 }
             }
 
@@ -111,29 +115,29 @@ public static HtmlString RenderDocTypeGridEditorItem(
                 var fullViewPath = $"{viewPath}{editorAlias}.cshtml";
                 if (ViewHelper.ViewExists(helper.ViewContext, fullViewPath, true))
                 {
-                    return helper.Partial(fullViewPath, content);
+                    return helper.Partial(fullViewPath, content, viewData);
                 }
 
                 fullViewPath = $"{viewPath}{content.DocumentTypeAlias}.cshtml";
                 if (ViewHelper.ViewExists(helper.ViewContext, fullViewPath, true))
                 {
-                    return helper.Partial(fullViewPath, content);
+                    return helper.Partial(fullViewPath, content, viewData);
                 }
 
                 fullViewPath = $"{viewPath}Default.cshtml";
                 if (ViewHelper.ViewExists(helper.ViewContext, fullViewPath, true))
                 {
-                    return helper.Partial(fullViewPath, content);
+                    return helper.Partial(fullViewPath, content, viewData);
                 }
             }
 
             // Resort to standard partial views
             if (ViewHelper.ViewExists(helper.ViewContext, editorAlias, true))
             {
-                return helper.Partial(editorAlias, content);
+                return helper.Partial(editorAlias, content, viewData);
             }
 
-            return helper.Partial(content.DocumentTypeAlias, content);
+            return helper.Partial(content.DocumentTypeAlias, content, viewData);
         }
     }
 }