Description

Determines values for the control characters used in a TextControl document.

Members

Member	Description
Tab	Defines a tabulator (Keyboard: TAB).
ParagraphEnd	Defines the end of a paragraph (Keyboard: ENTER).
LineBreak	Defines a line break without beginning a new paragraph (Keyboard: SHIFT+ENTER).
PageBreak	Defines a page break (Keyboard: CTRL+ENTER).
ColumnBreak	Defines a page column break (Keyboard: CTRL+SHIFT+ENTER).
NonVisibleHyphen	Defines a non-visible hyphen (Keyboard: CTRL+(-)).
NonBreakingSpace	Defines a non-breaking space (Keyboard: CTRL+SHIFT+Space).

Examples

The following example uses TXTextControl.ControlChars.Tab (defines a tabulator (Keyboard: TAB).) in a document-editing workflow.

function onTxError(error) {
    console.error("TX Text Control error:", error.msg);
    error.handled = true;
}

function applyControlChars(textChars) {
    textChars.addControlChar(
        TXTextControl.ControlChars.Tab,
        -1,
        function(result) {
            if (result) {
                console.log("add control char is available.");
            } else {
                console.warn("add control char is not available in the current document state.");
            }
        },
        onTxError
    );
}