TX Text Control .NET Server

TXTextControl Object

Object

Description

The TXTextControl JavaScript object provides a public API to manipulate the web editor via JavaScript functions in the browser.

Syntax

TXTextControl

Examples

The following example demonstrates TXTextControl in a practical document-editing workflow. The TXTextControl JavaScript object provides a public API to manipulate the web editor via JavaScript functions in the browser.

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

TXTextControl.getText(
    function(result) {
        console.log("get text result:", result);
    },
    onTxError
);

Members

Properties

Property	Description
applicationFields	Gets a collection of all Microsoft Word fields that have been created or imported from a Microsoft Word or RTF document. (Inherited from FormattedText.)
barcodes	Gets a collection of all barcode frames contained in the text part with the input focus. This can be the main text, a text frame or a header or footer. The property value is an object of the type BarcodeCollection.
barcodeTypeSettings	The type specific settings for the currently used barcode.
clipboardMode	Gets or sets the clipboard mode (client or server). The clipboard mode determines if the key combinations Ctrl+C, Ctrl+V and Ctrl+X copy to and from the client clipboard or if content is copied to and from the server clipboard. Possible values for this property are defined in the enumeration ClipboardMode.
comments	Gets a collection of all comments in this text part. (Inherited from FormattedText.)
connectionID	Returns the unique connection ID of this session.
contextMenusEnabled	Gets or sets if a right click into the text area opens a context menu or not.
controlChars	Obsolete. This property will be removed in one of the next versions. Gets or sets whether control characters are visible.
displayColors	The displayed colors of the text control.
documentLinks	Gets a collection of all links which point to targets in the same document. (Inherited from FormattedText.)
documentPermissions	The document permission settings.
documentSettings	The DocumentSettings class provides properties which inform about general document settings, such as author and title, contained in the document the user is currently working on. When such a document is saved with one of the Save methods all settings are automatically stored.
documentTargetMarkers	Gets or sets whether document target markers are visible.
documentTargets	Gets a collection of all document targets. (Inherited from FormattedText.)
editableRegions	Gets a collection of all editable regions. (Inherited from FormattedText.)
editMode	Obsolete. This property will be removed in one of the next versions. Gets or sets the edit mode the control is in. Must be set with one of the EditMode values.
footnotes	All footnotes contained in the main text of the document.
formFields	Gets a collection of all form fields in the text part. (Inherited from FormattedText.)
frames	Gets a collection of all frames in the document. (Inherited from FormattedText.)
headersAndFooters	Gets a collection of all headers and footers in the document.
hypertextLinks	Gets a collection of all hypertext links. (Inherited from FormattedText.)
images	Gets a collection of all images contained in the text part with the input focus. This can be the main text, a text frame or a header or footer.
inlineStyles	Gets a collection of all inline styles the current document contains.
inputFormat	All formatting attributes at the current text input position.
inputPosition	The current text input position.
isHyphenationEnabled	Obsolete. This property will be removed in one of the next versions. Use the setter and getter methods instead. Gets or sets a value indicating whether hyphenation is active or not.
isLanguageDetectionEnabled	Obsolete. This property will be removed in one of the next versions. Use the setter and getter methods instead. Gets or sets a value indicating whether language detection is active or not.
isLoadingDialogEnabled	Gets or sets whether a wait dialog is shown while a document is being loaded.
isSpellCheckingEnabled	Obsolete. This property will be removed in one of the next versions. Use the setter and getter methods instead. Gets or sets a value indicating whether spell checking is active or not.
isTrackChangesEnabled	Obsolete. This property will be removed in one of the next versions. Use the setter and getter methods instead. Gets or sets a value indicating whether change tracking is active or not.
lines	Gets a collection of all text lines. (Inherited from FormattedText.)
listFormat	The type and the formatting attributes of a bulleted or numbered list.
misspelledWords	Gets a collection of all misspelled words. (Inherited from FormattedText.)
pageMargins	The margins for the pages of the current document. The measure depends on the page unit. The default measure is 1/100th inch.
pages	Gets a collection of all pages in the document.
pageSize	The width and height of the pages for the current document. The measure depends on the page unit. The default measure is 1/100th inch.
paragraphFormat	The paragraph formatting attributes of the text displayed by the control.
paragraphs	Gets a collection of all paragraphs. (Inherited from FormattedText.)
paragraphStyles	All paragraph formatting styles in the current document.
ribbon	Gets the control's ribbon bar object. Use this property to manipulate the ribbon bar.
ribbonPermissionsTab	Returns the "Permissions" ribbon tab object.
rulerBar	The horizontal ruler bar.
saveDocumentQuestionDialogEnabled	Obsolete. This property will be removed in one of the next versions. Gets or sets if a confirmation dialog should be shown before discarding unsaved changes.
sections	Gets a collection of all sections in the document.
selection	Returns the current selection or sets the selection's position and length. The setter must be used as follows: TXTextControl.selection = { start: 2, length: 5 }
selection	Gets the current selection. (Inherited from FormattedText.)
sideBarToggleButton	The sidebar toggle button shown at the top right of the ribbon.
signatureFields	Gets a collection of all signature fields in the document.
statusBar	The status bar.
subTextParts	Gets the current subtextparts. (Inherited from FormattedText.)
tableGridLines	Gets or sets if table grid lines are visible.
tables	Gets a collection of all tables. (Inherited from FormattedText.)
tablesOfContents	Gets the current tables of contents. (Inherited from FormattedText.)
textChars	Gets a collection of all text characters. (Inherited from FormattedText.)
textFields	Gets a collection of all standard text fields. (Inherited from FormattedText.)
textFieldsEditable	Gets or sets if text fields are editable or not.
textFrameMarkerLines	Gets or sets if text frame marker lines are visible.
textFrames	Gets a collection of all text frames in the document.
textParts	Gets a collection of all main text parts the current document contains. The main text parts are the main text, text frames and headers and footers.
textPartType	Gets the Text part type. Possible values are "mainText", "headerFooter" and "textFrame". (Inherited from FormattedText.)
trackedChanges	Gets a collection of all tracked changes. (Inherited from FormattedText.)
verticalRulerBar	The vertical ruler bar.
zoomFactor	Obsolete. This property will be removed in one of the next versions. Gets or sets the zoom factor, in percent, for a Text Control. Must be greater than or equal to 10 or one of the special zoom factor values defined in SpecialZoomFactor.

Methods

Method	Description
addEventListener	The addEventListener function registers event listener functions on the TXTextControl object.
addMergeField	Inserts a merge field at the current input position.
addTextField	Obsolete. This method will be removed in one of the next versions. Inserts a new ApplicationField or TextField at the current input position.
append	Appends text to the document in a certain format.
appendDocument	Appends text in a certain format to the current document.
atobUTF8	Decodes a string of data which has been encoded using base-64 encoding.
beginUndoAction	Begins a user-defined undo operation. All editing and fomatting changes made between beginUndoAction and endUndoAction belong to the undo operation. These changes are undone or redone in a single step. The specified user-defined name is available via getUndoActionName.
btoaUTF8	Creates a base-64 encoded ASCII string from a unicode string. In contrast to the browser provided method btoa() this method handles all unicode characters and not only characters in the Latin1 range.
clear	Clears the selected text or the character right from the current input position.
clearUndo	Clears the undo buffer.
endUndoAction	Ends a user-defined undo operation. All editing and fomatting changes made between beginUndoAction and endUndoAction belong to the undo operation. These changes are undone or redone in a single step.
find	Finds a text string. The search starts at the specified position. (Inherited from FormattedText.)
flattenFormFields	Flatten all form fields in the document. This means that all form fields are converted to static text.
focus	Sets the text input focus to the web editor.
getActivationState	Gets a value indicating the current activation state. It can be activated, deactivated or disabled.
getAllowDrag	Gets a value indicating whether the view generator can be a source of a Drag&Drop operation.
getAllowDrop	Gets a value indicating whether the view generator can accept data that the user drags onto it.
getAllowUndo	Gets a value indicating whether the undo buffer is active or not.
getBackColor	Gets the Text Control's background color.
getBaseline	Gets the baseline alignment, in twips, of the Text Control.
getCanCharacterFormat	Informs whether the currently selected text can be formatted with character formatting attributes. The value depends on whether the formatting is allowed and the currently set edit mode.
getCanCopy	Informs whether a part of a Text Control document has been selected and can be copied to the clipboard. The value depends on whether the formatting is allowed and the currently set edit mode.
getCanDocumentFormat	Informs whether the document can be formatted with page and section formatting attributes. The value depends on whether the formatting is allowed and the currently set edit mode.
getCanPaste	Informs whether the document's text and/or formatting attributes can be changed. The value depends on DocumentPermissions.readOnly and the currently set edit mode.
getCanPrint	Informs whether the document can be printed. The value depends on the DocumentPermissions.allowPrinting and the currently set edit mode.
getCanRedo	Informs whether an operation can be re-done using the Redo method.
getCanStyleFormat	Informs whether the document can be formatted with formatting styles. The value depends on the DocumentPermissions.allowFormattingStyles and the currently set edit mode.
getCanTableFormat	Informs whether the currently selected text can be formatted with table formatting attributes.
getCanUndo	Gets a value indicating whether the user can undo the previous operation in a Text Control.
getCommentHighlightMode	Gets the global comment highlight mode.
getControlChars	Gets whether the control characters are visible or not.
getCultures	Returns the culture and the UI culture of the control. The UI culture affects the string resource language. The culture represents date and time string formats, for example.
getDocumentTargetMarkers	Gets a value indicating that markers for hypertext targets are shown or not.
getDrawingMarkerLines	Gets whether a marker frame is shown around a drawing to indicate its position and size.
getEditableRegionHighlightMode	Gets the global editable region highlight mode.
getEditMode	Gets a value indicating whether the document's text is protected, or can be freely edited and formatted.
getFileDirectory	Obsolete. This method will be removed in one of the next versions. Requests the directory path where the files of a specific file type are stored on the web server.
getFontUnderlineStyle	Gets underlining style for the text displayed by the control. This property only determines the style.
getForeColor	Gets the foreground color of the control which is the color of the document's text.
getFormattingPrinter	Returns the name of the currently selected formatting printer by calling a provided callback function. For more information on the formatting printer see function setFormattingPrinter.
getFormulaReferenceStyle	Gets a value determining how references to table cells in formulas are specified. Supported are the A1 and the R1C1 notation. The A1 notation specifies a table cell with a column letter and a row number, for example B3 refers to the table cell in the third row and the second column. The R1C1 notation addresses a table cell with a row number and a column number, for example R3C2 refers to the table cell in the third row and the second column. Relative addresses can be expressed with square brackets. R[-3]C[-2]. The numbers inside the square brackets show how many rows or columns the cell is relative to itself. Negative row numbers mean that the referenced cell is above the cell containing the formula. Negative column numbers mean that the referenced cell is to the left of the cell containing the formula.
getInsertionMode	Gets the insertion mode.
getInstalledPrinters	Gets the names of the printers installed on the server which are usable by Text Control.
getIsFormFieldValidationEnabled	Gets a value indicating whether form field validation is active or not.
getIsFormulaCalculationEnabled	Gets a value indicating whether formulas in tables are automatically calculated when the text of an input cell is changed.
getIsHyphenationEnabled	Gets a value indicating whether hyphenation is active or not.
getIsLanguageDetectionEnabled	Gets a value indicating whether language detection is active or not.
getIsSpellCheckingEnabled	Gets a value indicating whether spell checking is active or not.
getIsTrackChangesEnabled	Gets a value indicating whether track changes is active or not.
getLandscape	Gets a value indicating whether the page orientation is landscape.
getPageCount	Gets the number of pages contained in the current document.
getPageUnit	Gets the measure used for page sizes and page margins.
getPermanentControlChars	Gets a value indicating which control characters are shown permanently on the screen.
getRedoActionName	Gets a string that represents the name of the action that will be performed when a call to the redo method is made.
getRenderMode	Gets the component render mode.
getSelectObjects	Gets a value controlling the selection of objects which are inserted behind the text. When the property is set to true, a mouse click selects the object behind the text. Otherwise, when this property is set to false, text in front of the object can be selected.
getStatusBarColor	Returns the background color of the status bar by calling a provided callback function.
getSubTextParts	Obsolete. This method will be removed in one of the next versions. Requests a collection of either all subtextparts the current text part contains or only the subtextpart containing the input position from the server and returns the collection by calling a callback function which has to be provided as a parameter to the function.
getSupportedFonts	Gets an array of strings specifying the names of all currently supported fonts.
getSupportedPaperSizes	Gets an array of PaperSize structures specifying the names and the size of all currently supported paper sizes.
getText	Gets the control's text.
getTextBackColor	Gets the background color for the text.
getTextFields	Obsolete. This method will be removed in one of the next versions. Requests a collection of either all text fields the current text part contains or only the text field containing the input position from the server and returns the collection by calling a callback function which has to be provided as a parameter to the function.
getTextFieldsByType	Returns an array of static text field information objects. (Inherited from FormattedText.)
getTextFrameMarkerLines	Gets whether text frames that have no border line are shown with marker lines.
getTextParts	Obsolete. This method will be removed in one of the next versions. Requests a collection of either all text parts the current document contains or only the text part containing the input position from the server and returns the collection by calling a callback function which has to be provided as a parameter to the function.
getUndoActionName	Gets a string that represents the name of the action that will be performed when a call to the undo method is made. The property's value is null if there is no action that can be undone.
getUserNames	Gets a list of names specifying users who have access to editable regions. When a document is set to read-only all editable regions that are related to these users can be edited.
getViewMode	Gets the mode how Text Control displays a document.
init	Initializes the document editor.
load	Loads text in a certain format. The complete contents of the web editor are replaced.
loadDocument	Loads text in a certain format. The complete contents of the web editor are replaced.
loadJsonData	Loads JSON data which is used to create table and field name menu items in the mailings ribbon tab.
loadSelection	Obsolete. This method will be removed in one of the next versions. Loads text in a certain format into the current selection.
loadXMLDatabase	Loads an XML database which is used to create table and field name menu items in the mailings ribbon tab.
printDocument	Attempts to print the current document in the browser. Not all browsers support this.
redo	Redoes the last Text Control operation.
refreshLayout	Forces a layout refresh of the document editor. Use this method in cases where the editor doesn't automatically react to layout changes of your web site.
removeEventListener	The removeListener function removes the specified event listener from the TXTextControl object.
removeFromDom	Closes the WebSocket connection gracefully and removes the whole editor from the DOM.
removeTextField	Obsolete. This method will be removed in one of the next versions. The removeTextField method removes a text field from the document.
resetContents	Deletes the entire contents of the control.
save	Saves the current document in a certain format and sends the result back asynchronously by calling a given callback function.
saveDocument	Saves the current document in a certain format and sends the result back asynchronously by calling a given callback function.
saveSelection	Obsolete. This method will be removed in one of the next versions. Saves the current selection in a certain format and sends the result back asynchronously by calling a given callback function.
select	Selects text within the control.
selectAll	Selects all text in the control.
selectWord	Selects the word at the current text input position.
setActivationState	Sets a value indicating the current activation state. It can be activated, deactivated or disabled.
setAllowDrag	Sets a value indicating whether the view generator can be a source of a Drag&Drop operation.
setAllowDrop	Sets a value indicating whether the view generator can accept data that the user drags onto it.
setAllowUndo	Sets a value indicating whether the undo buffer is active or not.
setBackColor	Sets the Text Control's background color.
setBaseline	Sets the baseline alignment, in twips, of the Text Control.
setCommentHighlightMode	Sets the global comment highlight mode.
setControlChars	Sets whether the control characters are visible or not.
setDocumentTargetMarkers	Sets a value indicating that markers for hypertext targets are shown or not.
setDrawingMarkerLines	Sets whether a marker frame is shown around a drawing to indicate its position and size.
setEditableRegionHighlightMode	Sets the global editable region highlight mode.
setEditMode	Sets a value indicating whether the document's text is protected, or can be freely edited and formatted.
setFileDirectory	Obsolete. This method will be removed in one of the next versions. For security reasons, the setFileDirectory method has been removed. Please set the file directory on the server side using the TXTextControl.Web.MVC.TextControl.SetFileDirectory or WebSocketHandler.SetFileDirectory method. Sets the directory path where the files of a specific file type are stored on the web server.
setFontUnderlineStyle	Sets underlining style for the text displayed by the control. This property only determines the style.
setForeColor	Sets the foreground color of the control which is the color of the document's text.
setFormattingPrinter	Sets the name of a printer the text dimensions and capabilities of which are used to format the document. If the document is printed with this printer the displayed and the printed document have the same dimensions. If the property is set to "Standard", the system installed standard printer is used to format the document. If the property is set to "Display", the font dimensions of the display device are used to format the document. If the specified printer is not installed, the standard printer is used.
setFormulaReferenceStyle	Sets a value determining how references to table cells in formulas are specified. Supported are the A1 and the R1C1 notation. The A1 notation specifies a table cell with a column letter and a row number, for example B3 refers to the table cell in the third row and the second column. The R1C1 notation addresses a table cell with a row number and a column number, for example R3C2 refers to the table cell in the third row and the second column. Relative addresses can be expressed with square brackets. R[-3]C[-2]. The numbers inside the square brackets show how many rows or columns the cell is relative to itself. Negative row numbers mean that the referenced cell is above the cell containing the formula. Negative column numbers mean that the referenced cell is to the left of the cell containing the formula.
setInputPositionByLocation	Sets a new input position from a geometric location.
setInputPositionByPage	Sets a new input position from a page, line and column number.
setInputPositionByTextPosition	Sets a new input position from a text position.
setInsertionMode	Sets the insertion mode.
setIsFormFieldValidationEnabled	Sets a value indicating whether form field validation is active or not.
setIsFormulaCalculationEnabled	Sets a value indicating whether formulas in tables are automatically calculated when the text of an input cell is changed.
setIsHyphenationEnabled	Sets a value indicating whether hyphenation is active or not.
setIsLanguageDetectionEnabled	Sets a value indicating whether language detection is active or not.
setIsSpellCheckingEnabled	Sets a value indicating whether spell checking is active or not.
setIsTrackChangesEnabled	Sets a value indicating whether track changes is active or not.
setLandscape	Sets a value indicating whether the page orientation is landscape.
setPageUnit	Sets the measure used for page sizes and page margins.
setPermanentControlChars	Sets a value indicating which control characters are shown permanently on the screen.
setRenderMode	Sets the component render mode. This property only works with the Microsoft Windows based .NET 4 backend. With the platform independent backend, an error is thrown because there is only the SVG based render mode.
setSelectObjects	Sets a value controlling the selection of objects which are inserted behind the text. When the property is set to true, a mouse click selects the object behind the text. Otherwise, when this property is set to false, text in front of the object can be selected.
setStatusBarColor	Sets the background color of the status bar.
setText	Sets the control's text.
setTextBackColor	Sets the background color for the text.
setTextFrameMarkerLines	Sets whether text frames that have no border line are shown with marker lines.
setViewMode	Sets the mode how Text Control displays a document.
showDialog	Shows a built-in dialog box.
showHorizontalRuler	Shows or hides the web editor's horizontal ruler bar.
showHtmlDialog	Shows one of the a built-in HTML dialog boxes.
showMergeFieldDialog	Opens a field dialog either for changing properties of an existing merge field or for creating a new merge field. If the fieldType parameter is omitted, the field dialog for the merge field at the current input position is shown (if there is one). Setting the fieldType parameter to a valid value creates a new field or replaces the field at the current position.
showRibbonBar	Shows or hides the ribbon bar.
showSideBar	Shows or hides a specified side bar.
showStatusBar	Shows or hides the web editor's status bar.
showVerticalRuler	Shows or hides the web editor's vertical ruler bar.
undo	Undoes the last Text Control operation.
zoom	Zooms the contents of the TextControl.

Enumerations

Enumeration	Description
ActivationState	The current activation state. It can be activated, deactivated or disabled.
AddResult	Specifies the result when a subtextpart has been added to the document. The object has the following properties:
AppendSettings	Determines how text is appended to the document.
ApplicationFieldFormat	The possible application field formats.
AutoBaseline	Specifies how text is automatically sub- or superscripted.
AutoGenerationType	Defines the type of document link auto-generation.
BarcodeAlignment	Determines the alignment of the barcode image inside the control.
BarcodeTextAlignment	Determines the alignment of the barcode text and additional text that is displayed inside the control.
BreakType	Specifies where and how a text or section breaks.
CapitalizationSettings	Specifies the settings for capitalization.
Capitals	Specifies whether the lowercase letters of text are displayed with capital letters.
ChangeKind	Specifies the kind of a tracked change.
ClipboardMode	Possible clipboard modes.
ComponentRenderMode	Component render mode.
ContextMenuLocation	Determines the location in the document where a context menu will be shown.
ControlChars	Determines values for the control characters used in a TextControl document.
DialogBoxKind	Possible built-in dialog box types.
Direction	Determines the writing direction of a paragraph.
DocumentAccessPermissions	Specifies how a document can be accessed after it has been opened.
EditMode	Determines the possible document edit modes.
FieldType	Determines the possible MS Word specific merge field types supported by the TX Text Control JavaScript API.
FileType	Specifies the kind of file types. The object has the following properties:
FindOptions	Determines search options for the find method.
FontUnderlineStyle	Specifies the style of the underline below a text.
FormulaReferenceStyle	Specifies the style of references to table cells in formulas.
Frame	Determines which frame borders are visible of an image, text frame, chart, barcode or drawing.
FrameInsertionMode	Determines how the frame of an image, text frame, chart, barcode or drawing can be inserted in the text.
FrameStyle	Determines the style of a frame of an image, text frame, chart, barcode or drawing. The object has the following properties:
HeaderFooterType	Determines the type of a header or footer.
HighlightMode	Contains all possible highlight mode values.
HorizontalAlignment	Specifies the horizontal alignment of a text.
HtmlDialogBoxKind	Possible built-in HTML based dialog box types.
ImageFormat	Specifies the file format of an image.
ImageInsertionMode	Determines how an image can be inserted in the text.
InsertionMode	Determines how text is inserted at the current input position when text is typed or inserted.
Justification	Specifies the kind of justification.
ListFormatCharacter	Specifies the list format character.
ListType	Specifies the type of a list.
MeasuringUnit	Specifies the measuring unit.
MergeFieldTextFormat	Determines the possible text formats for merge fields containing text.
MisspelledWordKind	Specifies the kind of a misspelled word.
NumberFormat	Specifies the format of a numbered list.
PageContent	Defines the contents of a page's image returned from the Page.getImage method.
PermanentControlChar	Defines a control character which is shown permanently on the screen.
RelationalOperator	Determines the relational operator used by some types of merge fields.
RulerBarBorderStyle	The border style of a ruler bar.
RulerBarFormulaMode	Specifies whether a ruler bar shows cell references when the current input position is in a table cell.
RulerBarScaleUnit	Specifies whether a ruler bar shows cell references when the current input position is in a table cell.
SectionBreakKind	Specifies the kind of a section break.
SideBarType	Specifies the existing side bar types.
SpecialZoomFactor	Determines the special zoom factor values for property TXTextControl.zoomFactor.
StatusBarBorderStyle	Obsolete. This enumeration will be removed in one of the next versions. Since version 33.0 it's not possible to change the border style of the status bar anymore. The border style of a status bar.
StreamType	Determines a certain text format.
TableAddPosition	Specifies the position where to split the table.
TabLeader	Defines how a tab gap is filled.
TabType	Determines the tabulator type.
TextFieldPosition	Specifies special text input positions at the beginning and the end of a text field.
TextFieldType	Possible types of text fields.
TextFrameInsertionMode	Determines how a text frame can be inserted in the text.
TextType	Specifies how a text is represented and interpreted.
VerticalAlignment	Specifies the vertical alignment of a text.
ViewMode	The mode how Text Control displays a document.
ZOrder	Specifies how the z-order of a frame (image, text frame, chart, barcode or drawing) can be changed.

Further Reading

Signing Documents with the Angular DocumentViewer – August 11, 2020
Angular: Loading Documents on Initializing TX Text Control – August 7, 2020