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.v23.2.dll

NuGet Package: DevExpress.Web

Declaration

C#

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

VB.NET

<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:

Library	Object Type	Path to AllowPreview
ASP.NET MVC Extensions	HtmlEditorSettings	.Settings .AllowPreview
ASP.NET Web Forms Controls	ASPxHtmlEditor	.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.

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");
}

Default.aspx

<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 CommandName="open" Text="Open" />
                            <dx:CustomToolbarButton CommandName="save" Text="Save" />
                            <dx:CustomToolbarButton CommandName="close" Text="Close" />
                        </Items>
                    </dx:HtmlEditorToolbar>
                </Toolbars>
            </dx:ASPxHtmlEditor>
        </dx:PanelContent>
    </PanelCollection>
</dx:ASPxCallbackPanel>

Default.aspx.cs

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;
    }
}

Default.aspx.vb

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