Allows to set a custom page numbering in the output RTF or DOCX document.

Namespace:  SautinSoft
Assembly:  SautinSoft.HtmlToRtf (in SautinSoft.HtmlToRtf.dll) Version: 7.1.4.17

Syntax

      
 C#  Visual Basic 
public class CPageNumbers
Public Class CPageNumbers

Members

      
 All Members  Properties  
 Public

 Protected
 Instance

 Static 
 Declared

 Inherited
 XNA Framework Only 

 .NET Compact Framework Only 

 MemberDescription
AlignH
Get and set the horizontal alignment for the page numbering.
AlignV
Get and set the vertical alignment for the page numbering.
Appearance
Get and set the appearance of page numbering: start from the first page, start from the second page or disabled.
Font
Allows to set up custom font family and size for page numbers string
Format
Specify the formatted string with page numbering, for example: "Page {page} of {numpages}". Default: Empty()()().
X
Get and set the position of page numbering by horizontal. Starts from the top left page corner.
Y
Get and set the position of page numbering by vertical. Starts from the top left page corner.

Remarks

Using this property you may set custom page numbers as you wish. Use this property together with the Appearance, AlignH and AlignV.

These are special keywords to set the custom page numbering:

{page} - Current page number.
{numpages} - Total pages.
By default: Page numbers are located at the left-bottom of the page and represent digit(s), for example "1".

These are samples of using this property:

h.PageStyle.PageNumbers.Format = "Page {page} of {numpages}";

h.PageStyle.PageNumbers.Format = "This is page number {page}";

h.PageStyle.PageNumbers.Format = "Seite {page} von {numpages}";





Examples

CopyHow to add page numbering using C#
using System;
using System.IO;

namespace Sample
{
    class Test
    {

        static void Main(string[] args)
        {
            // Add page numbering during to HTML to RTF conversion.
            // If you need more information about "HTML to RTF .Net" email us at:
            // support@sautinsoft.com        
            AddPageNumbering();

        }

        public static void AddPageNumbering()
        {
            SautinSoft.HtmlToRtf h = new SautinSoft.HtmlToRtf();

            // After purchasing the license, please insert your serial number here to activate the component.
            // h.Serial = "XXXXXXXXX";

            string inputFile = @"..\..\sample.html";
            string outputFile = Path.ChangeExtension(inputFile, ".rtf");

            // Add page numbering.
            // Let's set page numbers from 1st page
            h.PageStyle.PageNumbers.Appearance = SautinSoft.HtmlToRtf.ePageNumberingAppearence.PageNumFirst;

            // Lest's align page numbers by top-center
            h.PageStyle.PageNumbers.AlignV = SautinSoft.HtmlToRtf.eAlign.Top;
            h.PageStyle.PageNumbers.AlignH = SautinSoft.HtmlToRtf.eAlign.Center;

            // Lest's set page numbers format as "Page 1 of 20".
            h.PageStyle.PageNumbers.Format = "Page {page} of {numpages}";

            // Set page numbers font: Calibry, 36.
            h.PageStyle.PageNumbers.Font.Face = SautinSoft.HtmlToRtf.eFontFace.f_Calibri;
            h.PageStyle.PageNumbers.Font.Size = 36;


            if (h.OpenHtml(inputFile))
            {
                bool ok = h.ToDocx(outputFile);

                // Open the result for demonstration purposes.
                if (ok)
                    System.Diagnostics.Process.Start(new System.Diagnostics.ProcessStartInfo(outputFile) { UseShellExecute = true });
            }
        }
    }
}
CopyHow to add page numbering using VB.Net
Imports System
Imports System.IO
Imports System.Text

Module Module1
    Sub Main()
        ' Add page numbering during to HTML to RTF conversion.
        ' If you need more information about "HTML to RTF .Net" email us at:
        ' support@sautinsoft.com        
        AddPageNumbering()
    End Sub

    Public Sub AddPageNumbering()
        Dim h As New SautinSoft.HtmlToRtf()

        ' After purchasing the license, please insert your serial number here to activate the component.
        'h.Serial = "XXXXXXXXX"


        Dim inputFile As String = "..\sample.html"
        Dim outputFile As String = Path.ChangeExtension(inputFile, ".rtf")

        ' Add page numbering.
        ' Let's set page numbers from 1st page
        h.PageStyle.PageNumbers.Appearance = SautinSoft.HtmlToRtf.ePageNumberingAppearence.PageNumFirst

        ' Lest's align page numbers by top-center
        h.PageStyle.PageNumbers.AlignV = SautinSoft.HtmlToRtf.eAlign.Top
        h.PageStyle.PageNumbers.AlignH = SautinSoft.HtmlToRtf.eAlign.Center

        ' Lest's set page numbers format as "Page 1 of 20".
        h.PageStyle.PageNumbers.Format = "Page {page} of {numpages}"

        ' Set page numbers font: Calibry, 36.
        h.PageStyle.PageNumbers.Font.Face = SautinSoft.HtmlToRtf.eFontFace.f_Calibri
        h.PageStyle.PageNumbers.Font.Size = 36

        If h.OpenHtml(inputFile) Then
            Dim ok As Boolean = h.ToDocx(outputFile)

            ' Open the result for demonstration purposes.
            If ok Then
                System.Diagnostics.Process.Start(New System.Diagnostics.ProcessStartInfo(outputFile) With {.UseShellExecute = True})
            End If
        End If
    End Sub
End Module

Inheritance Hierarchy

System..::.Object
  SautinSoft..::.HtmlToRtf..::.CPageStyle..::.CPageNumbers

See Also