PageNumberField.ShowNumberOfPages Property — TX Text Control .NET Server

ShowNumberOfPages Property

Property|Introduced in 19.0

Namespace: TXTextControl

Package: TXTextControl.TextControl.Core.SDK as TXTextControl.Core.dll from the private NuGet feed or Text Control Offline Packages

Also in: TXTextControl.TextControl.ASP.SDK as TXTextControl.dll

Description

Gets or sets a value indicating whether the field shows the page number or the total number of pages.

Syntax

public bool ShowNumberOfPages { get; set; }

Public Property ShowNumberOfPages As Boolean

Examples

The following example appends a field that displays the total number of pages after “Page X of”.

textControl.HeadersAndFooters.Add(HeaderFooterType.Footer);
HeaderFooter footer = textControl.HeadersAndFooters.GetItem(HeaderFooterType.Footer);
footer.Selection.Text = "Page ";
footer.PageNumberFields.Add(new PageNumberField());
footer.Selection.Text = " of ";
PageNumberField pageNumberField = new() { ShowNumberOfPages = true };
footer.PageNumberFields.Add(pageNumberField);

textControl.HeadersAndFooters.Add(HeaderFooterType.Footer)
Dim footer As HeaderFooter = textControl.HeadersAndFooters.GetItem(HeaderFooterType.Footer)
footer.Selection.Text = "Page "
footer.PageNumberFields.Add(New PageNumberField())
footer.Selection.Text = " of "
Dim pageNumberField As New PageNumberField() With { .ShowNumberOfPages = True }
footer.PageNumberFields.Add(pageNumberField)