Web Editor

The Web.TextControl (HTML5 Web Editor) is an ASP.NET server control that allows the integration of a fully-featured WYSIWYG word processor in ASP.NET Web applications. This control works together with the TX Text Control Web Server running as a Windows Service hosted on a Web server. The TX Text Control Web Server engine is used to synchronize the document with the server in order to provide consistent WYSIWYG text rendering. The technical concept is explained in Modules of TX Text Control .NET Server for ASP.NET Explained. All programming elements belonging to the HTML5 Web Editor can be found in the TXTextControl.Web namespace.

Classes

Class	Description
TXTextControl.Web.MVC.ControlBase	The abstract ControlBase class serves as a base class for TX Text Control ASP.NET MVC extensions.
TXTextControl.Web.MVC.ControlsFactory	The ControlsFactory class contains helper methods to create TX Text Control extensions.
TXTextControl.Web.MVC.HtmlHelperExtension	The HtmlHelperExtension class extends the standard System.Web.Mvc.HtmlHelper class with a TX Text Control specific extension method.
TXTextControl.Web.MVC.TextControl	The TextControl class represents an extension object implementing the Text Control rich text editor functionality.
TXTextControl.Web.MVC.TextControlSettings	The TextControlSettings class contains the TextControl extension settings.
TXTextControl.Web.MVC.DocumentViewer.ControlBase	The abstract ControlBase class serves as a base class for TX Text Control ASP.NET MVC DocumentViewer extensions.
TXTextControl.Web.MVC.DocumentViewer.ControlsFactory	The ControlsFactory class contains helper methods to create TX Text Control extensions.
TXTextControl.Web.MVC.DocumentViewer.DocumentViewer	The DocumentViewer class represents an extension object implementing the TX Text Control DocumentViewer functionality.
TXTextControl.Web.MVC.DocumentViewer.DocumentViewerSettings	The DocumentViewerSettings class contains the DocumentViewer extension settings.
TXTextControl.Web.MVC.DocumentViewer.HtmlHelperExtension	The HtmlHelperExtension class extends the standard System.Web.Mvc.HtmlHelper class with a TX Text Control specific extension method.

Constructors

Constructor	Description
TXTextControl.Web.MVC.TextControl	Initializes a new instance of the TextControl class.
TXTextControl.Web.MVC.DocumentViewer.DocumentViewer	Initializes a new instance of the DocumentViewer class.

Methods

Method	Description
TXTextControl.Web.MVC.ControlBase.Render	Renders the extension's HTML code into the page output.
TXTextControl.Web.MVC.ControlsFactory.TextControl	Creates a TextControl.
TXTextControl.Web.MVC.HtmlHelperExtension.TXTextControl	Provides access to helper methods allowing you to render individual TX Text Control ASP.NET MVC extensions.
TXTextControl.Web.MVC.TextControl.LoadDataFromJson	Uses data given as a JSON string as a data source.
TXTextControl.Web.MVC.TextControl.LoadDataFromModel	Loads a collection implementing interface System.Collections.IEnumerable as a data source.
TXTextControl.Web.MVC.TextControl.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.
TXTextControl.Web.MVC.TextControl.LoadText	Loads text in a certain format.
TXTextControl.Web.MVC.TextControl.LoadXMLDatabase	Loads an XML database which is used to create table and field name menu items in the mailings ribbon tab.
TXTextControl.Web.MVC.TextControl.SetFileDirectory	Determines the directory path where the files of a specific file type are stored.
TXTextControl.Web.MVC.DocumentViewer.ControlBase.Render	Renders the extension's HTML code into the page output.
TXTextControl.Web.MVC.DocumentViewer.ControlsFactory.DocumentViewer	Creates a DocumentViewer.
TXTextControl.Web.MVC.DocumentViewer.HtmlHelperExtension.TXTextControl	Provides access to helper methods allowing you to render individual TX Text Control ASP.NET MVC extensions.

Properties

Property	Description
TXTextControl.Web.MVC.TextControlSettings.APIRoute	Determines the API directory in the MVC project in which to find the WebSocket and print handlers.
TXTextControl.Web.MVC.TextControlSettings.BackColor	Specifies or returns the background color of the main text area and the ruler bars.
TXTextControl.Web.MVC.TextControlSettings.ContextMenusEnabled	Determines if a right click opens a context menu or not.
TXTextControl.Web.MVC.TextControlSettings.ControlChars	Specifies if control characters are visible or not.
TXTextControl.Web.MVC.TextControlSettings.Culture	Gets or sets the control's culture.
TXTextControl.Web.MVC.TextControlSettings.DatabaseFileDirectory	Determines the directory path where database files are stored on the web server.
TXTextControl.Web.MVC.TextControlSettings.Dock	Gets or sets a value how the control is docked to its container or web site.
TXTextControl.Web.MVC.TextControlSettings.DocumentFileDirectory	Determines the directory path where document files are stored on the web server.
TXTextControl.Web.MVC.TextControlSettings.DocumentTargetMarkers	Specifies if markers for hypertext targets are shown in the editor or not.
TXTextControl.Web.MVC.TextControlSettings.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.
TXTextControl.Web.MVC.TextControlSettings.FormattingPrinter	Gets or sets the name of a printer the text dimensions and capabilities of which are used to format the document.
TXTextControl.Web.MVC.TextControlSettings.Height	Gets or sets the height of the control in the browser in percent, pixels or any other valid CSS length unit.
TXTextControl.Web.MVC.TextControlSettings.ImageFileDirectory	Determines the directory path where image files are stored on the web server.
TXTextControl.Web.MVC.TextControlSettings.SaveDocumentQuestionDialogEnabled	Determines if a confirmation dialog should be shown before discarding unsaved changes.
TXTextControl.Web.MVC.TextControlSettings.ServiceAddress	Gets or sets the IP address at which the websocket handler tries to connect to the Service.
TXTextControl.Web.MVC.TextControlSettings.ServicePort	Gets or sets the Port at which the websocket handler tries to connect to the Service.
TXTextControl.Web.MVC.TextControlSettings.StaticFilesPath	Specifies or returns the path for static files.
TXTextControl.Web.MVC.TextControlSettings.StatusBarColor	Specifies or returns the background color of the status bar.
TXTextControl.Web.MVC.TextControlSettings.TableGridLines	Determines wether table grid lines are shown in the editor or not.
TXTextControl.Web.MVC.TexControlSettings.TextFieldsEditable	Gets or sets if text fields are editable or not.
TXTextControl.Web.MVC.TextControlSettings.TextFrameMarkerLines	Specifies whether text frames that have no border line are shown with marker lines.
TXTextControl.Web.MVC.TextControlSettings.UICulture	Gets or sets the control's user interface culture.
TXTextControl.Web.MVC.TextControlSettings.UserNames	Gets or sets a list of names specifying users who have access to editable regions.
TXTextControl.Web.MVC.TextControlSettings.Width	Gets or sets the width of the control in the browser in percent, pixels or any other valid CSS length unit.
TXTextControl.Web.MVC.DocumentViewer.DocumentViewerSettings.BasePath	Gets or sets the base path where to search for the TextControl controller that provides all asynchronous Http methods called by the DocumentViewer Javascript.
TXTextControl.Web.MVC.DocumentViewer.DocumentViewerSettings.FormattingPrinter	The name of a printer the text dimensions and capabilities of which are used to format the document.
TXTextControl.Web.MVC.DocumentViewer.DocumentViewerSettings.ResourceManager	Gets or sets the resource manager that can be used to apply custom resources such as translations.
TXTextControl.Web.MVC.DocumentViewer.DocumentViewerSettings.ToolbarDocked	Specifies whether the toolbar is docked or not.
TXTextControl.Web.MVC.DocumentViewer.DocumentViewerSettings.DocumentPath	Gets or sets the document path including the file name from where to load the document to view.
TXTextControl.Web.MVC.DocumentViewer.DocumentViewerSettings.DocumentData	Specifies document data to load a document from memory.
TXTextControl.TXTextControl.Web.MVC.DocumentViewer.DocumentLoadSettings	Settings for loading the document via DocumentData or DocumentPath.
TXTextControl.Web.MVC.DocumentViewer.DocumentViewerSettings.IsSelectionActivated	Specifies whether the text selection in documents is active or not.
TXTextControl.Web.MVC.DocumentViewer.DocumentViewerSettings.SignatureSettings	Specifies Web.MVC.DocumentViewer.SignatureSettings for document signing processes.
TXTextControl.Web.MVC.DocumentViewer.DocumentViewerSettings.ShowThumbnailPane	Specifies whether the thumbnail view pane is visible.
TXTextControl.Web.MVC.DocumentViewer.DocumentViewerSettings.Dock	Gets or sets a value specifying how the control is docked to its container or web site.
TXTextControl.Web.MVC.DocumentViewer.DocumentViewerSettings.View	Specifies which device specific view is shown.