Text Module · 2021. 7. 30. · Version 2.4.27307.0 of COSMO Text Module added more translations for English-speaking countries. Features and enhancements The following features are

Text ModuleText ModuleOnline Help PDFOnline Help PDFDate 09/08/2021

COSMO CONSULT GmbHCOSMO CONSULT GmbHSchöneberger Straße 1510963 BerlinPhone: +49 30 343815-0Fax: +49 30 343815-111Email: [email protected]: www.cosmoconsult.com

Table of ContentsCOSMO Text Module

What's new in version 2.6.44303.0Features and enhancements

Hotfixes

Removed or deprecated features

Technical specifications


Hotfixes




Hotfixes




Hotfixes




Hotfixes




Hotfixes



Install the AppTo install in SaaS environment

5

6

6

6

6

6

8

8

8

8

8

10

10

10

10

11

12

12

12

12

13

14

14

14

14

14

16

16

16

16

16

18

18

TEXT MODULE | TABLE OF CONTENTS 2 / 44

AppSource

Extension Marketplace

To install in on-premises environment

Docker

Server Instance

App Registration and LicensingTo register the app

To check the license

Setting Up Text Module

Text Module SetupMore information on the related menu actions

Text Module Print ManagementExample

Assignment to Text Records

Example

Text Processing

Master Data SetupText Module Card

Specific fields on the General FastTab

Specific fields on the Lines FastTab

Navigate Menu

Master Data (Customer) Header and Footer Text Setup

Master Data (Item) Text Setup

Text on DocumentsDocument Text Review

Edit Text Page

More information on specific actions

Report Text Review

Hide/Show Text

Standard Texts

Standard Text

Standard Sales Text / Standard Purchase TextUsages Text

18

18

19

19

20

22

22

22

24

25

25

27

27

27

27

28

29

29

29

29

30

30

30

32

32

32

32

32

33

34

35

36

36


Field Filters

Rich Text EditorMarkups

Integration

Comment Sheet

Extended Texts

Text Module Line

Print Management Pop-Ups

Custom Integration

CustomizeEditor Action

Embedded Editor

36

37

37

37

37

38

38

39

39

40

40

41


COSMO Text ModuleCOSMO Text ModuleThe COSMO Text Module functionality provides users with the ability to add more information torecords such as items, vendors, customers, resources, and G/L accounts, as well as to the master dataof the manufacturing module and to the Microsoft Dynamics 365 Business Central standard texts.These texts can then be:

Inserted as headers, footers, and line texts in the purchase, sales, and production pages andprinted in predefined reports.Displayed in predefined pages (system message) without being printed. They can be insertedmanually or automatically.

It is also possible to define language-specific text modules.

COSMO Text Module functionalities are accessed using the Tell Me feature in Microsoft Dynamics365 Business Central. Choose the icon, enter the page name, and then choose the related link.

TEXT MODULE | COSMO TEXT MODULE 5 / 44

What's new in version 2.6.44303.0What's new in version 2.6.44303.0Version 2.6.44303.0 of COSMO Text Module added a pop-up handling solution with Assist Edit.

Features and enhancementsThe following features are included in this release:

PULL REQUEST DESCRIPTION

2782 Add Publisher to the Application Area

2966 Added OnAssistEdit Handling for Sales and Purchase Header

HotfixesThis release fixes the following issues found in the previous version of the app:


2762, 2935 Correction of Pop-Up Dialog Title with RTE

2917 Correction of Missing TM Integration Events from C/AL

Removed or deprecated featuresRemoved obsolete controls, objects and methods:


N/A N/A

Technical specificationsDE TAILS VERSION

Compiled with Runtime 18.1.24822.25371-W1

TEXT MODULE | WHAT'S NEW IN VERSION 2.6.44303.0 6 / 44

Requires Microsoft Base Application 17.0.0.0

Requires COSMO Licensing app 1.1.0.0

DE TAILS VERSION


What's new in version 2.5.36667.0What's new in version 2.5.36667.0Version 2.5.36667.0 of COSMO Text Module added the Rich Text Editor for comments, extendedtexts and text modules.



2658 Added rich text editor



2253 Changed App. Area Event Subscriber to Skip on License

2432 Correction of Test App for Preview BC 18



N/A N/A





DE TAILS VERSION


What's new in version 2.4.27307.0What's new in version 2.4.27307.0Version 2.4.27307.0 of COSMO Text Module added more translations for English-speakingcountries.



2140 Add en-AU, en-CA, en-NZ, en-ZA

2080 New App Settings BC 17

2148 Minor Code Changes



2089 Add missing Licensing Upgrade Tag

2093 Corrected Copy Routing LineText

2139 Corrected Transfer LineText from Planning Routing Line



N/A N/A






What's new in version 2.3.15085.19179What's new in version 2.3.15085.19179In version 2.3.15085.19179 of COSMO Text Module the app was renamed from cc|text modulefor Dynamics 365 Business Central to COSMO Text Module.



1049 Rebranding for AppSource

1594 Add new COSMO Licensing App

919 Check BC App Settings

919 Update Setup Init

920 Add new Event Requests

1266 Add Publisher for editable Texts

978 Add Publisher for AMP Integration

1449 Update Pipelines



1791 Add missing App License Key migration




N/A N/A





What's new in version 2.2.5545.0What's new in version 2.2.5545.0Version 2.2.5545.0 of cc|text module for Dynamics 365 Business Central was changed to BusinessCentral 16.0 compatibility.



- Business Central 16.0 compatibility

- Event Requests



- Correction of AppSource upgrade problems



N/A N/A





DE TAILS VERSION


What's new in version 2.1.1514.1662What's new in version 2.1.1514.1662Version 2.1.1514.1662 of cc|text module for Dynamics 365 Business Central was changed toBusiness Central 15.1 compatibility.



- Business Central 15.1 compatibility

- Updated licensing

- Restructured repository



N/A Correction of AppSource problems



N/A N/A



DE TAILS VERSION

Compiled with Runtime 15.1.37881.38431-DE



Install the AppInstall the AppThis section covers the installation of the COSMO Text Module. Typically an installation is onlyperformed once and is not executed by the user, but an administrator. The installation differs fromSaaS and On-Premises (OnPrem) environment.

To install in SaaS environmentIn SaaS environments, the app can be installed from the AppSource. There are two ways to installthe app, from external and internal of Business Central. All dependencies are installed automatically.Uninstall and install the app again to upgrade to the most current version.

AppSourceAppSource

Visit the AppSource and choose Free trial. You will be forwarded to the page where you must log inwith your Business Central user credentials and must select an environment to install the app to.Follow the wizard instructions to complete the installation.

Extension MarketplaceExtension Marketplace

In Business Central, choose the icon, enter Extension Marketplace, and then choose the relatedlink. In the marketplace, search for COSMO Text Module and select Free trial. Follow the wizardinstructions to complete the installation.

TEXT MODULE | INSTALL THE APP 18 / 44

https://appsource.microsoft.com/product/dynamics-365-business-central/PUBID.cosmoconsultag%257CAID.cc_text_module_business_central%257CPAPPID.ffa26420-b880-4d49-9b2c-c3e60c86b914?tab=Overview

https://appsource.microsoft.com/product/dynamics-365-business-central/PUBID.cosmoconsultag%257CAID.cc_text_module_business_central%257CPAPPID.ffa26420-b880-4d49-9b2c-c3e60c86b914?tab=Overview

To install in on-premises environmentDepending on the technology, different scripts are provided as basis to install the app and itsrequirements in on-premises environments. You can find the runtime packages of the apps in theCOSMO CONSULT Solution Portal. Check the technical specifications of each version to find theminimum dependent version of Business Central and the Base Application. For customer installationswithout a Business Central developer license, you need to create and install a runtime package of theapp (Microsoft Documentation).

Besides the Business Central Base Application, the app depends on additional library apps, thatneeds to be installed in the correct order first.

1. COSMO Licensing app2. COSMO Text Module app

DockerDocker

To install the apps to a docker container, the module BcContainerHelper must be installed first.Change the file names, container name and credential type to your values.


https://solutions.cosmoconsult.com/documentmanagement/ProductSupport

https://docs.microsoft.com/dynamics365/business-central/dev-itpro/developer/devenv-creating-runtime-packages

https://www.powershellgallery.com/packages/BcContainerHelper

$licensingAppFileName = Join-Path $PSScriptRoot "COSMO Licensing.app"$tmAppFileName = Join-Path $PSScriptRoot "COSMO Text Module.app"$Global:containerName = "your-container-name"$Global:credential = "your-credential"

function Install-CosmoAppToContainer { Param ( [Parameter(Mandatory=$true)] [string] $AppFileName ) Publish-BcContainerApp ` -appFile $AppFileName ` -containerName $Global:containerName ` -credential $Global:credential ` -install ` -sync ` -skipVerification ` -scope "Global" ` -syncMode "Add"}

try { if (!(Get-Module -ListAvailable -Name "BcContainerHelper")) { throw "BcContainerHelper must be installed to run this script." }

Install-CosmoAppToContainer -AppFileName $licensingAppFileName Install-CosmoAppToContainer -AppFileName $tmAppFileName

} catch { throw "Error on installation: $($_.Exception.Message)"}

Server InstanceServer Instance

Change the file names and server instance to your values.


$licensingAppFileName = Join-Path $PSScriptRoot "COSMO Licensing.app"$tmAppFileName = Join-Path $PSScriptRoot "COSMO Text Module.app"$Global:serverInstance = "your-server-instance"

function Install-CosmoAppToServerInstance { Param ( [Parameter(Mandatory=$true)] [string] $AppFileName, [Parameter(Mandatory=$true)] [string] $AppName ) Publish-NAVApp ` -ServerInstance $Global:serverInstance ` -Path $AppFileName ` -SkipVerification ` -Scope Global

Sync-NAVApp ` -ServerInstance $Global:serverInstance ` -Name $AppName

Install-NAVApp ` -ServerInstance $Global:serverInstance ` -Name $AppName}

try { Install-CosmoAppToServerInstance -AppFileName $licensingAppFileName -AppName "COSMO Licensing" Install-CosmoAppToServerInstance -AppFileName $tmAppFileName -AppName "COSMO Text Module"

} catch { throw "Error on installation: $($_.Exception.Message)"}

See AlsoApp Registration and LicensingText Module Setup


App Registration and LicensingApp Registration and LicensingThis section covers the registration and license check of the COSMO Text Module app. Wheninstalling the app, COSMO Licensing is automatically installed.

To register the app1. After publishing and installing the app, you need to register COSMO Text Module.2. Start the COSMO App Registration Wizard by choosing Click here to register in the

notification bar.3. In order to agree to the Terms of Use, turn on the I understand and accept these terms

toggle and then choose the Next button.4. Enter your customer name. The name is used to identify the company. For test purposes, enter

any Cronus-related name.5. Choose the Next button to sign into the COSMO Platform to link the registration with your

account. The COSMO Platform opens in a new browser tab. After sign in you can close this taband return to the final page of the COSMO App Registration Wizard.

To skip this step, choose the Skip Login button.

You have successfully registered for a demo version of the app. [email protected] and use the displayed license key to update your demo subscription.

NOTEYour demo license will be valid for 30 days.

5. Choose the Finish button to close the wizard.6. App registration is now finished.

NOTEYou can register your app and perform other administrative licensing tasks from theCOSMO License Overview page.

To check the licenseThe COSMO License Overview page lists the license status of all COSMO apps (if the COSMO app isalready using the Licensing app) and is accessed using the Tell Me feature.

1. Choose the icon, enter License Overview, and then choose the related link. This page canalso be opened from the Text Module Setup page (Actions > App Licensing) and the last

TEXT MODULE | APP REGISTRATION AND LICENSING 22 / 44

mailto:[email protected]

page of the COSMO App Registration Wizard by choosing Open License Overview.2. In the COSMO License Overview page, apps can be registered if not done on the Role Center

notification bar. Other administrative tools are available as well.3. Hover over an action on the COSMO License Overview page to read a short description.

See AlsoApp InstallationText Module Setup

TEXT MODULE | APP REGISTRATION AND LICENSING 23 / 44

Setting Up Text ModuleSetting Up Text ModuleThis section covers the initial setup of the COSMO Text Module functionality. Typically this setup isonly performed once and is not modified by standard users.

Further steps are needed to set up COSMO Text Module. The following table describes a sequenceof tasks, with links to the topics that describe them.

TO SEE

Set up Text Module. Text Module Setup

Set up Text Module Print Management. Text Module Print Management

TEXT MODULE | SETTING UP TEXT MODULE 24 / 44

Text Module SetupText Module SetupThis topic explains the setup page of COSMO Text Module.

The Text Module Setup page is accessed using Tell Me. Choose the icon, enter Text ModuleSetup, and then choose the related link.

More information on the related menu actionsSetup > Predefined Setup

NOTENew areas and customized reports/tables must be added manually to the Text Module Use inArea Base List and Text Module Object Setup pages.

Expert > Object Setup

Object Setup defines all objects where the text should be printed and/or displayed. The value in theObject Type field determines where and how text is displayed:

Report – Indicates that text will be on a printed report. For example, in the header of an OrderConfirmation report or the lines of a Purchase Order report.Table – Indicates that text will be in a document header/lines. Additionally, the text to be copiedwill be displayed in a pop-up page. For example, text assigned to a customer will be displayed ina pop-up page when the Customer No. field is populated in a Sales Order.

Only objects that are set up in the Text Module Object Setup page are available for selection in theText Module Print Management page. For more information, see Text Module Print Management.

By default, the Use check box is selected on all reports and tables and is used for informationalpurposes.

NOTEIn various versions of Microsoft Dynamics 365 Business Central, some reports from the ID range1300 are set up in the Report Selection - Sales and Report Selection - Purchase pages. Thesereports are not prepared to print text from COSMO Text Module. Therefore, ensure that thecorrect reports are set up for sales (ID range 200..) and purchases (ID range 400..) in therespective Report Selection page.

TEXT MODULE | TEXT MODULE SETUP 25 / 44

See AlsoRich Text Editor

TEXT MODULE | TEXT MODULE SETUP 26 / 44

Text Module Print ManagementText Module Print ManagementThe Text Module Print Management page creates the link between text lines and the objects to beprinted and/or displayed. Hover over a field to read a short description.

ExampleA SALES code is set up with various sales reports and tables. This means that text with Print Mgt.Code = SALES will be displayed on the noted reports and will be displayed in pop-up pages forheader and line text in sales quotes and orders.

Assignment to Text RecordsThe Print Management Code can be added to text assigned to master data or standard text in thelines of the Text Module Card (see Text Module Card) or in the Edit Text page (see Edit Text Page),generally accessible from document headers/lines.

ExampleAs stated in the previous example, assigning the SALES print management code to text in the salesorder header means that it will be displayed in the Order Confirmation report. To prevent the textfrom being on the report, remove the value in the Print Mgt. Code field.

TEXT MODULE | TEXT MODULE PRINT MANAGEMENT 27 / 44

Text ProcessingText ProcessingOnce the setup is complete, text can be added to the relevant master data. Text is always editable onthe following master data:

Standard TextG/L AccountCustomerVendorItemResourceShip-to AddressWork and Machine Center

In documents like sales orders and purchase orders, the status determines if the text is editable ornot (open = editable, released = not editable). In all posted and archive documents, the text is noteditable.

This section explains the text setup on customer reports and pages based on the Setup. The samesetup is used for all other master data.

See AlsoMaster Data SetupText on Documents

TEXT MODULE | TEXT PROCESSING 28 / 44

Master Data SetupMaster Data SetupDepending on the master data, different text can be assigned. For example, on customers andvendors, header and footer data can be assigned; on items, single text can be assigned, which meansthe text is printed below the item description – similar to extended text in standard MicrosoftDynamics 365 Business Central.

Text Module CardThe setup of text is managed in the Text Module Card page. Initially, the text is entered in this pageand then viewed/modified from the individual documents.

In this section, the Text Module Card page is described.

Specific fields on the General FastTabSpecific fields on the General FastTab

The General FastTab identifies the type of text, languages, and length of usage.

The Language Code field indicates in which language the text is displayed.

NOTEIf Language Codes are defined on the customer card, then fill in the Language Code field and/orturn on the All Languages toggle on the Text Module Card. Changes cannot be made to theLanguage Code field after other fields are populated.

The All Languages field determines if the text is to be used independently from the language codeof the vendor or customer if no other text was detected using the current language code.

For example, header text is created in English (ENG) and German (DEU). This text will be displayedonly on documents for customers/vendors that have either language code. To make the textavailable for all customers/vendors in one of the languages, for example, ENG, then the Text ModuleCard should be set up with Language Code = ENG and All Languages = Yes. Therefore, theENG text will be available for a customer/vendor with Language Code = ESP.

Specific fields on the Lines FastTabSpecific fields on the Lines FastTab

Italic / Bold / Underline / Color

Formatting options that determine how the text appears on reports and documents.

TEXT MODULE | MASTER DATA SETUP 29 / 44

NOTEWhen multiple text lines are entered, the formatting from the above line is copied to the nextline.

Print Mgt. Code

Determines if the text will be displayed on reports or in pop-up pages on documents. Leave this fieldempty to exclude the text from reports and pop-up pages.

Multiple lines can be added to the Text Module Card with different print management codes.Therefore, multiple lines of text can be entered, for example, on an Item Card with some textassigned to codes for sales documents and others assigned to codes for purchase documents. Therelevant text will be displayed in the relevant documents: sales text will be displayed only onheader/footer text for sales documents, and so on.

NOTEWhen multiple text lines are entered, the code from the above line is copied to the next line.

TIPThe fields in the Lines FastTab are the same fields used in the Edit Text page.

Navigate MenuNavigate Menu

The Navigate menu contains the Get Standard Text action. This action is used to bring standardtext into the Text Module Card. For more information about using the Standard Text functionality, seeStandard Texts.

Master Data (Customer) Header and Footer Text SetupWhen text is assigned to master data, such as a customer or vendor, it can be displayed on a printeddocument as a header or footer. Header text is before the body of the document and Footer text isat the end – similar to stationary/letter text.

Access the Text Module Card from the Customer Card by choosing Customer > Text Module onthe Navigate menu.

Master Data (Item) Text SetupWhen text is assigned to master data, such as an item, it can be displayed on a printed document. Asopposed to customer or vendor text, item text does not distinguish between header and footer text.


Access the Text Module Card from the Item Card by choosing Item > Text Module on theNavigate menu.


Text on DocumentsText on DocumentsOnce the text has been assigned to the master data items, it can be used on the documents. In thissection, the sales order is used to review text setup and the Order Confirmation report is used topreview the document text.

Document Text ReviewWhen a document, such as a sales order, is assigned to a customer that has been assigned text witha pop-up, the Text Info page opens to display the header text, the footer text, or both.

The text relating to the customer can be accessed on the Sales Order by choosing Order > HeaderTexts or Footer Texts on the Navigate menu. In the Edit Text page, existing text can be viewed oredited, or new text can be added.

Pop-up pages can also open when items with text are added to a document.

On the Lines FastTab, choose Line > Line Texts to access the assigned item-related text. Similar tothe customer text, the item text can be viewed and modified in the Edit Text page.

Edit Text PageThe Edit Text page is used to view or modify existing text or to add new text. This page also includesthe Print Code field, which is used to filter the lines by a Print Mgt. Code if multiple lines exist withdifferent codes. The fields in the lines are the same as in the Lines FastTab on the Text Module Card.For more information about these fields, see Specific fields on the Lines FastTab.

The Actions menu on the Edit Text page contains actions for copying and reverting changes to text.Hover over the actions to read a short description.

More information on specific actionsMore information on specific actions

The Undo Changes action reloads the text from the document and removes all changes made sinceopening the text.

For example, text has been assigned to a customer card. You create a sales order for this customer,open the Edit Text page, and accidentally delete a line. When using this function, all changes arereverted to the text that existed when the Edit Text page was opened.

Report Text ReviewOnce the report is ready, it can be printed or previewed with the assigned text.

TEXT MODULE | TEXT ON DOCUMENTS 32 / 44

Hide/Show TextTo remove the header, footer, or item text from the document, open the relevant text and delete thevalue in the Print Mgt. Code field. It can be re-added by filling in the Print Mgt. Code field again.

TEXT MODULE | TEXT ON DOCUMENTS 33 / 44

Standard TextsStandard TextsStandard Texts offer the ability to create a text pool with a variety of different texts. The advantage isthat texts of the text pool can be copied into master data and documents as headers, footers, or linetexts instead of creating them manually each time. Manual modifications of the copied texts arepossible (the original text of the text pool is not affected by these modifications).

Standard Text can be created generally or specific to sales and purchases.

See AlsoStandard TextStandard Sales Text / Standard Purchase TextRich Text Editor

TEXT MODULE | STANDARD TEXTS 34 / 44

Standard TextStandard TextStandard Text is the general text that can be used in multiple areas. It is created in the Text ModuleStandard Text Card page, which is accessed using Tell Me. Choose the icon, enter Text ModuleStandard Text List, and then choose the related link. The Text Module Standard Text Card is setup in the same way as in the Text Module Card page (see Text Module Card).

Once setup is complete, this standard text can be brought into master data text by choosingFunction > Get Standard Text on the Navigate menu in the Text Module Card or into documentsby choosing Get Standard Text > Paste Above or Paste Below on the Actions menu in the EditText page.

NOTELanguage and date ranges are not considered when these functions are used; all standard textwill be available for selection.

TEXT MODULE | STANDARD TEXT 35 / 44

Standard Sales Text / Standard Purchase TextStandard Sales Text / Standard Purchase TextWith the Sales Text functionality, you can enter standard texts to be printed and viewed respectivelyin sales documents/pages. The Purchase Texts functionality offers you the ability to predefinestandard texts to be printed and viewed respectively in purchase documents/pages.

Standard Sales/Purchase text is created in the Text Module Sales Text Card or Text ModulePurchase Text Card page, respectively. These pages are accessed using Tell Me. Choose the icon,enter Text Module Sales Text List or Text Module Purchase Text List, and then choose therelated link.

The setup of standard sales and purchase text is generally the same as for other text with theexception of the usages text, which is described in the following section.

Usages TextUsages text limits for which customer/vendor that Standard Sales/Purchase Text should be copied toa document. Access the Text Module Usages page by choosing Text Module > Use for on theNavigate menu in the Text Module Sales Text Card or Text Module Purchase Text Card.

In the Use for Type field, you can set limits on several customers/vendors, a whole Country Code, orset filters on fields in the customer/vendor records. In the Use for Code field, the appropriatecustomers and vendors, respectively, are defined for non-filter entries. The Name field displays theselected customer, vendor, or filter field caption.

Field FiltersField Filters

To set up field filters, the Use for Type field must be set to Customer (Field Filter) or Vendor (FieldFilter), respectively. In the Field Filter No. field, select the field number on which the filter is to be set,and in the Field Filter Term field, enter the filter expression.

For example, to define a text that should be copied for all customers/vendors, insert one entry withUse for Type = Customer (Field Filter) and one entry for Use for Type = Vendor (Field Filter). Oneach entry, set the Field Filter No. = 1 and Field Filter Term = * (* is a wild card filter).

TEXT MODULE | STANDARD SALES TEXT / STANDARD PURCHASE TEXT 36 / 44

Rich Text EditorRich Text EditorThe Rich Text Editor is an additional granule (TM Rich Text Editor) for COSMO Text Module. Therich text editor controls on different pages can be enabled using the Enable Rich Text EditorControls field on the Text Module Setup page.

The rich text editor is available for the following functionality:

Comment SheetExtended TextsText Module Line

MarkupsThe available markup actions of the editor are defined by the Show RDLC Markups and s fields onthe Text Module Setup page for each implementation group.

The Show RDLC Markups fields control the following actions:

Text format (bold, italic, underline, strikethrough)Font selection and sizeContainer type (header, paragraph)List (ordered, unordered)Link (hyperlink, anchor)

The Show Extended Markups fields control the following actions:

Color (fore and background)AlignmentIndentationMedia (images, files)

IntegrationThe rich text editor is integrated into some Base Application and Text Module areas by default.

Comment SheetComment Sheet

On the Comment Sheet page (for example of an item), the rich text editor is visible on the bottomof the page. For each comment line, a rich text can be entered. The Rich Text field in the lineworksheet indicates if a rich text is managed for the line.

TEXT MODULE | RICH TEXT EDITOR 37 / 44

To create a rich text, simply add the text into the editor at the bottom. The text will be automaticallysaved after leaving the line, control or page. The textual content of the editor is transformed intoplain text and set as Comment for the comment line. Once a line contains rich text, the Commentfield in the worksheet is not editable.

The available markup actions of the editor are defined by the Show RDLC Markups and ShowExtended Markups fields on the Text Module Setup page in the Comment Sheet group. For moreinformation, see Markups.

Extended TextsExtended Texts

On the Extended Text page (for example of an item), the rich text editor is visible between theGeneral and the Lines FastTabs. A rich text is managed for an extended text header. The Rich Textfield indicates if a rich text is managed for the header.

To create a rich text, the header record must exist first. Afterwards, the text can be added into theeditor. The text will be automatically saved after leaving the editor, control or page. If the AutomaticLine Conversion field on the Text Module Setup page is enabled, the text is transformed into plaintext and into extended text lines. Existing text lines will be overwritten. If the Automatic LineConversion field is disabled, the Convert to Lines action is visible in the editor's action bar toexecute the transformation on demand.

The available markup actions of the editor are defined by the Show RDLC Markups and ShowExtended Markups fields on the Text Module Setup page in the Extended Texts group. For moreinformation, see Markups.

Text Module LineText Module Line

On the Text Module Card page (for example of an item), the rich text editor is not directlyembedded. The editor can be opened using the Rich Text Editor or Rich Text Editor (LineConversion) actions on the Lines FastTab. A rich text is managed for a text module line. The RichText field indicates if a rich text is managed for the line. It's possible to manage different rich textsfor different text module lines of the same text module header, and therefore, use different printmanagement codes.

To create a rich text, the line record must exist first. The Rich Text Editor action will open the editorwithout post-processing the text into lines. If the editor dialog is closed by choosing the OK button,the text will be saved, transformed into plain text, and the Text field will be set to the plain content.The field in the lines section is not editable anymore. If the editor is closed by choosing the Closebutton, the text will not be saved.

The Rich Text Editor (Line Conversion) action behaves similar to the Rich Text Editor action.Additionally, it will transform the plain text into text module lines afterwards. All linked lines (children)


will be indented to visualize the relation. When you open the editor for a linked line, it will open theparent's rich text. The Text field of the line managed by rich text is not editable. The text module linemarkups (bold, italic, underline, color) are still editable, but will be reset with the next line conversion.

NOTEMarkups of the rich text will not be transformed into text module line markups.

Print Management Pop-UpsPrint Management Pop-Ups

Using the print management with the table setting, will create pop-ups, for example on documents.To show the rich text of the text modules, enable the editor for the information by choosing the UseRich Text Editor for Info Text field on the Text Module Setup page.

Custom IntegrationCustom Integration

For more information on how to customize the editor implementation, see Customize Rich TextEditor.

See AlsoText Module SetupCustomize Rich Text Editor


CustomizeCustomizeIt's possible to embed the editor on an existing page or add an action to open the editor in aseparate page.

Editor ActionThe easiest way to implement the editor is to open it by an action.

Here is an example of adding the actions:

action(ActionRichTextEditor){ ApplicationArea = CCSTMRTE; Caption = 'Rich Text Editor'; Image = DocumentEdit; Promoted = true; PromotedCategory = Process; PromotedOnly = true; ToolTip = 'Open the rich text editor for the selected line.';

trigger OnAction() begin OpenRichTextEditor(false); CurrPage.Update(false); end;}action(ActionRichTextEditorLineConversion){ ApplicationArea = CCSTMRTE; Caption = 'Rich Text Editor (Line Conversion)'; Image = DocumentEdit; Promoted = true; PromotedCategory = Process; PromotedOnly = true; ToolTip = 'Open the rich text editor for the selected line and convert the text into plain text document lines, afterwards.'; Visible = PageEditable;

trigger OnAction() begin OpenRichTextEditor(true); CurrPage.Update(false); end;}

TEXT MODULE | CUSTOMIZE 40 / 44

Here is an example of calling the editor on action:

local procedure OpenRichTextEditor(LineConversion: Boolean)var TempRichTextLine: Record "CCS TM Line Document" temporary;begin TempRichTextLine.Copy(Rec, true); OpenRichTextEditor(TempRichTextLine, LineConversion, CurrPage.Editable);end;

procedure OpenRichTextEditor(RichTextLine: Record "CCS TM Line"; LineConversion: Boolean): Booleanvar RichTextEditor: Page "CCS TM Rich Text Editor";begin RichTextEditor.SetContent(GetRichText(RichTextLine, RichTextLine.FieldNo("Rich Text"))); RichTextEditor.SetRequestPageId(Page::"CCS TM Subform"); RichTextEditor.SetEditable(true); if RichTextEditor.RunModal() = Action::OK then begin SetRichText(RichTextLine, RichTextEditor.GetContent()); SetLineText(RichTextLine, RichTextEditor.GetText()); RichTextLine.Modify(); DeleteChildLines(RichTextLine); if LineConversion then ConvertLines(RichTextLine, RichTextEditor.GetText()); exit(true); end;end;

The line conversion will not be handled in detail. Check codeunit 5060608 "CCS TM Rich Text Management" for details.

Embedded EditorThe CCS TM Rich Text Editor user control defines the rich text editor. To embed the editor on anexisting page, the user control must be added, and saving and loading the content must be handled.

Here is an example of adding the user control:


group("CCS TM Rich Text Editor Group"){ Caption = 'Rich Text Editor';

usercontrol("CCS TM Rich Text Editor"; "CCS TM Rich Text Editor") { ApplicationArea = CCSTMRTE;

trigger OnControlAddInReady() var Management: Codeunit "CCS TM Rich Text Management"; begin CurrPage."CCS TM Rich Text Editor".InitializeEditor(Management.GetEditorToolbarString(Page::"Extended Text")); end;

trigger OnEditorInitialized() begin EditorInitialized := true; LoadContentToEditor(); end;

trigger OnEditorChange(Content: Text; Text: Text) begin SaveContentFromEditor(Content); end; }}

Here is an example of handling the saving and loading of content:


trigger OnAfterGetCurrRecord()begin LoadContentToEditor();end;

local procedure UpdateControls()begin if EditorInitialized then CurrPage."CCS TM Rich Text Editor".SetReadOnly(not Editable);end;

local procedure LoadContentToEditor()var Content: Text; InStr: InStream;begin if not EditorInitialized then exit;

Rec.CalcFields("CCS TM Rich Text"); Rec."CCS TM Rich Text".CreateInStream(InStr); InStr.Read(Content); CurrPage."CCS TM Rich Text Editor".SetContent(Content);end;

local procedure SaveContentFromEditor(Content: Text)var OutStr: OutStream;begin if StrLen(Content) > 0 then begin Clear(Rec."CCS TM Rich Text"); Rec."CCS TM Rich Text".CreateOutStream(OutStr); OutStr.Write(Content); end else Clear(Rec."CCS TM Rich Text");end;

To convert lines, you can listen to an event of the user control:

trigger OnConvertToLines(Content: Text; Text: Text)begin ConvertLines(Text);end;

The conversion implementation could look like this:


local procedure ConvertLines(EditorText: Text)var Line: Text; LineLine: Text; Lines: List of [Text]; LineLines: List of [Text]; Management: Codeunit "CCS TM Rich Text Management"; NextLineNo: Integer; ExtendedTextLine: Record "Extended Text Line";begin DeleteChildLines(); NextLineNo := 1; Management.ConvertTextToLines(EditorText, Lines); foreach Line in Lines do begin Management.SplitTextToLines(Line, MaxStrLen(ExtendedTextLine.Text), LineLines); foreach LineLine in LineLines do begin CreateLine(NextLineNo, LineLine); NextLineNo += 1; end; end;end;

local procedure CreateLine(LineNo: Integer; Value: Text)var ExtendedTextLine: Record "Extended Text Line";begin ExtendedTextLine."Table Name" := Rec."Table Name"; ExtendedTextLine."No." := Rec."No."; ExtendedTextLine."Language Code" := Rec."Language Code"; ExtendedTextLine."Text No." := Rec."Text No."; ExtendedTextLine."Line No." := LineNo; ExtendedTextLine.Text := Value; ExtendedTextLine.Insert();end;

local procedure DeleteChildLines()var ExtendedTextLine: Record "Extended Text Line";begin ExtendedTextLine.SetRange("Table Name", Rec."Table Name"); ExtendedTextLine.SetRange("No.", Rec."No."); ExtendedTextLine.SetRange("Language Code", Rec."Language Code"); ExtendedTextLine.SetRange("Text No.", Rec."Text No."); if not ExtendedTextLine.IsEmpty then ExtendedTextLine.DeleteAll();end;
