TX Text Control .NET Server

PageNumberField Object

Object|Introduced in 30.0

Description

The PageNumberField object supports text field formats of applications such as Microsoft Word.

Syntax

PageNumberField

Examples

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

MethodDescription
getBoundsGets the bounding rectangle of a text field. (Inherited from TextField.)
getContainsInputPositionReturns true, if the Textfield contains the current text input position. (Inherited from TextField.)
getDeleteableGets whether a text field can be deleted by the end-user while a TX Text Control document is being edited. (Inherited from TextField.)
getDoubledInputPositionSets whether a text field has a doubled input position in front of its first character and behind its last character. (Inherited from TextField.)
getEditableGets 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.)
getFormattingBoundsGets the formatting rectangle of a text field. (Inherited from TextField.)
getHighlightColorGets the highlight color for the text field. (Inherited from TextField.)
getHighlightModeGets a value indicating when the text field is highlighted. (Inherited from TextField.)
getIDGets an identifier for a text field. (Inherited from TextField.)
getIsSpellCheckingEnabledGets whether a text field's text is checked on misspelled words. (Inherited from TextField.)
getLengthGets the number of characters in a text field. (Inherited from TextField.)
getNameRelates a user-defined name to a text field. (Inherited from TextField.)
getNumberFormatGets the number format.
getShowNumberOfPagesGets a value indicating whether the field shows the page number or the total number of pages.
getStartGets the first character position (one-based) of a text field. (Inherited from TextField.)
getStartNumberGets the page number for the first page.
getTextGets the text which is contained within a text field. (Inherited from TextField.)
scrollToSets the current input position to the beginning of a text field and scrolls it into the visible part of the document. (Inherited from TextField.)
setDeleteableSets whether a text field can be deleted by the end-user while a TX Text Control document is being edited. (Inherited from TextField.)
setDoubledInputPositionGets whether a text field has a doubled input position in front of its first character and behind its last character. (Inherited from TextField.)
setEditableSets 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.)
setHighlightColorSets the highlight color for the text field. (Inherited from TextField.)
setHighlightModeSets a value indicating when the text field is highlighted. (Inherited from TextField.)
setIDSets an identifier for the text field. (Inherited from TextField.)
setIsSpellCheckingEnabledGets whether a text field's text is checked on misspelled words. (Inherited from TextField.)
setNameSets the name of a text field. (Inherited from TextField.)
setNumberFormatSets the number format.
setShowNumberOfPagesSets a value indicating whether the field shows the page number or the total number of pages.
setStartNumberSets the page number for the first page.
setTextSets the text which is contained within a text field. (Inherited from TextField.)