TX Text Control for Angular

TX Text Control for Angular is used to integrate the TX Text Control HTML5-based document editor in Angular applications. In addition to this project, a WebSocketServer project is required and can be created using ASP.NET MVC or Node.js.

This quick-start tutorial uses a hosted demo WebSocketServer endpoint that can be used for evaluation purposes. In order to deploy an application that uses TX Text Control for Angular, a WebSocketServer must be hosted and the synchronization TCP Service needs to be installed on a Windows Server machine. Therefore, refer to the Development and Redistribution article in the ASP.NET documentation.

Getting Started

This tutorial shows how to create your first Angular application using the TX Text Control document editor.

Prerequisites

1. Create your free trial access token here:

   Create Access Token

2. Install Node.js® and npm, if not done before.

3. Open a Command Prompt and install the Angular CLI globally by typing in the following command:

   npm install -g @angular/cli

This tutorial uses Visual Studio Code that can be downloaded for free.

Creating the Angular Project

1. Open a Command Prompt and create a new project and default app by typing in the following command:

   ng new my-editor-app

   Follow the questions in the command prompt by answering them with "y" to add Angular routing and Enter to confirm CSS as your preferred stylesheet format.

2. Change into the created folder by typing in the following command:

   cd my-editor-app

3. Install the TX Text Control document editor package by typing in the following command:

   ng add @txtextcontrol/tx-ng-document-editor

4. Open this folder in Visual Studio Code by typing in the following command:

   code .

5. In Visual Studio Code, open the file src -> app -> app.component.html, add the following code and save it. Replace yourtoken with your actual access token you created at the beginning of this tutorial.

   • HTML

   ​<tx-document-editor
       width="1000px"
       height="500px"
       webSocketURL="wss://backend.textcontrol.com?access-token=yourtoken">
   </tx-document-editor>

   <tx-document-editor width="1000px" height="500px" webSocketURL="wss://backend.textcontrol.com?access-token=yourtoken"> </tx-document-editor>

6. Back in the command prompt, start the Angular application by typing in the following command:

   ng serve --open

Your default browser is opened with your created Angular app:

Component Configuration Syntax

The following lists the available component attributes. Mandatory attributes are width, height and webSocketURL.

• HTML

​<tx-document-editor
    width="1000px"
    height="500px"
    webSocketURL="wss://backend.textcontrol.com?access-token=yourtoken"
    [documentTargetMarkers]="true">
</tx-document-editor>

Loading and Saving Documents

This tutorial shows how to use the Javascript: TXTextControl Object to load and save documents within an Angular application.

1. Create a basic Angular application as described in the TX Text Control for Angular tutorial.

2. Create a folder named js in the folder src/assets/ and create a new JavaScript file named custom.js.

   • JavaScript

   ​function saveDocument() {
       TXTextControl.saveDocument(TXTextControl.StreamType.HTMLFormat,
           function (e) {
               console.log(e.data);
           });
   }
   
   function loadDocument() {
       TXTextControl.loadDocument(TXTextControl.StreamType.HTMLFormat,
           btoa('<strong>Test</strong>'));
   }

   function saveDocument() { TXTextControl.saveDocument(TXTextControl.StreamType.HTMLFormat, function (e) { console.log(e.data); }); } function loadDocument() { TXTextControl.loadDocument(TXTextControl.StreamType.HTMLFormat, btoa('<strong>Test</strong>')); }

3. And add this JavaScript file to the scripts array of the projects architect/build/options element in the angular.json file:

   • JSON

   ​"scripts": [
       "src/assets/js/custom.js"
   ]

   "scripts": [ "src/assets/js/custom.js" ]

4. Add the declaration and the methods onClickSave and onClickLoad to the app.component.ts TypeScript file, so that the complete file looks like this:

   • TypeScript

   ​import { Component } from '@angular/core';
   declare const saveDocument: any;
   declare const loadDocument: any;
   
   @Component({
       selector: 'app-root',
       templateUrl: './app.component.html',
       styleUrls: ['./app.component.css']
   })
   
   export class AppComponent {
       title = 'my-editor-app';
   
       onClickSave() {
           saveDocument();
       }
   
       onClickLoad() {
           loadDocument();
       }
   }

   import { Component } from '@angular/core'; declare const saveDocument: any; declare const loadDocument: any; @Component({ selector: 'app-root', templateUrl: './app.component.html', styleUrls: ['./app.component.css'] }) export class AppComponent { title = 'my-editor-app'; onClickSave() { saveDocument(); } onClickLoad() { loadDocument(); } }

5. Finally, add two buttons to the app.component.html with the Angular click handlers:

   • HTML

   ​<tx-document-editor width="1024" height="800" port="8080"></tx-document-editor>
   
   <div>
       <button (click)="onClickLoad()" class="btn btn-primary">Load Document</button>
       <button (click)="onClickSave()" class="btn btn-primary">Save Document</button>
   </div>

   <tx-document-editor width="1024" height="800" port="8080"></tx-document-editor> <div> <button (click)="onClickLoad()" class="btn btn-primary">Load Document</button> <button (click)="onClickSave()" class="btn btn-primary">Save Document</button> </div>

When executing the application, an HTML document is loaded into the editor and the save button alerts the resulting HTML from the saveDocument method.

JavaScript API

All client-side packages are based on the same component and supports the same JavaScript interface:

Javascript: TXTextControl Object

It is possible to access the object directly using this object or by wrapping the interface in TypeScript as shown in the above demo that shows how to load documents.