Javascript: TXTextControl.NumberFormat Enumeration
Description
Specifies the format of a numbered list.
Members
| Member | Description |
|---|---|
| None | A text selection contains different number formats. |
| ArabicNumbers | The list is numbered with Arabic numbers (1, 2, 3...). |
| Letters | The list is numbered with letters (a, b, c...). |
| CapitalLetters | The list is numbered with capital letters (A, B, C...). |
| RomanNumbers | The list is numbered with Roman numbers (I, II, III...). |
| SmallRomanNumbers | The list is numbered with small Roman numbers (i, ii, iii...). |
Examples
The following example uses TXTextControl.NumberFormat.ArabicNumbers (the list is numbered with Arabic numbers (1, 2, 3...).) in a document-editing workflow.
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.setNumberFormat(
TXTextControl.NumberFormat.ArabicNumbers,
function() {
console.log("set number format completed.");
}
);
}, onTxError);
}, onTxError);