TextControl Class

Description

The TextControl class implements a control with high-level text editing features. It is inherited from the System.Web.UI.WebControls.WebControl class. The following describes only the properties, methods and events defined through the TextControl class. For a list of properties, methods and events inherited from the System.Web.UI.WebControls.WebControl class see the .NET Framework reference.

Syntax

public class TextControl : WebControl

Public Class TextControl
  Inherits WebControl

Examples

The following example creates a Text Control object and prepares it for a document workflow.

TXTextControl.Web.MVC.TextControl textControl = new();
Console.WriteLine("Text Control is ready for the document workflow.");

Dim textControl As New TXTextControl.Web.MVC.TextControl()
Console.WriteLine("Text Control is ready for the document workflow.")

Members

Constructors

Constructor	Description
TextControl	Initializes a new instance of the TextControl class.

Properties

Property	Description
BackColor	Specifies or returns the background color of the main text area and the ruler bars.
ContextMenusEnabled	Specifies or returns a value indicating if a right click opens a context menu or not.
ControlChars	Specifies if control characters are visible or not.
Culture	Gets or sets the control's culture. Affects date and time string formats, for example.
Dock	Gets or sets a value how the control is docked to its container or web site.
DocumentTargetMarkers	Specifies or returns a value indicating if markers for hypertext targets are shown in the editor or not.
EditMode	Specifies or returns a value of type Web.EditMode indicating whether the document's text is read-only, can be selected or is editable.
FormattingPrinter	Gets or 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.
IsReady	Gets a value indicating whether all TX Text Control components are completely loaded in the service's worker process.
SaveDocumentQuestionDialogEnabled	Specifies or returns a value indicating if a confirmation dialog should be shown before discarding unsaved changes.
Selection	Gets or sets the current selection in the text part with the input focus. The property value is an object of the type Web.Selection.
ServiceAddress	Gets or sets the IP address at which the websocket handler tries to connect to the Service. The default value is 127.0.0.1 (the local computer). Important: setting this property affects all instances of class Web.TextControl. It was not made static so it shows up in the Visual Studio designer.
ServicePort	Gets or sets the Port at which the websocket handler tries to connect to the Service. Important: setting this property affects all instances of class Web.TextControl. It was not made static so it shows up in the Visual Studio designer.
StatusBarColor	Specifies or returns the background color of the status bar.
TableGridLines	Specifies or returns a value indicating wether table grid lines are shown in the editor or not.
TextFieldsEditable	Gets or sets if text fields are editable or not.
TextFrameMarkerLines	Specifies whether text frames that have no border line are shown with marker lines.
TextParts	Gets a collection of all text parts the current document contains. The property's value is an object of the type Web.TextPartCollection. A text part can be the main text, a text frame or a header or footer.
UICulture	Gets or sets the control's user interface culture. Affects the string resource language.
UserNames	Gets or sets 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.
WebSocketHandlerPath	Specifies the path to the WebSocket handler (TXWebSocketHandler.ashx). If set to null (the default value) or an empty string, the browser derives the WebSocket handler URL from the current page's URL. This property sets the portion of the path BETWEEN the web site root and the handler-ashx-file (e. g. "/foo/bar/" in case of the handler listening at ws://www.website.com/foo/bar/TXWebSocketHandler.ashx). In most cases this property doesn't need to be set and the browser generated URL works fine. However, if the web control is used in an ASP.Net MVC application and the web page containing the editor resides in a virtual directory, the WebSocket handler URL generated by the browser will be invalid. This makes it impossible for the web app to connect to the web server. Use this property to correct the WebSocket handler URL in that case. Absolute (e. g. "/editor/") and relative directories (e. g. "../../") are possible.

Methods

Method	Description
GetFileDirectory	Returns the directory path where the files of a specific file type are stored.
GetFileDirectoryAsync	Returns the directory path where the files of a specific file type are stored.
LoadDataFromJson	Uses data given as a JSON string as a data source. The JSON string has to contain an array of equally structured objects. Analyzes and uses the given objects as merge data in the same way as the method LoadDataFromModel.
LoadDataFromJsonAsync	Uses data given as a JSON string as a data source. The JSON string has to contain an array of equally structured objects. Analyzes and uses the given objects as merge data in the same way as the method LoadDataFromModel. The method returns immediately.
LoadDataFromModel	Loads a collection implementing interface System.Collections.IEnumerable as a data source.
LoadDataFromModelAsync	Loads a collection implementing interface System.Collections.IEnumerable as a data source.
LoadDataSet	Loads a database which is used to create table and field name menu items in the mailings ribbon tab from an existing DataSet object.
LoadDataSetAsync	Loads a database which is used to create table and field name menu items in the mailings ribbon tab from an existing DataSet object. This method returns immediately and does not wait for the DataSet to be loaded completely.
LoadText	Loads text in a certain format. The complete contents of a TextControl are replaced.
LoadTextAsync	Loads text in a certain format. The complete contents of a Text Control are replaced. This method returns immediately and does not wait for the text to be completely loaded.
LoadXMLDatabase	Loads an XML database which is used to create table and field name menu items in the mailings ribbon tab.
LoadXMLDatabaseAsync	Loads an XML database which is used to create table and field name menu items in the mailings ribbon tab. The method returns immediately and does not wait for the database to be completely loaded.
ResetContents	Deletes the entire contents of the control.
SaveText	Saves the complete contents of a document with the specified format.
SetFileDirectory	Determines the directory path where the files of a specific file type are stored.
SetFileDirectoryAsync	Determines the directory path where the files of a specific file type are stored.