Click or drag to resize

HtmlToRtfHeaderFooter Class

Class which allows to specify header and footer in HTML, RTF or Text formats.
Inheritance Hierarchy
SystemObject
  SautinSoftHtmlToRtfHeaderFooter

Namespace: SautinSoft
Assembly: SautinSoft.HtmlToRtf (in SautinSoft.HtmlToRtf.dll) Version: 2024.12.12
Syntax
Copy
[ProgIdAttribute("SautinSoft.HtmlToRtf.HeaderFooter")]
public class HeaderFooter

The HtmlToRtfHeaderFooter type exposes the following members.

Constructors
 NameDescription
Public methodCode exampleHtmlToRtfHeaderFooter Creates a new instance of the SautinSoft.HtmlToRtf.CHeaderFooter class
Top
Properties
 NameDescription
Public propertyMarginBottom Get and set the bottom margin for page header/footer in desired measurement units.
Public propertyMarginTop Get and set the top margin for page header/footer in desired measurement units.
Top
Methods
 NameDescription
Public methodClear Clears the header/footer settings.
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Public methodFromHtmlFile Set page header/footer from any HTML file.
Public methodCode exampleFromHtmlURL Set page header/footer from HTML document using URL.
Public methodFromRtfFile Set page header/footer from local RTF file.
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Public methodCode exampleHtml Set page header/footer from any HTML string.
Public methodCode exampleRtf Set page header/footer in RTF format.
Public methodText Set simple text string in header/footer
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Top
Example
Add page header and footer using C#
Copy
using System;
using System.IO;
using SautinSoft;
using static SautinSoft.HtmlToRtf;

namespace Sample
{
    class Test
    {
        static void Main(string[] args)
        {
            // Get your free 100-day key here:   
            // https://sautinsoft.com/start-for-free/

            // Add a page header and footer during the conversion of HTML to RTF or DOCX.
            // If you need more information about "HTML to RTF .Net" email us at:
            // support@sautinsoft.com.
            AddHeaderAndFooter();
        }

        public static void AddHeaderAndFooter()
        {
            SautinSoft.HtmlToRtf h = new SautinSoft.HtmlToRtf();
            HtmlConvertOptions opt = new HtmlConvertOptions();
            opt.OutputFormat = HtmlToRtf.OutputFormat.Docx;

            string inpFile = @"..\..\..\Sample.html";
            string outFile = "Result.docx";

            // Set page header and footer.
            string headerFromHtml = File.ReadAllText(@"..\..\..\header.html");
            string footerFromRtf = File.ReadAllText(@"..\..\..\footer.rtf");

            // Add page header.
            opt.PageSetup.PageHeader.Html(headerFromHtml);

            // Add extra space between header and page contents.
            opt.PageSetup.PageHeader.MarginBottom.Mm(10);

            // Add page footer.
            opt.PageSetup.PageFooter.Rtf(footerFromRtf);

            if (h.Convert(inpFile, outFile, opt))
            {
                // Open the result for demonstration purposes.
                System.Diagnostics.Process.Start(new System.Diagnostics.ProcessStartInfo(outFile) { UseShellExecute = true });
            }
        }
    }
}
Add page header and footer using VB.Net
Copy
Imports System
Imports System.IO
Imports SautinSoft
Imports SautinSoft.HtmlToRtf

Namespace Sample
    Friend Class Test
        Shared Sub Main(ByVal args() As String)
            ' Get your free 100-day key here:   
            ' https://sautinsoft.com/start-for-free/

            ' Add a page header and footer during the conversion of HTML to RTF or DOCX.
            ' If you need more information about "HTML to RTF .Net" email us at:
            ' support@sautinsoft.com.
            AddHeaderAndFooter()
        End Sub

        Public Shared Sub AddHeaderAndFooter()
            Dim h As New SautinSoft.HtmlToRtf()
            Dim opt As New HtmlConvertOptions()
            opt.OutputFormat = HtmlToRtf.OutputFormat.Docx

            Dim inpFile As String = "..\..\..\Sample.html"
            Dim outFile As String = "Result.docx"

            ' Set page header and footer.
            Dim headerFromHtml As String = File.ReadAllText("..\..\..\header.html")
            Dim footerFromRtf As String = File.ReadAllText("..\..\..\footer.rtf")

            ' Add page header.
            opt.PageSetup.PageHeader.Html(headerFromHtml)

            ' Add extra space between header and page contents.
            opt.PageSetup.PageHeader.MarginBottom.Mm(10)

            ' Add page footer.
            opt.PageSetup.PageFooter.Rtf(footerFromRtf)

            If h.Convert(inpFile, outFile, opt) Then
                ' Open the result for demonstration purposes.
                System.Diagnostics.Process.Start(New System.Diagnostics.ProcessStartInfo(outFile) With {.UseShellExecute = True})
            End If
        End Sub
    End Class
End Namespace
See Also