TX Text Control .NET Server

TextControlSettings Class

Class|Introduced in 23.0

Namespace: TXTextControl.Web.MVC

Package: TXTextControl.Web from nuget.org, the private NuGet feed or Text Control Offline Packages

Assembly: TXTextControl.Web.DocumentEditor.dll

Install: dotnet add package TXTextControl.Web

Description

The TextControlSettings class contains the TextControl extension settings. It is used as a parameter for the Web.MVC.ControlsFactory.TextControl method which creates new TextControl instances.

Syntax

public class TextControlSettings

Public Class TextControlSettings

Examples

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

TXTextControl.Web.MVC.TextControlSettings textControlSettings = new();
textControlSettings.Width = "Quarterly report";

Dim textControlSettings As New TXTextControl.Web.MVC.TextControlSettings()
textControlSettings.Width = "Quarterly report"

Members

Constructors

Constructor	Description
TextControlSettings	Not described in the reference. `public TextControlSettings();`

Properties

Property	Description
APIRoute	Determines the API directory in the MVC project in which to find the WebSocket and print handlers. The default value is "api/".
BackColor	Specifies or returns the background color of the main text area and the ruler bars.
ContextMenusEnabled	Determines 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.
DatabaseFileDirectory	Determines the directory path where database files are stored on the web server.
Dock	Gets or sets a value how the control is docked to its container or web site.
DocumentFileDirectory	Determines the directory path where document files are stored on the web server.
DocumentTargetMarkers	Specifies 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.
Height	Gets or sets the height of the control in the browser in percent, pixels or any other valid CSS length unit.
ImageFileDirectory	Determines the directory path where image files are stored on the web server.
ReconnectTimeout	Not described in the reference. `public double ReconnectTimeout { get; set; }`
RenderMode	Not described in the reference. `public ComponentRenderMode RenderMode { get; set; }`
SaveDocumentQuestionDialogEnabled	Determines if a confirmation dialog should be shown before discarding unsaved changes.
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 TextControlSettings.
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 TextControlSettings.
StaticFilesPath	Specifies or returns the path for static files. Is /TXTextControl.Web/ by default.
StatusBarColor	Specifies or returns the background color of the status bar.
TableGridLines	Determines 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.
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.
WebSocketProtocols	Not described in the reference. `public string[] WebSocketProtocols { get; set; }`
WebSocketURL	Not described in the reference. `public string WebSocketURL { get; set; }`
Width	Gets or sets the width of the control in the browser in percent, pixels or any other valid CSS length unit.