ASPxHtmlEditor.ReplacePlaceholders(String, Dictionary<String, String>) Method

Replaces placeholders with the specified values.

Namespace: DevExpress.Web.ASPxHtmlEditor

Assembly: DevExpress.Web.ASPxHtmlEditor.v18.2.dll

Declaration

C#

public static string ReplacePlaceholders(
    string html,
    Dictionary<string, string> placeholders
)

VB.NET

Public Shared Function ReplacePlaceholders(
    html As String,
    placeholders As Dictionary(Of String, String)
) As String

Parameters

Name	Type	Description
html	String	A string value that specifies the HTML code to process.
placeholders	Dictionary<String, String>	The collection of placeholders and values to replace them.

Returns

Type	Description
String	A string value that is the resulting HTML code with the placeholders replaced.

Example

This example demonstrates how to replace placeholders with data specified as an object. When the Insert Signature button is clicked, the FirstName and LastName placeholders are replaced using the ASPxHtmlEditor.ReplacePlaceholders method’s ReplacePlaceholders(string html, Dictionary <String, String> placeholders) overload.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/aspxhtmleditor-how-to-specify-placeholders-using-dictionary-and-object-structures-t283576

Placeholder.aspx (C#)

<dx:ASPxHtmlEditor ID="HtmlEditor" ClientInstanceName="HtmlEditor" runat="server">
    <Toolbars>
        <dx:HtmlEditorToolbar>
            <Items>
                <dx:ToolbarUndoButton>
                </dx:ToolbarUndoButton>
                <dx:ToolbarRedoButton>
                </dx:ToolbarRedoButton>
                <dx:ToolbarBoldButton BeginGroup="True">
                </dx:ToolbarBoldButton>
                <dx:ToolbarItalicButton>
                </dx:ToolbarItalicButton>
                <dx:ToolbarUnderlineButton>
                </dx:ToolbarUnderlineButton>
                <dx:ToolbarStrikethroughButton>
                </dx:ToolbarStrikethroughButton>
                <dx:ToolbarJustifyLeftButton BeginGroup="True">
                </dx:ToolbarJustifyLeftButton>
                <dx:ToolbarJustifyCenterButton>
                </dx:ToolbarJustifyCenterButton>
                <dx:ToolbarJustifyRightButton>
                </dx:ToolbarJustifyRightButton>
                <dx:ToolbarInsertPlaceholderDialogButton>
                </dx:ToolbarInsertPlaceholderDialogButton>
            </Items>
        </dx:HtmlEditorToolbar>
    </Toolbars>
    <Placeholders>
        <dx:HtmlEditorPlaceholderItem Value="DateNow" />
        <dx:HtmlEditorPlaceholderItem Value="TimeNow" />
        <dx:HtmlEditorPlaceholderItem Value="FirstName" />
        <dx:HtmlEditorPlaceholderItem Value="LastName" />
    </Placeholders>
</dx:ASPxHtmlEditor>
<dx:ASPxButton ID="SignatureButton" runat="server" OnClick="Insert_Signature" 
    Text="Insert Signature"></dx:ASPxButton>
<dx:ASPxButton ID="DateButton" runat="server" OnClick="Insert_Date" Text="Insert Date">
</dx:ASPxButton>

Placeholder.aspx.cs

private Dictionary<string, string> PlaceholdersForSignature = new Dictionary<string, string>() {
    {"FirstName", "Mary"},
    {"LastName", "Bonn"}
};

// Replaces placeholders specified as a dictionary
protected void Insert_Signature(object sender, EventArgs e) {
    string html = HtmlEditor.Html;
    string newHtml = ASPxHtmlEditor.ReplacePlaceholders(html, PlaceholdersForSignature);
    HtmlEditor.Html = newHtml;
}

Placeholder.aspx (VB.NET)

<dx:ASPxHtmlEditor ID="HtmlEditor" ClientInstanceName="HtmlEditor" runat="server">
    <Toolbars>
        <dx:HtmlEditorToolbar>
            <Items>
                <dx:ToolbarUndoButton>
                </dx:ToolbarUndoButton>
                <dx:ToolbarRedoButton>
                </dx:ToolbarRedoButton>
                <dx:ToolbarBoldButton BeginGroup="True">
                </dx:ToolbarBoldButton>
                <dx:ToolbarItalicButton>
                </dx:ToolbarItalicButton>
                <dx:ToolbarUnderlineButton>
                </dx:ToolbarUnderlineButton>
                <dx:ToolbarStrikethroughButton>
                </dx:ToolbarStrikethroughButton>
                <dx:ToolbarJustifyLeftButton BeginGroup="True">
                </dx:ToolbarJustifyLeftButton>
                <dx:ToolbarJustifyCenterButton>
                </dx:ToolbarJustifyCenterButton>
                <dx:ToolbarJustifyRightButton>
                </dx:ToolbarJustifyRightButton>
                <dx:ToolbarInsertPlaceholderDialogButton>
                </dx:ToolbarInsertPlaceholderDialogButton>
            </Items>
        </dx:HtmlEditorToolbar>
    </Toolbars>
    <Placeholders>
        <dx:HtmlEditorPlaceholderItem Value="DateNow" />
        <dx:HtmlEditorPlaceholderItem Value="TimeNow" />
        <dx:HtmlEditorPlaceholderItem Value="FirstName" />
        <dx:HtmlEditorPlaceholderItem Value="LastName" />
    </Placeholders>
</dx:ASPxHtmlEditor>
<dx:ASPxButton ID="SignatureButton" runat="server" OnClick="Insert_Signature" 
    Text="Insert Signature"></dx:ASPxButton>
<dx:ASPxButton ID="DateButton" runat="server" OnClick="Insert_Date" Text="Insert Date">
</dx:ASPxButton>

Placeholder.aspx.vb

Private PlaceholdersForSignature As New Dictionary(Of String, String)() From { _
    {"FirstName", "Mary"}, _
    {"LastName", "Bonn"} _
}

' Replaces placeholders specified as a dictionary
Protected Sub Insert_Signature(ByVal sender As Object, ByVal e As EventArgs)
    Dim html As String = HtmlEditor.Html
    Dim newHtml As String = ASPxHtmlEditor.ReplacePlaceholders(html, PlaceholdersForSignature)
    HtmlEditor.Html = newHtml
End Sub

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the ReplacePlaceholders(String, Dictionary<String, String>) method.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

aspxhtmleditor-how-to-specify-placeholders-using-dictionary-and-object-structures-t283576/CS/Placeholder/Placeholder.aspx.cs#L54

string html = HtmlEditor.Html;
string newHtml = ASPxHtmlEditor.ReplacePlaceholders(html, PlaceholdersForSignature);
HtmlEditor.Html = newHtml;

VB.NET

aspxhtmleditor-how-to-specify-placeholders-using-dictionary-and-object-structures-t283576/VB/Placeholder/Placeholder.aspx.vb#L57

Dim html As String = HtmlEditor.Html
Dim newHtml As String = ASPxHtmlEditor.ReplacePlaceholders(html, PlaceholdersForSignature)
HtmlEditor.Html = newHtml