ASPxHtmlEditorSettings.AllowPreview Property

Gets or sets a value that specifies whether the Preview View is available to end-users.

Namespace: DevExpress.Web.ASPxHtmlEditor

Assembly: DevExpress.Web.ASPxHtmlEditor.v19.1.dll

Declaration

C#
VB.NET

[DefaultValue(true)]
public bool AllowPreview { get; set; }

<DefaultValue(True)>
Public Property AllowPreview As Boolean

Property Value

Type	Default	Description
Boolean	true	true to enable the editor’s Preview View; otherwise, false.

Property Paths

You can access this nested property as listed below:

Object Type	Path to AllowPreview
ASPxHtmlEditor	.Settings.AllowPreview
HtmlEditorSettings	.Settings.AllowPreview
MVCxHtmlEditor	.Settings.AllowPreview

Remarks

If the AllowPreview property is set to false, the editor’s Preview tab is not displayed, and end-users are not allowed to preview the editor’s content.

Example

The example below demonstrates how to manipulate ASPxHtmlEditor View Areas by CustomToolbarButton.

Wrap the ASPxHtmlEditor with the ASPxCallbackPanel to programmatically send a callback to the server.
Define custom toolbar buttons (CustomToolbarButton) for the ASPxHtmlEditor.
Handle the client-side ASPxClientHtmlEditor.CustomCommand event and perform a callback by using the ASPxClientCallbackPanel.PerformCallback method.
Handle the ASPxCallbackPanel.Callback event and define View Areas enabled by the ASPxHtmlEditor.Settings property.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/aspxhtmleditor-how-to-manipulate-aspxhtmleditor-view-areas-by-customtoolbarbutton-e3980

<%@ Page Language="C#" AutoEventWireup="true" CodeFile="Default.aspx.cs" Inherits="_Default" %>

<%@ Register Assembly="DevExpress.Web.v13.1, Version=13.1.5.0, Culture=neutral, PublicKeyToken=b88d1754d700e49a"
    Namespace="DevExpress.Web.ASPxCallbackPanel" TagPrefix="dx" %>
<%@ Register Assembly="DevExpress.Web.ASPxHtmlEditor.v13.1, Version=13.1.5.0, Culture=neutral, PublicKeyToken=b88d1754d700e49a"
    Namespace="DevExpress.Web.ASPxHtmlEditor" TagPrefix="dx" %>
<%@ Register Assembly="DevExpress.Web.v13.1, Version=13.1.5.0, Culture=neutral, PublicKeyToken=b88d1754d700e49a"
    Namespace="DevExpress.Web.ASPxEditors" TagPrefix="dx" %>
<%@ Register Assembly="DevExpress.Web.ASPxSpellChecker.v13.1, Version=13.1.5.0, Culture=neutral, PublicKeyToken=b88d1754d700e49a"
    Namespace="DevExpress.Web.ASPxSpellChecker" TagPrefix="dx" %>
<%@ Register Assembly="DevExpress.Web.v13.1, Version=13.1.5.0, Culture=neutral, PublicKeyToken=b88d1754d700e49a"
    Namespace="DevExpress.Web.ASPxEditors" TagPrefix="dx" %>
<%@ Register Assembly="DevExpress.Web.v13.1, Version=13.1.5.0, Culture=neutral, PublicKeyToken=b88d1754d700e49a"
    Namespace="DevExpress.Web.ASPxPanel" TagPrefix="dx" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head runat="server">
    <title></title>

    <script type="text/javascript">
        function OnCustomCommand(s, e) {
            if(e.commandName == "close") {
                cp.PerformCallback("closed");
            }
            if(e.commandName == "open" || e.commandName == "new")
                if(confirm("Are you sure?"))
                cp.PerformCallback("opened");
        }    
    </script>

</head>
<body>
    <form id="form1" runat="server">
    <dx:ASPxCallbackPanel ID="cp" runat="server" ClientInstanceName="cp" OnCallback="cp_Callback">
        <PanelCollection>
            <dx:PanelContent ID="PanelContent1" runat="server" SupportsDisabledAttribute="True">
                <dx:ASPxHtmlEditor ID="htmlEditor" runat="server">
                    <ClientSideEvents CustomCommand="OnCustomCommand" />
                    <Toolbars>
                        <dx:HtmlEditorToolbar>
                            <Items>
                                <dx:CustomToolbarButton CommandName="new" Text="New">
                                </dx:CustomToolbarButton>
                                <dx:CustomToolbarButton CommandName="open" Text="Open">
                                </dx:CustomToolbarButton>
                                <dx:CustomToolbarButton CommandName="save" Text="Save">
                                </dx:CustomToolbarButton>
                                <dx:CustomToolbarButton CommandName="close" Text="Close">
                                </dx:CustomToolbarButton>
                            </Items>
                        </dx:HtmlEditorToolbar>
                    </Toolbars>
                </dx:ASPxHtmlEditor>
            </dx:PanelContent>
        </PanelCollection>
    </dx:ASPxCallbackPanel>
    </form>
</body>
</html>

using System;

public partial class _Default : System.Web.UI.Page {
    protected void Page_Load(object sender, EventArgs e) {
        if(!IsPostBack && !IsCallback)
            Session["ViewVisible"] = false;
    if(Session["ViewVisible"]!=null) {
            htmlEditor.Settings.AllowHtmlView = (bool)Session["ViewVisible"];
            htmlEditor.Settings.AllowPreview = (bool)Session["ViewVisible"];
    }
    }

    protected void cp_Callback(object sender, DevExpress.Web.ASPxClasses.CallbackEventArgsBase e) {
        if(e.Parameter == "opened") {
            htmlEditor.Settings.AllowHtmlView = true;
            htmlEditor.Settings.AllowPreview = true;
            Session["ViewVisible"] = true;
        }
        if(e.Parameter == "closed") {
            htmlEditor.Settings.AllowHtmlView = false;
            htmlEditor.Settings.AllowPreview = false;
            Session["ViewVisible"] = false;
        }
    }
}

Imports System

Partial Public Class _Default
    Inherits System.Web.UI.Page

    Protected Sub Page_Load(ByVal sender As Object, ByVal e As EventArgs)
        If (Not IsPostBack) AndAlso (Not IsCallback) Then
            Session("ViewVisible") = False
        End If
    If Session("ViewVisible") IsNot Nothing Then
            htmlEditor.Settings.AllowHtmlView = DirectCast(Session("ViewVisible"), Boolean)
            htmlEditor.Settings.AllowPreview = DirectCast(Session("ViewVisible"), Boolean)
    End If
    End Sub

    Protected Sub cp_Callback(ByVal sender As Object, ByVal e As DevExpress.Web.ASPxClasses.CallbackEventArgsBase)
        If e.Parameter = "opened" Then
            htmlEditor.Settings.AllowHtmlView = True
            htmlEditor.Settings.AllowPreview = True
            Session("ViewVisible") = True
        End If
        If e.Parameter = "closed" Then
            htmlEditor.Settings.AllowHtmlView = False
            htmlEditor.Settings.AllowPreview = False
            Session("ViewVisible") = False
        End If
    End Sub
End Class

<%@ Page Language="vb" AutoEventWireup="true" CodeFile="Default.aspx.vb" Inherits="_Default" %>

<%@ Register Assembly="DevExpress.Web.v13.1, Version=13.1.5.0, Culture=neutral, PublicKeyToken=b88d1754d700e49a"
    Namespace="DevExpress.Web.ASPxCallbackPanel" TagPrefix="dx" %>
<%@ Register Assembly="DevExpress.Web.ASPxHtmlEditor.v13.1, Version=13.1.5.0, Culture=neutral, PublicKeyToken=b88d1754d700e49a"
    Namespace="DevExpress.Web.ASPxHtmlEditor" TagPrefix="dx" %>
<%@ Register Assembly="DevExpress.Web.v13.1, Version=13.1.5.0, Culture=neutral, PublicKeyToken=b88d1754d700e49a"
    Namespace="DevExpress.Web.ASPxEditors" TagPrefix="dx" %>
<%@ Register Assembly="DevExpress.Web.ASPxSpellChecker.v13.1, Version=13.1.5.0, Culture=neutral, PublicKeyToken=b88d1754d700e49a"
    Namespace="DevExpress.Web.ASPxSpellChecker" TagPrefix="dx" %>
<%@ Register Assembly="DevExpress.Web.v13.1, Version=13.1.5.0, Culture=neutral, PublicKeyToken=b88d1754d700e49a"
    Namespace="DevExpress.Web.ASPxEditors" TagPrefix="dx" %>
<%@ Register Assembly="DevExpress.Web.v13.1, Version=13.1.5.0, Culture=neutral, PublicKeyToken=b88d1754d700e49a"
    Namespace="DevExpress.Web.ASPxPanel" TagPrefix="dx" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head runat="server">
    <title></title>

    <script type="text/javascript">
        function OnCustomCommand(s, e) {
            if(e.commandName == "close") {
                cp.PerformCallback("closed");
            }
            if(e.commandName == "open" || e.commandName == "new")
                if(confirm("Are you sure?"))
                cp.PerformCallback("opened");
        }    
    </script>

</head>
<body>
    <form id="form1" runat="server">
    <dx:ASPxCallbackPanel ID="cp" runat="server" ClientInstanceName="cp" OnCallback="cp_Callback">
        <PanelCollection>
            <dx:PanelContent ID="PanelContent1" runat="server" SupportsDisabledAttribute="True">
                <dx:ASPxHtmlEditor ID="htmlEditor" runat="server">
                    <ClientSideEvents CustomCommand="OnCustomCommand" />
                    <Toolbars>
                        <dx:HtmlEditorToolbar>
                            <Items>
                                <dx:CustomToolbarButton CommandName="new" Text="New">
                                </dx:CustomToolbarButton>
                                <dx:CustomToolbarButton CommandName="open" Text="Open">
                                </dx:CustomToolbarButton>
                                <dx:CustomToolbarButton CommandName="save" Text="Save">
                                </dx:CustomToolbarButton>
                                <dx:CustomToolbarButton CommandName="close" Text="Close">
                                </dx:CustomToolbarButton>
                            </Items>
                        </dx:HtmlEditorToolbar>
                    </Toolbars>
                </dx:ASPxHtmlEditor>
            </dx:PanelContent>
        </PanelCollection>
    </dx:ASPxCallbackPanel>
    </form>
</body>
</html>

Controls

Tools

Controls and Extensions

Tools

Maintenance Mode

Controls

Tools

Controls and Extensions

Tools

Maintenance Mode

ASPxHtmlEditorSettings.AllowPreview Property

Declaration

Property Value

Property Paths

Remarks

Example