PageNumberField Object
Description
The PageNumberField object supports text field formats of applications such as Microsoft Word.
Syntax
PageNumberFieldExamples
The following example demonstrates PageNumberField in a practical document-editing workflow. The PageNumberField object supports text field formats of applications such as Microsoft Word.
function onTxError(error) {
console.error("TX Text Control error:", error.msg);
error.handled = true;
}
TXTextControl.textParts.getMainText(function(mainText) {
const pageNumberFields = mainText.pageNumberFields;
pageNumberFields.getItem(function(pageNumberField) {
if (!pageNumberField) {
console.warn("No page number field is available at the current input position.");
return;
}
pageNumberField.getNumberFormat(
function(result) {
if (!result) {
console.warn("No number format was returned.");
return;
}
console.log("get number format result:", result);
},
onTxError
);
}, onTxError);
}, onTxError);Members
Methods
| Method | Description |
|---|---|
| getBounds | Gets the bounding rectangle of a text field. (Inherited from TextField.) |
| getContainsInputPosition | Returns true, if the Textfield contains the current text input position. (Inherited from TextField.) |
| getDeleteable | Gets whether a text field can be deleted by the end-user while a TX Text Control document is being edited. (Inherited from TextField.) |
| getDoubledInputPosition | Sets whether a text field has a doubled input position in front of its first character and behind its last character. (Inherited from TextField.) |
| getEditable | Gets whether the text of a text field can be changed by the end-user while a TX Text Control document is being edited. (Inherited from TextField.) |
| getFormattingBounds | Gets the formatting rectangle of a text field. (Inherited from TextField.) |
| getHighlightColor | Gets the highlight color for the text field. (Inherited from TextField.) |
| getHighlightMode | Gets a value indicating when the text field is highlighted. (Inherited from TextField.) |
| getID | Gets an identifier for a text field. (Inherited from TextField.) |
| getIsSpellCheckingEnabled | Gets whether a text field's text is checked on misspelled words. (Inherited from TextField.) |
| getLength | Gets the number of characters in a text field. (Inherited from TextField.) |
| getName | Relates a user-defined name to a text field. (Inherited from TextField.) |
| getNumberFormat | Gets the number format. |
| getShowNumberOfPages | Gets a value indicating whether the field shows the page number or the total number of pages. |
| getStart | Gets the first character position (one-based) of a text field. (Inherited from TextField.) |
| getStartNumber | Gets the page number for the first page. |
| getText | Gets the text which is contained within a text field. (Inherited from TextField.) |
| scrollTo | Sets the current input position to the beginning of a text field and scrolls it into the visible part of the document. (Inherited from TextField.) |
| setDeleteable | Sets whether a text field can be deleted by the end-user while a TX Text Control document is being edited. (Inherited from TextField.) |
| setDoubledInputPosition | Gets whether a text field has a doubled input position in front of its first character and behind its last character. (Inherited from TextField.) |
| setEditable | Sets whether the text of a text field can be changed by the end-user while a TX Text Control document is being edited. (Inherited from TextField.) |
| setHighlightColor | Sets the highlight color for the text field. (Inherited from TextField.) |
| setHighlightMode | Sets a value indicating when the text field is highlighted. (Inherited from TextField.) |
| setID | Sets an identifier for the text field. (Inherited from TextField.) |
| setIsSpellCheckingEnabled | Gets whether a text field's text is checked on misspelled words. (Inherited from TextField.) |
| setName | Sets the name of a text field. (Inherited from TextField.) |
| setNumberFormat | Sets the number format. |
| setShowNumberOfPages | Sets a value indicating whether the field shows the page number or the total number of pages. |
| setStartNumber | Sets the page number for the first page. |
| setText | Sets the text which is contained within a text field. (Inherited from TextField.) |