Getting Started: Document Editor with Angular CLI

Prerequisites

There are two ways to evaluate the TX Text Control Document Editor. You can either host your own backend by downloading the trial version of TX Text Control .NET Server for ASP.NET, or by creating a trial access token to use a hosted backend, valid for 30 days:

• Download Trial Version
  Setup download and installation required.
• Create Trial Access Token
  No download and local installation required.

Creating your First Angular Application

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

   Supported Angular Versions

   Are you getting an error similar to this?

   ERESOLVE unable to resolve dependency tree

   Please check the supported Angular versions of tx-ng-document-editor and downgrade Angular and the global Angular CLI version to a version that will satisfy the requirement.

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 replace the complete content with the following code, replace yourtoken with your given Trial Access Token and save it:

   

   Backend Server

   In the code above, a hosted demo backend server is used specified through the webSocketURL property. If you are hosting your own required backend server, replace the URL with your backend endpoint such as ws://localhost:8080/TXWebSocket.

   

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

   ng serve --open

Next Steps

This quick start tutorial helped you to create your first Angular application using the TX Text Control Document Editor. This article is part of a series to help with the next steps to load and save documents and to use the JavaScript API.

Loading and Saving Documents

This tutorial shows how to integrate the JavaScript API into Angular's TypeScript structure to load and save documents.

Read Tutorial

Programming the Document Editor

This tutorial shows how to use the JavaScript API to manipulate the document by adding a table and inserting and modifying merge fields.

Read Tutorial

Angular Document Editor Attributes Explained

This article explains the possible attributes that can be used when initializing the TX Text Control Document Editor for Angular.

Read Tutorial

Building a ASP.NET Core Backend

TX Text Control for Angular requires a backend for the document editor and viewer. This step-by-step walkthrough shows how to create the ASP.NET Core backend.

Read Tutorial

JavaScript API Reference

In order to program the Angular Document Editor, a JavaScript API is available. This API is compatible to all supported platforms including ASP.NET MVC, WebForms and Node.js.

Open Documentation

Article Collection

To find more articles, samples and tutorials, please visit the Getting Started section.

Getting Started