Text Control

https://www.textcontrol.com/documentation/
Admin
Comprehensive documentation for Text Control - a suite of document processing and word processing...
Tokens:326,214
Snippets:4,199
Trust Score:10
Update:4 months ago
Show doc for...
Tokens:
Raw
### TXTextControl.TargetStart Property

Source: https://www.textcontrol.com/documentation/ocx-contents.htm

Gets the start position of the target at the current input position.

```APIDOC
## TXTextControl.TargetStart Property

### Description
Gets the starting position of the target element that is currently at the input position.

### Method
Property

### Parameters
None

### Response
None
```

--------------------------------

### Detecting Clipboard Data Transfer Start

Source: https://www.textcontrol.com/documentation/widget-html/n_javascript.txtextcontrol.addeventlistener.htm

This example shows how to detect the start of a clipboard data transfer. The callback function receives a ClipboardTransferStartEventArgs object.

```javascript
TXTextControlWeb.addEventListener("clipboardDataTransferStart", function (event) {
  // Access transfer details from event.detail
  console.log("Clipboard transfer started.");
});
```

--------------------------------

### Start VT Spellchecker

Source: https://www.textcontrol.com/documentation/ocx-html/o_obsolete.vtspellcheck.htm

This method starts the VT Speller. It requires the VT Speller tool from VisualTools to be installed. The method returns True if the spellchecker starts successfully, and False otherwise. Note that VT Speller is no longer available.

```vb.net
TXTextControl.VTSpellCheck
```

--------------------------------

### TXTextControl.SelStart Syntax

Source: https://www.textcontrol.com/documentation/ocx-html/o_txtextcontrol.selstart.htm

This shows the basic syntax for accessing the SelStart property. It can be used to get or set the starting position of a text selection.

```vb
TXTextControl.SelStart [= value]
```

--------------------------------

### Get Section Start

Source: https://www.textcontrol.com/documentation/ocx-html/o_txtextcontrol.sectionstart.htm

Retrieves the one-based index of the first character of the current section. This property is read-only and can only be accessed at runtime.

```vbnet
TXTextControl.SectionStart Number
```

--------------------------------

### TXTextControl.SelectionBounds.start Property

Source: https://www.textcontrol.com/documentation/widget-html/n_txtextcontrol.selectionbounds.start.htm

The 0-based start character position of the selection.

```APIDOC
## TXTextControl.SelectionBounds.start Property

### Description
The 0-based start character position of the selection.

### Syntax
```javascript
<integer> SelectionBounds.start
```
```

--------------------------------

### Setting Numbering Start

Source: https://www.textcontrol.com/documentation/ocx-html/o_txtextcontrol.numberingattribute.htm

Specifies the starting number of the numbered list. If this attribute is 3 and txNumberingFormat is 4 (small letters), the list starts with 'c'.

```vb
TXTextControl.NumberingAttribute(txNumberingStart) = 3
```

--------------------------------

### TXTextControl.MisspelledWordStart Property

Source: https://www.textcontrol.com/documentation/ocx-contents.htm

Gets the starting character index of the misspelled word at the current input position.

```APIDOC
## TXTextControl.MisspelledWordStart Property

### Description
Gets the starting character index of the misspelled word at the current input position.

### Property Type
Integer
```

--------------------------------

### Accessing the start Property

Source: https://www.textcontrol.com/documentation/widget-html/n_txtextcontrol.textfieldeventargs.start.htm

The 'start' property returns the 1-based first character position of the text field. This property is read-only.

```javascript
TextFieldEventArgs.start
```

--------------------------------

### Get SubTextPart Start Index

Source: https://www.textcontrol.com/documentation/widget-html/n_txtextcontrol.subtextpart.start.htm

Retrieves the starting index of a subtext part within a text field. This property is read-only.

```javascript
integer TextField.start
```

--------------------------------

### TXTextControl.hWnd Property

Source: https://www.textcontrol.com/documentation/ocx-contents.htm

Gets the window handle of the control.

```APIDOC
## TXTextControl.hWnd Property

### Description
Gets the window handle of the control.

### Property Type
IntPtr
```

--------------------------------

### Get Selection Start Position

Source: https://www.textcontrol.com/documentation/widget-html/n_txtextcontrol.selectionbounds.start.htm

Retrieves the 0-based start character index of the current text selection within the TXTextControl document.

```javascript
var start = SelectionBounds.start;
```

--------------------------------

### Initialize OpenFile Dialog with Image Filters

Source: https://www.textcontrol.com/documentation/ocx-html/o_txtextcontrol.imagefilters.htm

This example demonstrates how to use the ImageFilters property to populate the Filter property of an OpenFile dialog, allowing users to select from available image types. It then loads the selected image into TXTextControl.

```Basic
dlgFile.DialogTitle = "Insert Image"
dlgFile.Filename = ""
dlgFile.Filter = TXTextControl1.ImageFilters
dlgFile.FilterIndex = 1
dlgFile.Flags = cdlOFNPathMustExist Or cdlOFNFileMustExist _
   Or cdlOFNHideReadOnly
dlgFile.CancelError = True
dlgFile.ShowOpen
TXTextControl1.ImageInsertAsChar dlgFile.Filename, -1, 100, 100
```

--------------------------------

### TXButtonBar.Appearance Property Syntax

Source: https://www.textcontrol.com/documentation/ocx-html/o_txbuttonbar.appearance.htm

This shows the basic syntax for accessing the TXButtonBar.Appearance property. No specific setup is required beyond having an instance of TXButtonBar.

```text
TXButtonBar.Appearance [= value]
```

--------------------------------

### Get Misspelled Word Start Position

Source: https://www.textcontrol.com/documentation/ocx-html/o_txtextcontrol.misspelledwordstart.htm

Retrieves the starting position of a misspelled word. Assign the result to SelStart and MisspelledWordLength to select the word.

```vb.net
Dim startPos As Long
startPos = TXTextControl.MisspelledWordStart(1)
TXTextControl.SelStart = startPos
TXTextControl.SelLength = TXTextControl.MisspelledWordLength
```

--------------------------------

### Handling Text Control Initialization

Source: https://www.textcontrol.com/documentation/widget-html/n_javascript.txtextcontrol.addeventlistener.htm

This example shows how to detect when the TextControl instance has been properly initialized and is ready for programmatic manipulation. This event does not provide any event arguments.

```javascript
TXTextControlWeb.addEventListener("textControlLoaded", function () {
  // Code to execute after TextControl is loaded and ready
  console.log("TextControl is loaded and ready.");
});
```

--------------------------------

### TXTextControl.TableCellStart Property

Source: https://www.textcontrol.com/documentation/ocx-contents.htm

Gets the start position of the current table cell.

```APIDOC
## TXTextControl.TableCellStart Property

### Description
Gets the starting position of the current table cell within the document.

### Method
Property

### Parameters
None

### Response
None
```

--------------------------------

### Load Text File into TXTextControl

Source: https://www.textcontrol.com/documentation/ocx-html/o_txtextcontrol.load.htm

This Basic example demonstrates how to open a file dialog and load the selected file's content into the TXTextControl1 using the Load method. It handles potential errors during file opening and passes the selected filename to the control.

```Basic
Private Sub mnuFile_Load_Click()
   On Error Resume Next
   ' Create an "Open File" dialog box
   CommonDialog1.Filter = "TX Demo (*.tx)|*.tx"
   CommonDialog1.DialogTitle = "Open"
   CommonDialog1.Flags = cdlOFNFileMustExist Or _
      cdlOFNHideReadOnly
   CommonDialog1.CancelError = True
   CommonDialog1.ShowOpen
   If Err Then Exit Sub
   ' Pass the filename to the text control
   TXTextControl1.Load CommonDialog1.filename
End Sub
```

--------------------------------

### TXTextControl.SelStart

Source: https://www.textcontrol.com/documentation/ocx-html/o_categories.sel.htm

Returns or sets the starting point of text selected or indicates the position of the insertion point if no text is selected.

```APIDOC
## TXTextControl.SelStart

### Description
Returns or sets the starting point of text selected or indicates the position of the insertion point if no text is selected.

### Property
`TXTextControl.SelStart` (Integer)
```

--------------------------------

### TXButtonBar.PosTabCentered Syntax

Source: https://www.textcontrol.com/documentation/ocx-html/o_txbuttonbar.postabcentered.htm

This shows the basic syntax for accessing the PosTabCentered property.

```text
TXButtonBar.PosTabCentered [= position number]
```

--------------------------------

### Get Misspelled Word Length

Source: https://www.textcontrol.com/documentation/ocx-html/o_txtextcontrol.misspelledwordlength.htm

Retrieves the length of a misspelled word by its number. The MisspelledWordStart property must be set to the word's start position, and this property is then used to get its length.

```vb.net
Dim i As Integer

' Select the first misspelled word
TextControl1.SelStart = TXTextControl.MisspelledWordStart(1)
TextControl1.SelLength = TXTextControl.MisspelledWordLength(1)

' Get the length of the first misspelled word
i = TXTextControl.MisspelledWordLength(1)
```

--------------------------------

### Setting the Resource File

Source: https://www.textcontrol.com/documentation/ocx-html/o_txbuttonbar.resourcefile.htm

Assign a string containing the complete path to the resource library file to the ResourceFile property.

```vbnet
TXButtonBar.ResourceFile = "C:\\Path\\To\\Your\\Resource.xml"
```

--------------------------------

### StartUndoAction

Source: https://www.textcontrol.com/documentation/ocx-html/o_txtextcontrol.htm

Defines the beginning of an undo action.

```APIDOC
## StartUndoAction

### Description
Defines the beginning of an undo action.

### Method
Not specified (assumed to be a method call in an SDK)

### Endpoint
Not applicable

### Parameters
None explicitly defined in the source.

### Request Example
None provided.

### Response
None explicitly defined in the source.
```

--------------------------------

### getInstalledPrinters

Source: https://www.textcontrol.com/documentation/widget-html/n_javascript.txtextcontrol.htm

Gets the names of printers installed on the server that are usable by Text Control. This is essential for print functionality.

```APIDOC
## getInstalledPrinters

### Description
Gets the names of the printers installed on the server which are usable by Text Control.

### Method
Not specified (JavaScript method)

### Endpoint
Not applicable (JavaScript method)

### Parameters
Not specified in source text.

### Request Example
Not specified in source text.

### Response
Not specified in source text.
```

--------------------------------

### Initialize TXTextControlWeb

Source: https://www.textcontrol.com/documentation/widget-html/n_javascript.txtextcontrol.htm

Instantiates the TXTextControlWeb object, linking it to a specific HTML container element.

```javascript
TXTextControlWeb(<string> container)
```

--------------------------------

### Get Specific Child Element by Name and Index

Source: https://www.textcontrol.com/documentation/ocx-html/o_xmlelement.childitem.htm

This example demonstrates how to retrieve a specific child element ('Telephone') from a collection of elements ('Address') using the ChildItem method. It accesses the second address element and then gets its 'Telephone' child.

```Basic
Dim Telephone As String
Set Addresses = TXTextControl1.XMLElements("Address")
Telephone = Addresses(2).ChildItem("Telephone")
```

--------------------------------

### TXButtonBar.Style Syntax

Source: https://www.textcontrol.com/documentation/ocx-html/o_txbuttonbar.style.htm

This shows the basic syntax for accessing the TXButtonBar.Style property. No setup is required to use this property.

```text
TXButtonBar.Style [= value]
```

--------------------------------

### Save Selected Text to Memory and Load into Another Control

Source: https://www.textcontrol.com/documentation/ocx-html/o_txtextcontrol.savetomemory.htm

This Basic example demonstrates saving the currently selected text from one Text Control to a byte array and then loading it into another Text Control. It utilizes the SaveToMemory and LoadFromMemory methods.

```Basic
Dim data() As Byte
data = TXTextControl1.SaveToMemory(3, True)
TXTextControl2.LoadFromMemory data, 3, True
```

--------------------------------

### Get Page Start Character Index

Source: https://www.textcontrol.com/documentation/ocx-html/o_txtextcontrol.pagestart.htm

Retrieves the one-based index of the first character on the current page. This property is read-only and available at runtime.

```vb.net
Dim pageStart As Long
pageStart = TXTextControl.PageStart
```

--------------------------------

### TXStatusBar.ResourceFile Syntax

Source: https://www.textcontrol.com/documentation/ocx-html/o_txstatusbar.resourcefile.htm

This is the basic syntax for setting the TXStatusBar.ResourceFile property. The value must be a string representing a complete path to a resource library.

```text
TXStatusBar.ResourceFile [= string]
```

--------------------------------

### Get Installed Printers

Source: https://www.textcontrol.com/documentation/widget-html/n_txtextcontrol.getinstalledprinters.htm

This JavaScript snippet shows how to call the getInstalledPrinters method. A callback function is provided to receive an array of printer names.

```javascript
TXTextControlWeb.getInstalledPrinters(function (printers) {
  // printers is a String[] containing the names of the installed printers
});
```

--------------------------------

### TXTextControlWeb.getInstalledPrinters

Source: https://www.textcontrol.com/documentation/widget-html/n_txtextcontrol.getinstalledprinters.htm

Gets the names of the printers installed on the server which are usable by Text Control. The method accepts a callback function that will be invoked with an array of printer names.

```APIDOC
## TXTextControlWeb.getInstalledPrinters

### Description
Gets the names of the printers installed on the server which are usable by Text Control.

### Method
JavaScript (asynchronous callback)

### Endpoint
Not applicable (client-side SDK method)

### Parameters
#### Callback Function
- **callback** (function) - Required - A function that accepts one parameter: a String array containing the names of the installed printers available for Text Control.

### Request Example
```javascript
TXTextControlWeb.getInstalledPrinters(function(printerNames) {
  console.log('Installed printers:', printerNames);
});
```

### Response
#### Success Response
The callback function is invoked with an array of strings, where each string is the name of an installed printer.

#### Response Example
```json
["Printer 1", "Microsoft Print to PDF", "Another Printer"]
```
```

--------------------------------

### TXTextControl.TargetGoto Method

Source: https://www.textcontrol.com/documentation/ocx-contents.htm

Navigates the input position to a specified target.

```APIDOC
## TXTextControl.TargetGoto Method

### Description
Moves the current input position to a specified target within the document.

### Method
Method

### Parameters
None

### Response
None
```

--------------------------------

### Initialize Hyperlink Dialog and Show

Source: https://www.textcontrol.com/documentation/ocx-html/o_basic_hyperlinks.step1.htm

This subroutine is triggered by a menu click to initialize the hyperlink dialog form with the Text Control reference and display settings, then shows the dialog.

```Visual Basic 6
Public Sub do_mnuInsert_Hyperlink_Click(tx As _
            TXTextControl, bShowHyperlinks As Boolean)
   Set frmHyperlink.tx = tx
   frmHyperlink.bShowHyperlinks = _
      (mnuView_Hyperlinks.Checked = True)
   frmHyperlink.Show 1
End Sub
```

--------------------------------

### Get Tracked Change Start Index

Source: https://www.textcontrol.com/documentation/ocx-html/o_txtextcontrol.trackedchangestart.htm

Retrieves the one-based index of the first character of a specific tracked change using its ID. This property is read-only and can only be accessed at runtime.

```vb.net
Dim firstCharIndex As Long
firstCharIndex = TXTextControl.TrackedChangeStart(TrackedChangeId)
```

--------------------------------

### Get Comment Start Index

Source: https://www.textcontrol.com/documentation/ocx-html/o_txtextcontrol.commentstart.htm

Use the CommentStart property to retrieve the one-based index of the first character of a comment's text. The CommentId parameter specifies which comment to query.

```vb.net
Dim startPos As Long
startPos = TXTextControl.CommentStart(1)
```

--------------------------------

### TXTextControl.Proofing.loadUserDictionary

Source: https://www.textcontrol.com/documentation/widget-html/n_txtextcontrol.proofing.loaduserdictionary.htm

Loads a list of words given as a string array as a user dictionary.

```APIDOC
## TXTextControl.Proofing.loadUserDictionary

### Description
Loads a list of words given as a string array as a user dictionary.

### Method
```javascript
TXTextControl.Proofing.loadUserDictionary(name: string, words: string[], language: string): void
```

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
- **name** (string) - Required - The user dictionary's name.
- **words** (string[]) - Required - The list of words to create the user dictionary from.
- **language** (string) - Required - The user dictionary's language in the format languagecode2-country/regioncode2. (e. g. "en-US" or "de-DE")

### Request Example
```javascript
TXTextControl.Proofing.loadUserDictionary("myDictionary", ["word1", "word2"], "en-US");
```

### Response
#### Success Response (void)
This method does not return a value.

#### Response Example
None
```

--------------------------------

### LoadDialog

Source: https://www.textcontrol.com/documentation/ocx-html/o_txtextcontrol.htm

Opens the system 'Open' dialogbox and loads a document as specified.

```APIDOC
## LoadDialog

### Description
Opens the system 'Open' dialogbox and loads a document as specified.

### Method
Not specified (assumed to be a method call in an SDK)

### Endpoint
Not applicable

### Parameters
None explicitly defined in the source.

### Response
None explicitly defined in the source.
```

--------------------------------

### Get and Set Table Cell Formula

Source: https://www.textcontrol.com/documentation/ocx-html/o_txtextcontrol.tablecellformula.htm

Demonstrates how to get and set the formula for a specific table cell using its TableId, Row, and Column.

```vb.net
Dim formula As String
formula = TXTextControl.TableCellFormula(1, 2, 3)
TXTextControl.TableCellFormula(1, 2, 3) = "=SUM(R[-1]C:R[-2]C)"
```

--------------------------------

### EnableAutomationServer

Source: https://www.textcontrol.com/documentation/ocx-html/o_txtextcontrol.htm

Enables a Text Control to work as an automation server.

```APIDOC
## EnableAutomationServer

### Description
Enables a Text Control to work as an automation server.

### Method
Not specified (assumed to be a method call in an SDK)

### Endpoint
Not applicable

### Parameters
None explicitly defined in the source.

### Request Example
None provided.

### Response
None explicitly defined in the source.
```

--------------------------------

### Set Page Number Format and Starting Number

Source: https://www.textcontrol.com/documentation/ocx-html/o_txtextcontrol.fieldtypedata.htm

Sets the field type to page number and configures it to display Roman numerals starting from page 5.

```vb
TXTextControl1.FieldType(1) = 3
TXTextControl1.FieldTypeData(1) = 5 + &H60000
```

--------------------------------

### Print Document Page using TXTextControl.PrintPage

Source: https://www.textcontrol.com/documentation/ocx-html/o_txtextcontrol.printpage.htm

This Basic example demonstrates how to iterate through all pages of a Text Control and print each page to the default printer. Ensure the PrintDevice property is set to the printer's device context before calling PrintPage.

```Basic
Sub mnuFile_Print_Click ()
   Dim wPages, No
   Printer.Print
   wPages = TXTextControl1.CurrentPages
   For No = 1 To wPages
      TXTextControl1.PrintDevice = Printer.hDC
      TXTextControl1.PrintPage No
      Printer.NewPage
   Next No
   Printer.EndDoc
End Sub
```

--------------------------------

### Get Text Part at Input Position

Source: https://www.textcontrol.com/documentation/widget-html/n_javascript.txtextcontrol.gettextparts.htm

Use this method to get only the text part that contains the current input position. The result is delivered to the callback function.

```javascript
TXTextControlWeb.getTextParts(function(textParts) {
  // Process the array containing a single TextPart
}, true);
```

--------------------------------

### TXTextControlWeb Constructor

Source: https://www.textcontrol.com/documentation/widget-html/n_javascript.txtextcontrol.htm

Initializes a new instance of the TXTextControlWeb object, which provides a public API to manipulate the web editor via JavaScript functions in the browser.

```APIDOC
## TXTextControlWeb()

### Description
Initializes a new instance of the TXTextControlWeb object.

### Syntax
```javascript
TXTextControlWeb(string container)
```

### Parameters
#### Path Parameters
- **container** (string) - Required - The ID of the HTML element that will host the Text Control.
```

--------------------------------

### Get ApplicationField Type Name

Source: https://www.textcontrol.com/documentation/widget-html/n_txtextcontrol.applicationfield.typename.htm

This snippet shows how to access the `typeName` property to get the merge field type. The property returns a string representing the field type.

```javascript
ApplicationField.typeName
```

--------------------------------

### Handling Text Control Changes

Source: https://www.textcontrol.com/documentation/widget-html/n_javascript.txtextcontrol.addeventlistener.htm

This example shows how to listen for changes in the text control's content. The 'textControlChanged' event does not provide any event arguments.

```javascript
TXTextControlWeb.addEventListener("textControlChanged", function () {
  // Code to execute when the text control content changes
  console.log("Text control content has changed.");
});
```

--------------------------------

### Get File Directory in JavaScript

Source: https://www.textcontrol.com/documentation/widget-html/n_javascript.txtextcontrol.getfiledirectory.htm

Use this method to get the server directory path for a given file type. The callback function receives the directory path as a string.

```javascript
TXTextControl.getFileDirectory(fileType, callback);
```

--------------------------------

### Invalid XML Example Missing Required Element

Source: https://www.textcontrol.com/documentation/ocx-html/o_basic_xmlbasics.the3.htm

An example of an XML file that violates the DTD rules by omitting the required <name> element. Loading this XML will result in a validation error.

```xml
<?xml version="1.0"?>
<? XML:stylesheet type="text/css" href="address.css"?>
<!DOCTYPE address SYSTEM "address.dtd">
<address>
   <address_record>
      <street>Baker Street</street>
      <city>London</city>
      <email>paul@hotmail.com</email>
   </address_record>
</address>
```

--------------------------------

### Initialize TXTextControlWeb.Color

Source: https://www.textcontrol.com/documentation/widget-html/n_javascript.txtextcontrol.color.color.htm

Use this constructor to create a new Color object by specifying the red, green, blue, and optionally alpha components.

```javascript
function Color(r, g, b, a);
```

--------------------------------

### Get the next field identifier

Source: https://www.textcontrol.com/documentation/ocx-html/o_txtextcontrol.fieldnext.htm

This snippet demonstrates how to get the identifier of the next field in the text control. If FieldId is 0, the first field's identifier is returned. If FieldGroup is 0, all fields are enumerated.

```vbscript
Dim nextFieldId
nextFieldId = TXTextControl.FieldNext(0, 0)
```

--------------------------------

### TXTextControl.Load Method

Source: https://www.textcontrol.com/documentation/ocx-contents.htm

Loads a document from a file.

```APIDOC
## TXTextControl.Load Method

### Description
Loads a document from a file.

### Method Signature
`Load(filename As String)`
```

--------------------------------

### Handling File Drops

Source: https://www.textcontrol.com/documentation/widget-html/n_javascript.txtextcontrol.addeventlistener.htm

This example demonstrates how to handle files being dragged and dropped onto the control. The 'fileDropped' event provides a FileDroppedEventArgs object.

```javascript
TXTextControlWeb.addEventListener("fileDropped", function (event) {
  // Access dropped file information from event.detail
  console.log("File dropped:", event.detail.fileName);
});
```

--------------------------------

### TXTextControl.SubTextPart.name Property

Source: https://www.textcontrol.com/documentation/widget-html/n_txtextcontrol.subtextpart.name.htm

Gets or sets the name of the subtextpart.

```APIDOC
## TXTextControl.SubTextPart.name Property

### Description
Gets or sets the name of the subtextpart.

### Syntax
```javascript
<string> SubTextPart.name
```
```

--------------------------------

### TXTextControl.Rectangle.location Property

Source: https://www.textcontrol.com/documentation/widget-html/n_txtextcontrol.rectangle.location.htm

Gets or sets the location of the rectangle.

```APIDOC
## TXTextControl.Rectangle.location Property

### Description
Gets or sets the location of the rectangle.

### Syntax
```javascript
<Point> Rectangle.location
```
```

--------------------------------

### TXTextControl.LoadDialog

Source: https://www.textcontrol.com/documentation/ocx-html/o_categories.dialog.htm

Opens the system 'Open' dialog box and loads a document as specified.

```APIDOC
## TXTextControl.LoadDialog

### Description
Opens the system 'Open' dialog box and loads a document as specified.

### Method
Not specified (assumed to be a method call)

### Endpoint
Not applicable (SDK method)

### Parameters
None explicitly documented.
```

--------------------------------

### TXTextControl.LoadDialog

Source: https://www.textcontrol.com/documentation/ocx-html/o_categories.io.htm

Opens the system 'Open' dialogbox and loads a document as specified.

```APIDOC
## TXTextControl.LoadDialog

### Description
Opens the standard system 'Open' dialog box, allowing the user to select and load a document into the Text Control.

### Method
Not specified (likely a method call in a programming language context).

### Endpoint
Not applicable.

### Parameters
#### Path Parameters
None.

#### Query Parameters
None.

#### Request Body
None.

### Request Example
None.

### Response
#### Success Response
None explicitly defined.

#### Response Example
None.
```

--------------------------------

### TXTextControl.HyperlinkClickedEventArgs.target Property

Source: https://www.textcontrol.com/documentation/widget-html/n_txtextcontrol.hyperlinkclickedeventargs.target.htm

Gets the target of the clicked hyperlink.

```APIDOC
## TXTextControl.HyperlinkClickedEventArgs.target Property

### Description
Gets the target of the clicked hyperlink.

### Syntax
```javascript
<string> HyperlinkClickedEventArgs.target
```

### Returns
- **string**: The target URL or identifier of the hyperlink.
```

--------------------------------

### CommentGetReplied

Source: https://www.textcontrol.com/documentation/ocx-html/o_txtextcontrol.htm

Gets the comment for which the specified comment is a reply.

```APIDOC
## CommentGetReplied

### Description
Gets the comment for which the specified comment is a reply.

### Method
Not specified (assumed to be a method call in an SDK)

### Endpoint
Not applicable

### Parameters
None explicitly defined in the source.

### Request Example
None provided.

### Response
None explicitly defined in the source.
```

--------------------------------

### Style.Apply Method Syntax

Source: https://www.textcontrol.com/documentation/ocx-html/o_style.apply.htm

This is the syntax for the Style.Apply method. It is used to apply all style settings.

```text
Style.Apply
```

--------------------------------

### TXTextControl.TrackedChangeTime Property

Source: https://www.textcontrol.com/documentation/ocx-contents.htm

Gets the timestamp of a tracked change.

```APIDOC
## TXTextControl.TrackedChangeTime Property

### Description
Gets the date and time when the tracked change occurred.

### Method
Property

### Parameters
None

### Response
None
```

--------------------------------

### Setting the Resource File

Source: https://www.textcontrol.com/documentation/ocx-html/o_txrulerbar.resourcefile.htm

Sets the complete path to the resource library file. The Language property is ignored when a resource library is set.

```vbscript
TXRulerBar.ResourceFile = "C:\\MyApplication\\Resources\\MyResources.dll"
```

--------------------------------

### TXTextControl.SubTextPartEventArgs.start Property

Source: https://www.textcontrol.com/documentation/widget-html/n_txtextcontrol.subtextparteventargs.start.htm

The 'start' property returns the 1-based position of the first character that belongs to the subtext part. This property is read-only.

```APIDOC
## TXTextControl.SubTextPartEventArgs.start Property

### Description

The `start` property returns the 1-based position of the first character which belongs to the subtext part.

### Syntax

```javascript
<integer> SubTextPartEventArgs.start
```

### Return Value

An integer representing the 1-based starting character position of the subtext part.
```

--------------------------------

### TXTextControl.TargetName Property

Source: https://www.textcontrol.com/documentation/ocx-contents.htm

Gets or sets the name of the target.

```APIDOC
## TXTextControl.TargetName Property

### Description
Gets or sets the name of the target element.

### Method
Property

### Parameters
None

### Response
None
```

--------------------------------

### Initialize TX Text Control Widget

Source: https://www.textcontrol.com/documentation/widget-html/widget.setup.htm

Instantiate the TX Text Control widget by passing the container ID to the constructor within a window.onload event handler.

```javascript
var textControl1;
window.onload = function() {
	textControl1 = new TXTextControlWeb("myTextControlContainer");
};
```

--------------------------------

### TXTextControl.LoadSaveAttribute Property

Source: https://www.textcontrol.com/documentation/ocx-contents.htm

Gets or sets a load/save attribute.

```APIDOC
## TXTextControl.LoadSaveAttribute Property

### Description
Gets or sets a load/save attribute.

### Property Type
LoadSaveAttribute
```

--------------------------------

### Create Text Control and License Manager Objects in ASP

Source: https://www.textcontrol.com/documentation/ocx-html/o_asp_samples.creating.htm

Instantiates the Text Control license manager and the Text Control object itself. The EnableAutomationServer method is called to initialize the Text Control as an automation server.

```ASP
Dim lc, tx
set lc = Server.CreateObject("TIS.TX.TX.LicManager.34")
set tx = Server.CreateObject("TIS.TX.TextControl.34")
tx.EnableAutomationServer
```

--------------------------------

### TXTextControl.ListType Property

Source: https://www.textcontrol.com/documentation/ocx-contents.htm

Gets or sets the type of list.

```APIDOC
## TXTextControl.ListType Property

### Description
Gets or sets the type of list.

### Property Type
ListType
```

--------------------------------

### TXTextControl.Language Property

Source: https://www.textcontrol.com/documentation/ocx-contents.htm

Gets or sets the language of the document.

```APIDOC
## TXTextControl.Language Property

### Description
Gets or sets the language of the document.

### Property Type
Language
```

--------------------------------

### TXTextControl.GrowFont Method Syntax

Source: https://www.textcontrol.com/documentation/ocx-html/o_txtextcontrol.growfont.htm

This is the syntax for the GrowFont method. It does not take any parameters.

```javascript
TXTextControl.GrowFont
```

--------------------------------

### TXTextControl.StartUndoAction Method

Source: https://www.textcontrol.com/documentation/ocx-html/o_categories.undo.htm

Defines the beginning of an undo action. All operations performed after this call until EndUndoAction is invoked will be grouped as a single undoable action.

```APIDOC
## TXTextControl.StartUndoAction

### Description
Defines the beginning of an undo action. All operations performed after this call until EndUndoAction is invoked will be grouped as a single undoable action.

### Method
- **TXTextControl.StartUndoAction**()
```

--------------------------------

### TXTextControl.Justification Property

Source: https://www.textcontrol.com/documentation/ocx-contents.htm

Gets or sets the justification of the paragraph.

```APIDOC
## TXTextControl.Justification Property

### Description
Gets or sets the justification of the paragraph.

### Property Type
Justification
```

--------------------------------

### TXTextControl.TargetGoto Syntax

Source: https://www.textcontrol.com/documentation/ocx-html/o_txtextcontrol.targetgoto.htm

This is the basic syntax for using the TargetGoto method. It requires a TargetIdOrName parameter to specify the link target.

```javascript
TXTextControl.TargetGoto TargetIdOrName
```

--------------------------------

### TXTextControl.InsertionMode Property

Source: https://www.textcontrol.com/documentation/ocx-contents.htm

Gets or sets the insertion mode.

```APIDOC
## TXTextControl.InsertionMode Property

### Description
Gets or sets the insertion mode.

### Property Type
InsertionMode
```

--------------------------------

### Initialize Form Resize Event

Source: https://www.textcontrol.com/documentation/ocx-html/o_basic_simple.resizing.htm

This snippet shows the basic structure for the Form_Resize event procedure in Visual Basic 6. It serves as a starting point before adding resizing logic.

```Visual Basic 6
Private Sub Form_Resize ()
End Sub
```

--------------------------------

### TXTextControl.ImageFilename Property

Source: https://www.textcontrol.com/documentation/ocx-contents.htm

Gets or sets the filename of the image.

```APIDOC
## TXTextControl.ImageFilename Property

### Description
Gets or sets the filename of the image.

### Property Type
String
```

--------------------------------

### Populating Target List for Links

Source: https://www.textcontrol.com/documentation/ocx-html/o_basic_hyperlinks.step2.htm

Use the TargetNext method to iterate through all targets in the document and add their names to a list box. This prepares the list for users to select a target when inserting a link.

```vb6
targetId As Integer
List1.Clear
targetId = tx.TargetNext(0)
While targetId <> 0
    List1.AddItem tx.targetName(targetId)
    targetId = tx.TargetNext(targetId)
Wend
```

--------------------------------

### TXTextControl.GetCharRect Method

Source: https://www.textcontrol.com/documentation/ocx-contents.htm

Gets the bounding rectangle of a character.

```APIDOC
## TXTextControl.GetCharRect Method

### Description
Gets the bounding rectangle of a character.

### Method Signature
`GetCharRect(charIndex As Integer) As Rect`
```

--------------------------------

### TXButtonBar.PosSubscript Syntax

Source: https://www.textcontrol.com/documentation/ocx-html/o_txbuttonbar.possubscript.htm

This shows the basic syntax for accessing the PosSubscript property.

```text
TXButtonBar.PosSubscript [= position number]
```

--------------------------------

### TXTextControl.GetBaseLinePos Method

Source: https://www.textcontrol.com/documentation/ocx-contents.htm

Gets the baseline position of a character.

```APIDOC
## TXTextControl.GetBaseLinePos Method

### Description
Gets the baseline position of a character.

### Method Signature
`GetBaseLinePos(charIndex As Integer) As Integer`
```

--------------------------------

### Get the current style

Source: https://www.textcontrol.com/documentation/ocx-html/o_txtextcontrol.stylecurrent.htm

Retrieves the formatting style at the current input position. If multiple styles are applied to selected text, an empty string is returned.

```vbnet
Dim currentStyle As String
currentStyle = TXTextControl.StyleCurrent
```

--------------------------------

### TXTextControl.FrameStyle Property

Source: https://www.textcontrol.com/documentation/ocx-contents.htm

Gets or sets the style of the frame.

```APIDOC
## TXTextControl.FrameStyle Property

### Description
Gets or sets the style of the frame.

### Property Type
FrameStyle
```

--------------------------------

### TXTextControl.FrameColor Property

Source: https://www.textcontrol.com/documentation/ocx-contents.htm

Gets or sets the color of the frame.

```APIDOC
## TXTextControl.FrameColor Property

### Description
Gets or sets the color of the frame.

### Property Type
Color
```

--------------------------------

### Create and Modify a Marked Text Field

Source: https://www.textcontrol.com/documentation/ocx-html/o_txtextcontrol.fieldcurrent.htm

This Basic example demonstrates how to create a new marked text field, retrieve its ID using FieldCurrent, and then modify its text content.

```Basic
Sub Create()
   Dim FieldId As Integer
   'Create a marked text field and store its number
   TXTextControl.FieldInsert "New Field"
   FieldId = TXTextControl.FieldCurrent
   ..
   'Change the text
   TXTextControl.FieldCurrent = FieldId
   TXTextControl.FieldText = "Hello"
End Sub
```

--------------------------------

### TXTextControl.FontSize Property

Source: https://www.textcontrol.com/documentation/ocx-contents.htm

Gets or sets the size of the font.

```APIDOC
## TXTextControl.FontSize Property

### Description
Gets or sets the size of the font.

### Property Type
Double
```

--------------------------------

### Responding to Text Field Clicks

Source: https://www.textcontrol.com/documentation/widget-html/n_javascript.txtextcontrol.addeventlistener.htm

This example shows how to detect when a user clicks into a text field. The callback function receives a TextFieldEventArgs object.

```javascript
TXTextControlWeb.addEventListener("textFieldClicked", function (event) {
  // Access text field information from event.detail
  console.log("Text field clicked:", event.detail.fieldName);
});
```

--------------------------------

### TXTextControl.FontSettings Property

Source: https://www.textcontrol.com/documentation/ocx-contents.htm

Gets or sets the font settings.

```APIDOC
## TXTextControl.FontSettings Property

### Description
Gets or sets the font settings.

### Property Type
FontSettings
```

--------------------------------

### Connecting TX Text Control Elements in MS Access

Source: https://www.textcontrol.com/documentation/ocx-html/o_txtextcontrol.connecttools.htm

This example demonstrates the two-step process for connecting TX Text Control elements in MS Access. The first part is added to the form's Load event, and the second part is added to the TX_ConnectTools event.

```vbscript
Sub Form_Load ()
   Me!tx.object.RulerHandle = 1
   Me!tx.object.ButtonBarHandle = 1
   Me!tx.object.StatusBarHandle = 1
End Sub
Sub TX_ConnectTools ()
   Me!tx.object.RulerHandle = Me!Ruler.object.hWnd
   Me!tx.object.ButtonBarHandle = Me!ButtonBar.object.hWnd
   Me!tx.object.StatusBarHandle = Me!StatusBar.object.hWnd
End Sub
```

--------------------------------

### TXTextControl.TargetStart

Source: https://www.textcontrol.com/documentation/ocx-html/o_txtextcontrol.targetstart.htm

Retrieves the one-based character index of a target within the document. The target's position is at the left edge of this character. This property is read-only and available only at run time.

```APIDOC
## TXTextControl.TargetStart

### Description
Returns the target's character index, one-based, in the document. The target's position is at the left edge of this character.

### Method
Property Access

### Parameters
#### Path Parameters
- **TargetId** (Long) - Required - Specifies the target's unique identifier. This must be the value returned from the TargetInsert method.

### Property Value
- **Long** - The character index of the target.
```

--------------------------------

### TXTextControl.FontName Property

Source: https://www.textcontrol.com/documentation/ocx-contents.htm

Gets or sets the name of the font.

```APIDOC
## TXTextControl.FontName Property

### Description
Gets or sets the name of the font.

### Property Type
String
```

--------------------------------

### TXTextControlWeb.Color Constructor

Source: https://www.textcontrol.com/documentation/widget-html/n_javascript.txtextcontrol.color.color.htm

Initializes a new Color object with specified red, green, blue, and optional alpha components.

```APIDOC
## TXTextControlWeb.Color Constructor

### Description
Initializes a new Color object.

### Syntax
```javascript
function Color(r, g, b, a);
```

### Parameters
#### Parameters
- **r** (number) - Required - The red component of the color.
- **g** (number) - Required - The green component of the color.
- **b** (number) - Required - The blue component of the color.
- **a** (number) - Optional - The alpha component of the color.
```

--------------------------------

### TXTextControl.TableAtInputPos Property

Source: https://www.textcontrol.com/documentation/ocx-contents.htm

Gets the table at the current input position.

```APIDOC
## TXTextControl.TableAtInputPos Property

### Description
Gets the table object that is currently located at the input position.

### Method
Property

### Parameters
None

### Response
None
```

--------------------------------

### Accessing Style.Baseline Property

Source: https://www.textcontrol.com/documentation/ocx-html/o_style.baseline.htm

Demonstrates the syntax for accessing the Style.Baseline property. The property's interpretation is dependent on the BaselineType property.

```vbscript
Style.Baseline [= value]
```

--------------------------------

### TXTextControl.TabKey Property

Source: https://www.textcontrol.com/documentation/ocx-contents.htm

Gets or sets the behavior of the Tab key.

```APIDOC
## TXTextControl.TabKey Property

### Description
Gets or sets the behavior of the Tab key when pressed, which can be used to navigate or insert tabs.

### Method
Property

### Parameters
None

### Response
None
```

--------------------------------

### TXTextControl.TabCurrent Property

Source: https://www.textcontrol.com/documentation/ocx-contents.htm

Gets or sets the current tab stop.

```APIDOC
## TXTextControl.TabCurrent Property

### Description
Gets or sets the current tab stop, referring to its position and type.

### Method
Property

### Parameters
None

### Response
None
```

--------------------------------

### Save Document as PDF and Send to Client in ASP

Source: https://www.textcontrol.com/documentation/ocx-html/o_asp_onlinestore.htm

Saves the generated document to a memory buffer in PDF format and sends it to the client's browser using Response.BinaryWrite.

```vbscript
' Write the contents as a PDF document to a variable and
' return it to the client
OutputBuffer = tx.SaveToMemoryBuffer(OutputBuffer, 12, 0)
Response.Clear
Response.ContentType = "application/pdf"
Response.AddHeader "Content-Disposition", "attachment; filename=order.pdf"
Response.BinaryWrite(OutputBuffer)

```

--------------------------------

### TXTextControl.TableFromSelection Method

Source: https://www.textcontrol.com/documentation/ocx-contents.htm

Creates a new table from the current text selection.

```APIDOC
## TXTextControl.TableFromSelection Method

### Description
Converts the current text selection into a table. The structure of the table will be determined by the selection content.

### Method
Method

### Parameters
None

### Response
None
```

--------------------------------

### TXTextControl.TrackedChangeUserName Property

Source: https://www.textcontrol.com/documentation/ocx-contents.htm

Gets the username associated with a tracked change.

```APIDOC
## TXTextControl.TrackedChangeUserName Property

### Description
Gets the username of the person who made the tracked change.

### Method
Property

### Parameters
None

### Response
None
```

--------------------------------

### TextField.start Property Syntax

Source: https://www.textcontrol.com/documentation/widget-html/n_txtextcontrol.textfield.start.htm

This property is read-only and returns the 1-based index of the first character within the text field.

```javascript
TextField.start
```

--------------------------------

### TXTextControl.StatusBarHandle Property

Source: https://www.textcontrol.com/documentation/ocx-contents.htm

Gets or sets the status bar handle.

```APIDOC
## TXTextControl.StatusBarHandle Property

### Description
Gets or sets the handle to the status bar associated with the control.

### Method
Property

### Parameters
None

### Response
None
```
Tokens:
Raw