[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
    [Expand]Document
     Supported Document Formats and Printing
     Import and Export
     Formatting Characters
     Formatting Paragraphs
     AutoCorrect
    [Expand]Fields
     Mail Merge
     Simple View
     Table of Contents
     Restrictions
     Spell Checking
    [Collapse]Client API
      Document Model Information
      Client Selection
      Client Commands
    [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 and Dashboard Server
[Expand]Dashboard
[Expand]eXpressApp Framework
[Expand]eXpress Persistent Objects
[Expand]CodeRush
[Expand]CodeRush Classic
[Expand]Cross-Platform Core Libraries
[Expand]Tools and Utilities
 End-User Documentation
ASP.NET Controls and MVC Extensions > ASP.NET WebForms Controls > Rich Text Editor > Concepts > Client API > Document Model Information
View this topic on docs.devexpress.com (Learn more)

Document Model Information

The client RichEdit's ASPxClientRichEdit.document property is an entry point to objects containing information about the current state of the document model. These informational objects are exact copies of internal structural elements (such as sections or styles of characters, paragraphs and tables, etc.) constituting the real document model of the RichEdit. The implementation of the RichEdit client API considers these public info objects to be temporary containers of the document model state. They represent the actual state of the document model only at times of their creation (when they are accessed through client API properties), and after that they are not updated with any further changes occurred in the real document model.

All properties providing access to the informational objects are named in the public client API using the "Info" ending. For instance, the sectionsInfo property (RichEditDocument.sectionsInfo), the spellingInfo property (RichEditDocument.spellingInfo) together with its corresponding SpellingInfo object, etc. Such naming clearly indicates these API members and warns you about the potential temporary nature of their actuality.

The main informational objects are exposed through the properties of the RichEditDocument object returned by the RichEdit's ASPxClientRichEdit.document property. These properties are listed below. In code, they can be accessed in the following notation.
[clientRichEditName].document.[propertyName]

Property Name Link Description
abstractNumberingListsInfo RichEditDocument.abstractNumberingListsInfo Provides information about numbered paragraphs in the document.
activeSubDocument RichEditDocument.activeSubDocument Provides the information about the active sub-document.
characterStylesInfo RichEditDocument.characterStylesInfo Provides information about character styles in the current document.
mainSubDocument RichEditDocument.mainSubDocument Provides access to the document's main sub-document.
paragraphStylesInfo RichEditDocument.paragraphStylesInfo Provides information about paragraph styles in the current document.
sectionsInfo RichEditDocument.sectionsInfo Provides information about sections in the current document.
spellingInfo RichEditDocument.spellingInfo Provides information about spell checking in the current document.
subDocuments RichEditDocument.subDocuments Provides access to the document's sub-documents.
tableStylesInfo RichEditDocument.tableStylesInfo Provides information about table styles in the current document.

The activeSubDocument property (RichEditDocument.activeSubDocument) provides access to the SubDocument object, which, in turn, exposes another set of informational objects through its properties. These objects contain current state settings of document elements which are specific to the sub-document level (such as paragraphs, tables, fields and etc.). Available properties are listed below. They can be used in code in the following notation.
[clientRichEditName].document.activeSubDocument.[propertyName]

Property Name Link Description
bookmarksInfo SubDocument.bookmarksInfo Provides information about document bookmarks.
fieldsInfo SubDocument.fieldsInfo Provides information about fields in the current document.
floatingPicturesInfo SubDocument.floatingPicturesInfo Provides information about floating pictures in the sub-document.
floatingTextBoxesInfo SubDocument.floatingTextBoxesInfo Provides information about floating text boxes contained within the sub-document if it is the main sub-document or header/footer.
inlinePicturesInfo SubDocument.inlinePicturesInfo Provides access to an array of objects containing in-line picture settings.
paragraphsInfo SubDocument.paragraphsInfo Provides information about paragraphs contained in the document.
tablesInfo SubDocument.tablesInfo Provides information about tables contained in the document.

You also can use the SubDocument class's methods to find a sub-document's elements that contained in the specified interval(s):

Method Name Link Description
findBookmarks SubDocument.findBookmarks Returns an array of bookmarks whose names are matched to the specified regular expression.
findFields SubDocument.findFields Returns all fields contained in the specified interval.
findParagraphs SubDocument.findParagraphs Returns an array of paragraphs whose range intersects the specified intervals in the sub-document.
findTables SubDocument.findTables Returns a table if its interval includes the specified position.

Expanded See Also

Document Model
Is this topic helpful?​​​​​​​
Copyright (c) 1998-2018 Developer Express Inc. All rights reserved.