JavaScript interface

We are working on many improvements of the JavaScript API to manipulate documents client-side using the HTML5-based editor for ASP.NET MVC and Web Forms.

Clipboard

In version X15 of TX Text Control, it will be possible to switch between the two different clipboards using a toggle button or the JavaScript API. In case, the local clipboard is activated, an HTML form element is simulated and content can be pasted into the control and copied from the control to the local clipboard.

Property Value Type Description
TXTextControl.clipboardMode integer 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 class TXTextControl.ClipboardMode.
Event Value Type Description
clipboardModeChanged ClipboardModeChangedEventArgs Is fired when the clipboard mode has changed.
clipboardDataTransferStart clipboardDataTransferStartEventArgs Is fired when a clipboard data transfer starts.
clipboardDataTransferProgress clipboardDataTransferProgressEventArgs Is fired for each transfered clipboard data packet.
clipboardDataTransferComplete clipboardDataTransferCompleteEventArgs Is fired when a clipboard data transfer is completed.
clipboardDataTransferAborted clipboardDataTransferAbortedEventArgs Is fired when an ongoing clipboard data transfer is aborted.

Read more about the typical applications for these features in this article:

Sneak Peek X15: Copy to Local Clipboard Support in ASP.NET Version

Text Fields

TX Text Control X15 will provide a general interface to add, remove and modify all text field types including MS Word merge fields (TXTextControl.DocumentServer.Fields.FieldAdapter), form fields and TX Text Control text fields.

Class Description
TXTextControl.DateField Represents an MS Word specific DATEFIELD field.
TXTextControl.FieldType Determines the possible MS Word specific merge field types supported by the TX Text Control JavaScript API.
TXTextControl.IfField Represents an MS Word specific IFFIELD field.
TXTextControl.IncludeTextField Represents an MS Word specific INCLUDETEXT field.
TXTextControl.MergeField Represents an MS Word specific MERGEFIELD field.
TXTextControl.MergeFieldTextFormat Determines the possible text formats for merge fields containing text.
TXTextControl.NextField Represents an MS Word specific NEXT field.
TXTextControl.NextIfField Represents an MS Word specific NEXTIF field.
TXTextControl.TextField Represents a Text Control TextField.
TXTextControl.ApplicationField Represents a Text Control ApplciationField.
Method Description
TXTextControl.addMergeField Inserts a merge field at the current input position.
TXTextControl.addTextField Inserts a new ApplicationField or TextField at the current input position.
TXTextControl.getTextFields 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.
TXTextControl.removeTextField The removeTextField method removes a text field from the document.
TXTextControl.showMergeFieldDialog Opens a field dialog either for changing properties of an existing merge field or for creating a new merge field.
TXTextControl.TextPart.addTextField Inserts a new ApplicationField or TextField into the TextPart at the current input position.
TXTextControl.TextPart.getTextFields Requests a collection of either all text fields in the text part 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.

Read more about the typical applications for these features in this article:

Sneak Peek X15: Custom Field Overlays in HTML5-based Text Control

SubTextParts

The JavaScript API allows manipulations of TXTextControl.SubTextPart objects. A SubTextPart object represents a user-defined part of a TX Text Control document.

Class Description
TXTextControl.SubTextPart The callback function argument for the getSubTextParts function.
Method Description
TXTextControl.getSubTextParts 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.
TXTextControl.TextPart.getSubTextParts 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.

Spell checking

A JavaScript object has been introduced to act as a namespace for all proofing and spell checking methods and properties. Now it is possible to load, remove and save user dictionaries and add and remove custom words to these dictionaries. These user dictionaries can be added per user session as the list of words is given as a string array.

Class Description
TXTextControl.UserDictionaryInfo This class contains read only information about a user dictionary.
TXTextControl.Proofing A JavaScript object which was introduced to act as a namespace for all proofing and spell checking methods and properties.