TXTextControl.PageNumberFieldCollection Class

An instance of the PageNumberFieldCollection class contains the page number fields in a header or footer of a Text Control document. Page number fields are represented through objects of the type PageNumberField. An instance of this class can be obtained with the HeaderFooter.PageNumberFields property. The PageNumberFieldCollection class implements the IEnumerable and the ICollection interfaces. For more information see the technical article Text Fields and Hypertext Links.

Syntax

[C#]
public sealed class PageNumberFieldCollection: TextFieldCollectionBase
[Visual Basic]
Public NotInheritable Class PageNumberFieldCollection
  Inherits TextFieldCollectionBase

Properties

Property Description
CanAdd Gets a value indicating whether a new text field can be inserted at the current input position. (Inherited from TextFieldCollectionBase.)
Count Gets the number of elements contained in the collection. (Inherited from TextFieldCollectionBase.)
IsSynchronized Returns true if the collection is designed to be thread safe, otherwise, it returns false. (Inherited from TextFieldCollectionBase.)
SyncRoot Gets an object that can be used to synchronize access to the collection. (Inherited from TextFieldCollectionBase.)

Methods

Method Description
Add Inserts a new page number field at the current input position of a header or footer.
Clear Removes all page number fields contained in the collection from the document.
CopyTo Copies the elements of the collection to an array, starting at a particular index.
GetEnumerator Returns an enumerator that can be used to iterate through the collection. (Inherited from TextFieldCollectionBase.)
GetItem Overloaded. Gets a particular page number field from the collection.
Remove Removes a page number from a header or footer of a Text control document.

See Also