Log In
Home
Support
Demos
Documentation
Blogs
Training
Webinars
[Expand]General Information
[Expand]WinForms Controls
[Collapse]ASP.NET Controls and MVC Extensions
 [Expand]Prerequisites
 [Expand]What's Installed
 [Expand]Common Concepts
 [Collapse]ASP.NET WebForms Controls
   Getting Started
  [Expand]Grid View
  [Expand]Tree List
  [Expand]Card View
  [Expand]Reporting
  [Expand]Chart Control
  [Expand]Pivot Grid
  [Expand]Spreadsheet
  [Collapse]Rich Text Editor
   [Expand]Product Information
    Getting Started
   [Collapse]Concepts
     ASPxRichEdit Control
    [Collapse]Document
     [Collapse]Document Model
       Sub-Document
       Text Content (Text Buffer)
       Characters
       Paragraphs
       Inline Pictures
       Hyperlinks and Bookmarks
       Tables
       Sections
       Headers and Footers
       Document Fields
       Floating Objects
       Document Protection
      Document Layout
     Supported Document Formats and Printing
     Import and Export
     Formatting Characters
     Formatting Paragraphs
    [Expand]Fields
     Mail Merge
     Restrictions
     Spell Checking
    [Expand]Client API
    [Expand]Built-in Dialogs
     Adaptivity
     HTML Tag Interpretation
     Keyboard Shortcuts
   [Expand]Examples
  [Expand]Scheduler
  [Expand]Site Navigation and Layout
  [Expand]HTML Editor
  [Expand]Gauges
  [Expand]Vertical Grid
  [Expand]Data Editors
  [Expand]Docking and Popups
  [Expand]File Management
  [Expand]Data and Image Navigation
  [Expand]Multi-Use Site Controls
  [Expand]Spell Checker
  [Expand]Query Builder
 [Expand]ASP.NET MVC Extensions
 [Expand]Localization
 [Expand]Redistribution and Deployment
  Get More Help
 [Expand]API Reference
[Expand]ASP.NET Bootstrap Controls
[Expand]ASP.NET Core Bootstrap Controls
[Expand]WPF Controls
[Expand]Xamarin Controls
[Expand]Windows 10 App Controls
[Expand]Office File API
[Expand]Reporting
[Expand]Report Server
[Expand]Dashboard
[Expand]eXpressApp Framework
[Expand]CodeRush
[Expand]CodeRush Classic
[Expand]Cross-Platform Core Libraries
[Expand]Tools and Utilities
 End-User Documentation

Document Model

Expanded Overview

A document model defines the logical structure of a document, which reflects its logical organization and hierarchically groups the logical entities in a document. It is illustrated in the following scheme.

Expanded Main Elements

A document is not monolithic; it is built out of multiple parts. Relationships between parts are themselves stored in parts. The main entities of the document model are described below.

Sub-document(s)
Internally, the root of the document model is represented by a sub-document object - the main sub-document. It delivers the basic document functionality that is common for the header, footer and the main document body.
A sub-document allows you to manipulate the text, tables, lists, fields, paragraphs, bookmarks.
Learn more...

Section(s)
A document (sub-document) can contain logical sections. Each section defines its own page settings, such as paper kind, page orientation and its margins.
A section allows you to manipulate footers, headers, page properties.
Learn more...

Paragraph(s)
A sub-document contains paragraphs - text blocks that expose own paragraph-specific formatting settings (such as alignment, spacing and indentation).
Learn more...

Character(s)
A paragraph internally consists of runs - groups of characters with uniform formatting.
Learn more...

 

The document model also includes entities that do not comprise the hierarchy, such as lists, tables and styles.

Numbered and Bulleted Lists
The numbered and bulleted lists are represented by specific collections of paragraphs, which expose own list-specific formatting settings.

Styles
Styles can be of the following types - a paragraph style, a character style and a table style.

Tables
Tables are specific structures that are based on paragraphs. Each table cell is actually a paragraph. Therefore, you should operate with a corresponding paragraph for changing cell content. Cell formatting and paragraph formatting are superimposed, so you are advised to specify cell formatting explicitly to get the desired result.
Learn more...

Default Tab Width
Specifies the default width of tabulation in the whole document. This width can be redefined in paragraphs.

Page Back Color
Specifies the background color for all pages in the document.

Different Odd And Even Pages
An option specifying which footers/headers to use for a section.

Expanded Client API

The following client-side API is available. It provides information about the current settings of the main document model elements and allows you to modify certain element settings.

Properties

The properties listed below can be accessed through the ASPxClientRichEdit.document property in the following notation:
clientRichEditName.document.propertyName

Property Name Link Description
activeSubDocument RichEditDocument.activeSubDocument Provides the information about the active sub-document.
sectionsInfo RichEditDocument.sectionsInfo Provides information about sections in the current document.
characterStylesInfo RichEditDocument.characterStylesInfo Provides information about character styles in the current document.
paragraphStylesInfo RichEditDocument.paragraphStylesInfo Provides information about paragraph styles in the current document.
abstractNumberingListsInfo RichEditDocument.abstractNumberingListsInfo Provides information about numbered paragraphs in the document.
tableStylesInfo RichEditDocument.tableStylesInfo Provides information about table styles in the current document.

Commands

The commands listed below can be accessed through the ASPxClientRichEdit.commands property and be executed in the following notation:
clientRichEditName.commands.commandName.execute(parameter_if_any)

Command Name Link Description
changePageColor RichEditCommands.changePageColor Gets a command to set the background color of all pages contained in the document.
setDifferentOddAndEvenPagesHeaderFooter RichEditCommands.setDifferentOddAndEvenPagesHeaderFooter Gets a command to enable (or disable if it is enabled) a different page header and footer for odd and even pages of the current section.
changeTabs RichEditCommands.changeTabs Gets a command to change the default tab stop value of a document and apply custom tab settings to the selected paragraphs. Sets only the defaultTabStop parameter.

Is this topic helpful?​​​​​​​