TX Text Control .NET Server

PageCollection Class

Class|Introduced in 14.0
Namespace
TXTextControl
Package
TXTextControl.TextControl.Core.SDK from the private NuGet feed or Text Control Offline Packages
Assembly
TXTextControl.Core.dll
Install
dotnet add package TXTextControl.TextControl.Core.SDK .NET 8 and later. For .NET Framework, reference TXTextControl.dll from the setup.
Also in
TXTextControl.TextControl.ASP.SDK as TXTextControl.dll
Implements
ICollection, IEnumerable

Description

An instance of the PageCollection class contains all pages of a document. A document has at least one page. An instance of this class can be obtained with the TextControl.GetPages method. The PageCollection class implements the IEnumerable and the ICollection interfaces.

Syntax

public sealed class PageCollection : ICollection, IEnumerable

Examples

The following example works with the laid-out pages of a short report.

textControl.Text = "Quarterly results\nRevenue increased by 12%.";
PageCollection pageCollection = textControl.GetPages();

Members

Properties

PropertyDescription
CountGets the number of elements contained in the collection.
ItemGets a page from the collection. In C# this property is the indexer for the PageCollection class.

Methods

MethodDescription
CopyToCopies the elements of the collection to an array, starting at a particular index.
GetEnumeratorReturns an enumerator that can be used to iterate through the collection.
GetItemGets a particular page from the collection.

Further Reading