TX Text Control .NET Documentation

TXTextControl Object

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

Syntax

TXTextControl

Properties

PropertyDescription
contextMenusEnabledGets or sets if a right click into the text area opens a context menu or not.
controlCharsGets or sets if control characters are visible.
documentTargetMarkersGets or sets if document target markers are visible.
editModeGets or sets the edit mode the control is in.
isHyphenationEnabledGets or sets a value indicating whether hyphenation is active or not.
isLanguageDetectionEnabledGets or sets a value indicating whether language detection is active or not.
isLoadingDialogEnabledGets or sets if a wait dialog is shown while a document is being loaded.
isSpellCheckingEnabledGets or sets a value indicating whether spell checking is active or not.
ribbonGets the control's ribbon bar object.
saveDocumentQuestionDialogEnabledGets or sets if a confirmation dialog should be shown before discarding unsaved changes.
selectionGets the current selection.
tableGridLinesGets or sets if table grid lines are visible.
textFieldsEditableGets or sets if text fields are editable or not.
textFrameMarkerLinesGets or sets if text frame marker lines are visible.

Methods

MethodDescription
addEventListenerThe addEventListener function registers event listener functions on the TXTextControl object.
focusThe focus function sets the text input focus to the web editor.
getBackColorReturns the background color of the main text area and the ruler bars by calling a provided callback function.
getCulturesReturns the culture and the UI culture of the control.
getFileDirectoryRequests the directory path where the files of a specific file type are stored on the web server.
getFormattingPrinterReturns the name of the currently selected formatting printer by calling a provided callback function.
getInstalledPrintersGets the names of the printers installed on the server which are usable by Text Control.
getStatusBarColorReturns the background color of the status bar by calling a provided callback function.
getTextPartsRequests a collection of all text parts the current document contains from the server and returns the collection by calling a callback function which has to be provided as a parameter to the function.
loadDocumentLoads text in a certain format.
loadSelectionLoads text in a certain format into the current selection.
loadXMLDatabaseLoads an XML database which is used to create table and field name menu items in the mailings ribbon tab.
removeEventListenerThe removeListener function removes the specified listener from the TXTextControl object.
removeFromDomThe removeFromDom function closes the WebSocket connection gracefully and removes the whole editor from the DOM.
resetContentsDeletes the entire contents of the control.
saveDocumentSaves the current document in a certain format and sends the result back asynchronously by calling a given callback function.
saveSelectionSaves the current selection in a certain format and sends the result back asynchronously by calling a given callback function.
setBackColorSets the background color of the main text area and the ruler bars.
setFileDirectorySets the directory path where the files of a specific file type are stored on the web server.
setFormattingPrinterSets the name of a printer the text dimensions and capabilities of which are used to format the document.
setStatusBarColorSets the background color of the status bar.
showHorizontalRulerShows or hides the web editor's horizontal ruler bar.
showRibbonBarShows or hides the ribbon bar.
showStatusBarShows or hides the web editor's status bar.
showVerticalRulerShows or hides the web editor's vertical ruler bar.

Enumerations

EnumerationDescription
EditModeDetermines the possible document edit modes.
FileTypeSpecifies the kind of file types.
StreamTypeDetermines a certain text format.

See Also

 
 
Call us: +1 704-544-7445 (United States)
 
 

Products

Support

Downloads

Corporate

Buy Now

About Text Control

Founded in 1991, Text Control is an award-winning Visual Studio Industry Partner and leading vendor of word processing and reporting components for Microsoft development technologies. The products help thousands of developers add comprehensive word processing functionality to their applications. Text Control is 100% self-owned and independent of all investor decisions. Customers benefit from these years of experience, large user-base, and at the same time, appreciate developing with a mature, reliable product.

SD Times 100SD Times 100SD Times 100SD Times 100SD Times 100SD Times 100Visual Studio 2015 Launch PartnerVisual Studio 2013 Launch PartnerVisual Studio 2012 Launch PartnerVisual Studio Partner