# PageNumberField Object

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

- **Product:** DS Server
- **Section:** Reference
- **Kind:** Object
- **Introduced:** 30.0
- **Path:** DS Server > Reference > JavaScript API > PageNumberField Object
- **2128 words**
- **Web URL:** https://docs.textcontrol.com/ds-server/reference/javascript/pagenumberfield/
- **LLMs URL:** https://docs.textcontrol.com/ds-server/reference/javascript/pagenumberfield/llms.txt
- **LLMs-Full URL:** https://docs.textcontrol.com/ds-server/reference/javascript/pagenumberfield/llms-full.txt

---

### Description

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

### Syntax

```javascript
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.

```javascript
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);
```

---

## In This Section

- [Javascript: PageNumberField.getNumberFormat Method](https://docs.textcontrol.com/ds-server/reference/javascript/pagenumberfield/getnumberformat-method/llms-full.txt): Gets the number format.
- [Javascript: PageNumberField.getShowNumberOfPages Method](https://docs.textcontrol.com/ds-server/reference/javascript/pagenumberfield/getshownumberofpages-method/llms-full.txt): Gets a value indicating whether the field shows the page number or the total number of pages.
- [Javascript: PageNumberField.getStartNumber Method](https://docs.textcontrol.com/ds-server/reference/javascript/pagenumberfield/getstartnumber-method/llms-full.txt): Gets the page number for the first page.
- [Javascript: PageNumberField.setNumberFormat Method](https://docs.textcontrol.com/ds-server/reference/javascript/pagenumberfield/setnumberformat-method/llms-full.txt): Sets the number format.
- [Javascript: PageNumberField.setShowNumberOfPages Method](https://docs.textcontrol.com/ds-server/reference/javascript/pagenumberfield/setshownumberofpages-method/llms-full.txt): Sets a value indicating whether the field shows the page number or the total number of pages.
- [Javascript: PageNumberField.setStartNumber Method](https://docs.textcontrol.com/ds-server/reference/javascript/pagenumberfield/setstartnumber-method/llms-full.txt): Sets the page number for the first page.

---

## Nearby

- **Previous:** [Javascript: PageMargins.setTop Method](https://docs.textcontrol.com/ds-server/reference/javascript/pagemargins/settop-method/llms-full.txt)
- **Next:** [Javascript: PageNumberField.getNumberFormat Method](https://docs.textcontrol.com/ds-server/reference/javascript/pagenumberfield/getnumberformat-method/llms-full.txt)