EVO PDF Logo

Add Text Notes to Generated PDF Document

EVO PDF Client for .NET Core

EVO HTML to PDF Converter allows you create text notes marked by appropriate icons in the generated PDF document. The text notes are created by adding EvoPdfClientTextNoteElement objects to a PDF document.

Code Sample - Add Text Notes to Generated PDF Document

C#
using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Mvc;
using Microsoft.AspNetCore.Http;

using Microsoft.AspNetCore.Hosting;

// Use EVO PDF Namespace
using EvoPdfClient;

namespace EvoHtmlToPdfDemo.Controllers
{
    public class Create_Text_NotesController : Controller
    {
        private readonly Microsoft.AspNetCore.Hosting.IWebHostEnvironment m_hostingEnvironment;
        public Create_Text_NotesController(IWebHostEnvironment hostingEnvironment)
        {
            m_hostingEnvironment = hostingEnvironment;
        }

        private void SetCurrentViewData()
        {
            ViewData["ContentRootPath"] = m_hostingEnvironment.ContentRootPath + "/wwwroot";

            HttpRequest request = this.ControllerContext.HttpContext.Request;
            UriBuilder uriBuilder = new UriBuilder();
            uriBuilder.Scheme = request.Scheme;
            uriBuilder.Host = request.Host.Host;
            if (request.Host.Port != null)
                uriBuilder.Port = (int)request.Host.Port;
            uriBuilder.Path = request.PathBase.ToString() + request.Path.ToString();
            uriBuilder.Query = request.QueryString.ToString();

            ViewData["CurrentPageUrl"] = uriBuilder.Uri.AbsoluteUri;
        }

        // GET: Create_Text_Notes
        public ActionResult Index()
        {
            SetCurrentViewData();

            return View();
        }

        [HttpPost]
        public ActionResult ConvertHtmlToPdf(IFormCollection collection)
        {
            // Get the server options
            string serverIP = collection["textBoxServerIP"];
            uint serverPort = uint.Parse(collection["textBoxServerPort"]);
            string servicePassword = collection["textBoxServicePassword"];
            bool useServicePassword = servicePassword.Length > 0;
            bool useTcpService = collection["ServerType"] == "radioButtonUseTcpService";
            string webServiceUrl = collection["textBoxWebServiceUrl"];

            // Create the HTML to PDF converter object
            HtmlToPdfConverter htmlToPdfConverter = null;
            if (useTcpService)
                htmlToPdfConverter = new HtmlToPdfConverter(serverIP, serverPort);
            else
                htmlToPdfConverter = new HtmlToPdfConverter(true, webServiceUrl);

            // Set optional service password
            if (useServicePassword)
                htmlToPdfConverter.ServicePassword = servicePassword;

            // Set license key received after purchase to use the converter in licensed mode
            // Leave it not set to use the converter in demo mode
            htmlToPdfConverter.LicenseKey = "4W9+bn19bn5ue2B+bn1/YH98YHd3d3c=";

            // Set an adddional delay in seconds to wait for JavaScript or AJAX calls after page load completed
            // Set this property to 0 if you don't need to wait for such asynchcronous operations to finish
            htmlToPdfConverter.ConversionDelay = 2;

            string htmlWithLinksAndAttachMarkers = collection["htmlStringTextBox"];
            string baseUrl = collection["baseUrlTextBox"];

            // Convert a HTML string with markers for file links and attachments to a PDF document object
            Document pdfDocument = htmlToPdfConverter.ConvertHtmlToPdfDocumentObject(htmlWithLinksAndAttachMarkers, baseUrl);

            // Make the HTML element with 'text_note' mapping ID a text note
            HtmlElementMapping textNoteMapping = htmlToPdfConverter.HtmlElementsMappingOptions.HtmlElementsMappingResult.GetElementByMappingId("text_note");
            if (textNoteMapping != null)
            {
                PdfPage textNotePage = pdfDocument.GetPage(textNoteMapping.PdfRectangles[0].PageIndex);
                RectangleFloat textNoteRectangle = textNoteMapping.PdfRectangles[0].Rectangle;

                // Create the text note
                TextNoteElement textNoteElement = new TextNoteElement(textNoteRectangle, "This is an initially closed text note");
                textNoteElement.NoteIcon = TextNoteIcon.Note;
                textNoteElement.Open = false;
                textNotePage.AddElement(textNoteElement);
            }

            // Make the HTML element with 'text_note_opened' mapping ID an initially opened text note
            HtmlElementMapping textNoteOpenedMapping = htmlToPdfConverter.HtmlElementsMappingOptions.HtmlElementsMappingResult.GetElementByMappingId("text_note_opened");
            if (textNoteOpenedMapping != null)
            {
                PdfPage textNoteOpenedPage = pdfDocument.GetPage(textNoteMapping.PdfRectangles[0].PageIndex);
                RectangleFloat textNoteOpenedRectangle = textNoteOpenedMapping.PdfRectangles[0].Rectangle;

                // Create the text note
                TextNoteElement textNoteOpenedElement = new TextNoteElement(textNoteOpenedRectangle, "This is an initially opened text note");
                textNoteOpenedElement.NoteIcon = TextNoteIcon.Note;
                textNoteOpenedElement.Open = true;
                textNoteOpenedPage.AddElement(textNoteOpenedElement);
            }

            // Make the HTML element with 'help_note' mapping ID a help note
            HtmlElementMapping helpNoteMapping = htmlToPdfConverter.HtmlElementsMappingOptions.HtmlElementsMappingResult.GetElementByMappingId("help_note");
            if (helpNoteMapping != null)
            {
                PdfPage helpNotePage = pdfDocument.GetPage(textNoteMapping.PdfRectangles[0].PageIndex);
                RectangleFloat helpNoteRectangle = helpNoteMapping.PdfRectangles[0].Rectangle;

                // Create the text note
                TextNoteElement helpNoteElement = new TextNoteElement(helpNoteRectangle, "This is an initially closed help note");
                helpNoteElement.NoteIcon = TextNoteIcon.Help;
                helpNoteElement.Open = false;
                helpNotePage.AddElement(helpNoteElement);
            }

            // Make the HTML element with 'help_note_opened' mapping ID an initially opened help note
            HtmlElementMapping helpNoteOpenedMapping = htmlToPdfConverter.HtmlElementsMappingOptions.HtmlElementsMappingResult.GetElementByMappingId("help_note_opened");
            if (helpNoteOpenedMapping != null)
            {
                PdfPage helpNoteOpenedPage = pdfDocument.GetPage(textNoteMapping.PdfRectangles[0].PageIndex);
                RectangleFloat helpNoteOpenedRectangle = helpNoteOpenedMapping.PdfRectangles[0].Rectangle;

                // Create the text note
                TextNoteElement helpNoteOpenedElement = new TextNoteElement(helpNoteOpenedRectangle, "This is an initially opened help note");
                helpNoteOpenedElement.NoteIcon = TextNoteIcon.Help;
                helpNoteOpenedElement.Open = true;
                helpNoteOpenedPage.AddElement(helpNoteOpenedElement);
            }

            // Make the HTML element with 'comment_note' mapping ID a comment note
            HtmlElementMapping commentNoteMapping = htmlToPdfConverter.HtmlElementsMappingOptions.HtmlElementsMappingResult.GetElementByMappingId("comment_note");
            if (commentNoteMapping != null)
            {
                PdfPage commentNotePage = pdfDocument.GetPage(textNoteMapping.PdfRectangles[0].PageIndex);
                RectangleFloat commentNoteRectangle = commentNoteMapping.PdfRectangles[0].Rectangle;

                // Create the text note
                TextNoteElement commentNoteElement = new TextNoteElement(commentNoteRectangle, "This is an initially closed comment note");
                commentNoteElement.NoteIcon = TextNoteIcon.Comment;
                commentNoteElement.Open = false;
                commentNotePage.AddElement(commentNoteElement);
            }

            // Make the HTML element with 'comment_note_opened' mapping ID an initially opened comment note
            HtmlElementMapping commentNoteOpenedMapping = htmlToPdfConverter.HtmlElementsMappingOptions.HtmlElementsMappingResult.GetElementByMappingId("comment_note_opened");
            if (commentNoteOpenedMapping != null)
            {
                PdfPage commentNoteOpenedPage = pdfDocument.GetPage(textNoteMapping.PdfRectangles[0].PageIndex);
                RectangleFloat commentNoteOpenedRectangle = commentNoteOpenedMapping.PdfRectangles[0].Rectangle;

                // Create the text note
                TextNoteElement commentNoteOpenedElement = new TextNoteElement(commentNoteOpenedRectangle, "This is an initially opened comment note");
                commentNoteOpenedElement.NoteIcon = TextNoteIcon.Comment;
                commentNoteOpenedElement.Open = true;
                commentNoteOpenedPage.AddElement(commentNoteOpenedElement);
            }

            // Make the HTML element with 'paragraph_note' mapping ID a paragraph note
            HtmlElementMapping paragraphNoteMapping = htmlToPdfConverter.HtmlElementsMappingOptions.HtmlElementsMappingResult.GetElementByMappingId("paragraph_note");
            if (paragraphNoteMapping != null)
            {
                PdfPage paragraphNotePage = pdfDocument.GetPage(textNoteMapping.PdfRectangles[0].PageIndex);
                RectangleFloat paragraphNoteRectangle = paragraphNoteMapping.PdfRectangles[0].Rectangle;

                // Create the text note
                TextNoteElement paragraphNoteElement = new TextNoteElement(paragraphNoteRectangle, "This is an initially closed paragraph note");
                paragraphNoteElement.NoteIcon = TextNoteIcon.Paragraph;
                paragraphNoteElement.Open = false;
                paragraphNotePage.AddElement(paragraphNoteElement);
            }

            // Make the HTML element with 'new_paragraph_note' mapping ID a new paragraph note
            HtmlElementMapping newParagraphNoteMapping = htmlToPdfConverter.HtmlElementsMappingOptions.HtmlElementsMappingResult.GetElementByMappingId("new_paragraph_note");
            if (newParagraphNoteMapping != null)
            {
                PdfPage newParagraphNotePage = pdfDocument.GetPage(textNoteMapping.PdfRectangles[0].PageIndex);
                RectangleFloat newParagraphNoteRectangle = newParagraphNoteMapping.PdfRectangles[0].Rectangle;

                // Create the text note
                TextNoteElement newParagraphNoteElement = new TextNoteElement(newParagraphNoteRectangle, "This is an initially closed new paragraph note");
                newParagraphNoteElement.NoteIcon = TextNoteIcon.NewParagraph;
                newParagraphNoteElement.Open = false;
                newParagraphNotePage.AddElement(newParagraphNoteElement);
            }

            // Make the HTML element with 'key_note' mapping ID a key note
            HtmlElementMapping keyNoteMapping = htmlToPdfConverter.HtmlElementsMappingOptions.HtmlElementsMappingResult.GetElementByMappingId("key_note");
            if (keyNoteMapping != null)
            {
                PdfPage keyNotePage = pdfDocument.GetPage(textNoteMapping.PdfRectangles[0].PageIndex);
                RectangleFloat keyNoteRectangle = keyNoteMapping.PdfRectangles[0].Rectangle;

                // Create the text note
                TextNoteElement keyNoteElement = new TextNoteElement(keyNoteRectangle, "This is an initially closed key note");
                keyNoteElement.NoteIcon = TextNoteIcon.Key;
                keyNoteElement.Open = false;
                keyNotePage.AddElement(keyNoteElement);
            }

            // Save the PDF document in a memory buffer
            byte[] outPdfBuffer = pdfDocument.Save();

            // Send the PDF file to browser
            FileResult fileResult = new FileContentResult(outPdfBuffer, "application/pdf");
            fileResult.FileDownloadName = "Text_Notes.pdf";

            return fileResult;
        }
    }
}
HTML String with Markers for Text Notes

XML
<!DOCTYPE html>
<html>
<head>
    <title>Add Text Notes to PDF</title>
</head>
<body style="font-family: 'Times New Roman'; font-size: 14px">
    <span style="font-size: 24px; font-weight: bold">Text Notes</span><br />
    <br />
    <span style="">Click the next icon to open the the text note:</span>
    <span data-mapping-enabled="true" data-mapping-id="text_note">&nbsp;&nbsp;</span><br />
    <br />
    <span style="">This is an already opened text note:</span>
    <span data-mapping-enabled="true" data-mapping-id="text_note_opened">&nbsp;&nbsp;</span><br />
    <br />
    <span style="">Click the next icon to open the the help note:</span>
    <span data-mapping-enabled="true" data-mapping-id="help_note">&nbsp;&nbsp;</span><br />
    <br />
    <span style="">This is an already opened help note:</span>
    <span data-mapping-enabled="true" data-mapping-id="help_note_opened">&nbsp;&nbsp;</span><br />
    <br />
    <span style="">Click the next icon to open the comment:</span>
    <span data-mapping-enabled="true" data-mapping-id="comment_note">&nbsp;&nbsp;</span><br />
    <br />
    <span style="">This is an already opened comment:</span>
    <span data-mapping-enabled="true" data-mapping-id="comment_note_opened">&nbsp;&nbsp;</span><br />
    <br />
    <span style="">Click the next icon to open the paragraph note:</span>
    <span data-mapping-enabled="true" data-mapping-id="paragraph_note">&nbsp;&nbsp;</span><br />
    <br />
    <span style="">Click the next icon to open the new paragraph note:</span>
    <span data-mapping-enabled="true" data-mapping-id="new_paragraph_note">&nbsp;&nbsp;</span><br />
    <br />
    <span style="">Click the next icon to open the key note:</span>
    <span data-mapping-enabled="true" data-mapping-id="key_note">&nbsp;&nbsp;</span><br />
</body>
</html>