TX Text Control Document Services HTML5 Document Editor (Angular version)

This library offers a HTML5 based rich text editor for TX Text Control DS Server. Give your users an MS Word compatible document editor to create powerful reporting templates anywhere - in any HTML5-based browser including Google Chrome, Firefox, Safari and Internet Explorer.

Installation

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

Important notice: From Angular v17 onwards, "standalone" apps are the new default for the CLI. If you want DocumentEditorModule to be added to your app.module.ts automatically, you have to use the --no-standalone flag when creating a new Angular project with ng new. Standalone applications created without this flag will show the error Bootstrap call not found when using the ng add command.

Usage

Your component.html could look like this, for example (the only mandatory attributes are width, height and serviceURL):

<tx-ds-document-editor
   width="1024px"
   height="1024px"
   serviceURL="https://your.server.com/documentservices"
   oauthClientID="dsserver.u5NQQHkgjmCRAOeChUVc19zNFJ9aivKz"
   oauthClientSecret="tPGgkutg8oYuSHPbfuRfE5DMf9arUCEg"
   [userNames]="['user1', 'user2']">
</tx-ds-document-editor>

Possible attributes

• width (string) - The width of the component (e. g. "1024px").
• height (string) - The height of the component (e. g. "1024px").
• serviceURL (string) - The server which is hosting your installation of Text Control DS Server.
• oauthClientID (string) - The OAuth client ID.
• oauthClientSecret (string) - The OAuth client secret.
• documentData (string) - Base64 encoded document data.
• documentFileFormat (string) - The file format of the document data. Possible values are 'HTML', 'RTF', 'TXT', 'TX', 'DOC', 'PDF', 'DOCX' and 'XLSX'.
• jsonData (string) - The data source for the reporting tab.
• editMode (string) - Sets whether the document's text is read-only, can be selected or is editable. Possible values are 'Edit', 'ReadAndSelect', 'ReadOnly' and 'UsePassword'.
• contextMenusEnabled (boolean) - Sets whether a right click opens a context menu or not.
• formattingPrinter (string) - The name of a printer the text dimensions and capabilities of which are used to format the document.
• culture (string) - The culture (e. g. 'de-DE'). Affects date and time string formats, for example.
• uiCulture (string) - The user interface culture (e. g. 'en-US'). Affects the string resource language.
• userNames (string[]) - An array 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.
• reconnectTimeout (number) - Time in seconds before stopping reconnection attempts after a connection loss.
• accessToken (string) - An (OAuth-) access token acquired through a self implemented workflow. When this attribute is present, oauthClientID and oauthClientSecret are ignored.
• customQueryParams (Object.<string, any>) - Specifies user-definable query parameters which are added to the query string of each HTTP request.

Events

Because the script containing the main TXTextControl object is loaded in a deferred manner, the component provides a global event ("dsDocumentEditorLoaded") which is fired as soon as the object is available. The event is dispatched on the document object. You can subscribe to it in your component.ts as follows:

@HostListener('document:dsDocumentEditorLoaded')
onDsDocumentEditorLoaded() {
   console.log('The TXTextControl object exists from now on.');
   TXTextControl.addEventListener("ribbonTabsLoaded", () => console.log('The ribbon tabs have been loaded completely.'));
}

Environment Support

• Angular 15.0.0 or higher
• TX Text Control DS Server version 3.5.0 or higher.