Overview

RadWordsProcessing is part of the Telerik Document Processing libraries. The full documentation for this component is available at https://docs.telerik.com/devtools/document-processing/libraries/radwordsprocessing.

RadWordsProcessing is a processing library that allows to create, modify and export documents to a variety of formats. Through the API, you can access each element in the document and modify, remove it or add a new one. The generated content you can save as a stream, as a file, or send it to the client browser.

The WordsProcessing is part of Telerik UI for Xamarin, a professional grade UI component library for building modern and feature-rich applications. To try it out sign up for a free 30-day trial.

Download Free Trial

Model

The model of RadWordsProcessing includes:

• Sections: You can customize the sections using the properties exposed by the corresponding class. The library provides support for customizing the headers, footers, and watermarks for a section as well.

• Paragraphs: The properties and methods related to paragraphs enable you to change its collection of inlines and appearance.

• Tables: An API for inserting, editing and removing tables. You can also change their rows, cells, appearance, and content.

• Inlines:

  • Runs
  • Images: Including inline and floating images.
  • Fields: Merge fields, Document Variables and custom code fields, enabling you to insert any fields using its code representation.
  • Breaks: Support for different types of breaks, so you can achieve the desired layout.
  • Bookmarks: Inserting, modifying and removing bookmarks.
  • Hyperlinks: You can work with hyperlinks pointing to a website or to a bookmark inside the document.
  • Tab stops: Working with a tab stops collection for each paragraph.

• Styles

  • The document model includes a repository of Style objects which contain sets of character, paragraph or table style properties.
  • The API allows you create custom styles and use them throughout the document.
  • List styles.

• Content Controls: Content controls or Structured Document Tags (SDT) enable users to add specific semantics to part of the document: restricting input, modifying editing behavior etc. This functionality allows adding of checkboxes, combo boxes and other controls to the document as well.

Features

• Mail Merge: Provides ability to produce personalized documents from a template holding fixed content merged with variable data from a data source (database or any other collection of data items).

• Merge documents: Insert a document into another one at the desired position, controlling the way the styles of both are merged.

• Import of document elements: Import a document element from one document into another.

• Clone documents and document elements.

• Replace: RadWordsProcessing gives you the ability to search for a string in a RadFlowDocument instance and replace all matches. The library also allows you to replace the styling of the matches alone.

• RadFlowDocumentEditor: It is intended to simplify the process of creating and modifying a document and achieve the same results as you would using the style properties and child collections of the document elements with less amount of code.

• Formatting

  In addition to the styles, RadWordsProcessing provides support for different types of formatting so you can format any of the document elements:

  • Character formatting: Font size, font color, font name, bold, italic, underline, etc.
  • Paragraph formatting: Line spacing, alignment, indentation, spacing before and after, etc.
  • Table formatting: Enables you to change the alignment, borders, shading, spacing and padding, and more.
  • Modifying the section properties to adjust the page size, orientation, margins, headers, and footers, etc.

Supported formats

The library comes with support for the following document formats:

• DOC & DOT (import only)

• DOCX

• RTF

• HTML

• PDF (export only)

• Plain text

You can import and export documents of these formats as well as convert the format of the document.

Required references

You have two options to add the required Telerik references to your Xamarin.Forms app in order to use RadWordsProcessing:

• Add the Telerik UI for Xamarin Nuget package following the instructions in Telerik NuGet package server topic.

If you don't want to add the all Telerik.UI.for.Xamarin nuget package, you have the option to add a separate nuget package. For RadWordsProcessing you have to install the Telerik.UI.for.Xamarin.Zip, Telerik.UI.for.Xamarin.Documents.Core, Telerik.UI.for.Xamarin.Documents.Flow nuget packages. If you need to export documents to PDF format, you will need to refer the Telerik.UI.for.Xamarin.Documents.Flow.FormatProviders.Pdf and Telerik.UI.for.Xamarin.Documents.Fixed nuget packages.

• Add the references to Telerik assemblies manually, check the list below with the required assemblies for RadWordsProcessing:

  • Telerik.Documents.Core.dll
  • Telerik.Documents.Flow.dll
  • Telerik.Zip.dll

  If you need to import DOC or DOT files, you will need to refer the following assembly:

  • Telerik.Documents.Flow.FormatProviders.Doc.dll

  If you need to export documents to PDF format, you will need to refer the following assemblies:

  • Telerik.Documents.Flow.FormatProviders.Pdf.dll
  • Telerik.Documents.Fixed.dll

  Please keep in mind these assemblies are located in the Portable folder, still, you need to add a reference to them in the Xamarin.Forms project as well as in each of the platform projects (Android | iOS | UWP).