Log In
Home
Support
Demos
Documentation
Blogs
Training
Webinars
[Expand]General Information
[Collapse]WinForms Controls
  Prerequisites
 [Expand]What's Installed
 [Expand]Build an Application
 [Expand]Controls and Libraries
 [Expand]Common Features
  Get More Help
 [Collapse]API Reference
  [Expand]DevExpress.DataAccess.UI.Design
  [Expand]DevExpress.DataAccess.UI.EntityFramework
  [Expand]DevExpress.DataAccess.UI.Excel
  [Expand]DevExpress.DataAccess.UI.Localization
  [Expand]DevExpress.DataAccess.UI.ObjectBinding
  [Expand]DevExpress.DataAccess.UI.Sql
  [Expand]DevExpress.DataAccess.UI.Wizard
  [Expand]DevExpress.DataAccess.UI.Wizard.Services
  [Expand]DevExpress.DataAccess.UI.Wizard.Views
  [Expand]DevExpress.DocumentView
  [Expand]DevExpress.DocumentView.Controls
  [Expand]DevExpress.LookAndFeel
  [Expand]DevExpress.LookAndFeel.Helpers
  [Expand]DevExpress.Skins
  [Expand]DevExpress.Snap
  [Expand]DevExpress.Snap.API.Native
  [Expand]DevExpress.Snap.Core
  [Collapse]DevExpress.Snap.Core.API
   [Expand]AfterInsertSnListColumnsEventArgs Class
    AfterInsertSnListColumnsEventHandler Delegate
   [Expand]AfterInsertSnListDetailEventArgs Class
    AfterInsertSnListDetailEventHandler Delegate
   [Expand]AfterInsertSnListEventArgs Class
    AfterInsertSnListEventHandler Delegate
   [Expand]AfterInsertSnListRecordDataEventArgs Class
    AfterInsertSnListRecordDataEventHandler Delegate
   [Expand]BeforeInsertSnListColumnsEventArgs Class
    BeforeInsertSnListColumnsEventHandler Delegate
   [Expand]BeforeInsertSnListDetailEventArgs Class
    BeforeInsertSnListDetailEventHandler Delegate
   [Expand]BeforeInsertSnListEventArgs Class
    BeforeInsertSnListEventHandler Delegate
   [Expand]BeforeInsertSnListRecordDataEventArgs Class
    BeforeInsertSnListRecordDataEventHandler Delegate
   [Expand]CalculatedField Class
   [Expand]CalculatedFieldCollection Class
   [Expand]DataFieldInfo Class
   [Expand]DataSourceChangedEventArgs Class
    DataSourceChangedEventHandler Delegate
    DataSourceChangeType Enumeration
   [Expand]DataSourceInfo Class
   [Expand]DataSourceInfoCollection Class
    GroupInterval Enumeration
   [Expand]IDataSourceOwner Interface
   [Expand]ISnapFieldOwner Interface
   [Expand]Parameter Class
   [Expand]ParameterCollection Class
   [Expand]PrepareSnListColumnsEventArgs Class
    PrepareSnListColumnsEventHandler Delegate
   [Expand]PrepareSnListDetailEventArgs Class
    PrepareSnListDetailEventHandler Delegate
   [Expand]PrepareSnListEventArgs Class
    PrepareSnListEventHandler Delegate
   [Expand]SnapBarCode Interface
   [Expand]SnapCheckBox Interface
   [Collapse]SnapDocument Interface
     SnapDocument Members
    [Expand]SnapDocument Properties
    [Expand]SnapDocument Events
    [Expand]SnapDocument Methods
   [Expand]SnapDocumentFormat Class
   [Expand]SnapDocumentPosition Class
   [Expand]SnapDocumentRange Class
   [Expand]SnapEntity Interface
   [Expand]SnapHyperlink Interface
   [Expand]SnapImage Interface
   [Expand]SnapList Interface
   [Expand]SnapListFilters Interface
   [Expand]SnapListGroupInfo Interface
   [Expand]SnapListGroupParam Structure
   [Expand]SnapListGroups Interface
   [Expand]SnapListSorting Interface
   [Expand]SnapSingleListItemEntity Interface
   [Expand]SnapSparkline Interface
   [Expand]SnapSubDocument Interface
   [Expand]SnapText Interface
   [Expand]Theme Interface
   [Expand]ThemeCollection Interface
   [Expand]Themes Class
  [Expand]DevExpress.Snap.Core.Fields
  [Expand]DevExpress.Snap.Core.Forms
  [Expand]DevExpress.Snap.Core.Options
  [Expand]DevExpress.Snap.Core.Services
  [Expand]DevExpress.Snap.Extensions
  [Expand]DevExpress.Snap.Extensions.Localization
  [Expand]DevExpress.Snap.Localization
  [Expand]DevExpress.Snap.Options
  [Expand]DevExpress.Snap.Services
  [Expand]DevExpress.Utils
  [Expand]DevExpress.Utils.Animation
  [Expand]DevExpress.Utils.Controls
  [Expand]DevExpress.Utils.Drawing
  [Expand]DevExpress.Utils.Menu
  [Expand]DevExpress.Utils.Taskbar
  [Expand]DevExpress.Utils.Taskbar.Core
  [Expand]DevExpress.Utils.UI.Localization
  [Expand]DevExpress.Utils.VisualEffects
  [Expand]DevExpress.Utils.Win
  [Expand]DevExpress.XtraBars
  [Expand]DevExpress.XtraBars.Alerter
  [Expand]DevExpress.XtraBars.Docking
  [Expand]DevExpress.XtraBars.Docking2010
  [Expand]DevExpress.XtraBars.Docking2010.Customization
  [Expand]DevExpress.XtraBars.Docking2010.Views
  [Expand]DevExpress.XtraBars.Docking2010.Views.NativeMdi
  [Expand]DevExpress.XtraBars.Docking2010.Views.Tabbed
  [Expand]DevExpress.XtraBars.Docking2010.Views.Widget
  [Expand]DevExpress.XtraBars.Docking2010.Views.WindowsUI
  [Expand]DevExpress.XtraBars.Localization
  [Expand]DevExpress.XtraBars.Navigation
  [Expand]DevExpress.XtraBars.Ribbon
  [Expand]DevExpress.XtraBars.Ribbon.Gallery
  [Expand]DevExpress.XtraBars.Ribbon.ViewInfo
  [Expand]DevExpress.XtraBars.ToastNotifications
  [Expand]DevExpress.XtraBars.Utils
  [Expand]DevExpress.XtraBars.WinRTLiveTiles
  [Expand]DevExpress.XtraCharts
  [Expand]DevExpress.XtraCharts.Designer
  [Expand]DevExpress.XtraCharts.Wizard
  [Expand]DevExpress.XtraDataLayout
  [Expand]DevExpress.XtraDiagram
  [Expand]DevExpress.XtraDiagram.Options
  [Expand]DevExpress.XtraEditors
  [Expand]DevExpress.XtraEditors.ButtonPanel
  [Expand]DevExpress.XtraEditors.Calendar
  [Expand]DevExpress.XtraEditors.Camera
  [Expand]DevExpress.XtraEditors.Container
  [Expand]DevExpress.XtraEditors.Controls
  [Expand]DevExpress.XtraEditors.CustomEditor
  [Expand]DevExpress.XtraEditors.DXErrorProvider
  [Expand]DevExpress.XtraEditors.Filtering
  [Expand]DevExpress.XtraEditors.Mask
  [Expand]DevExpress.XtraEditors.Persistent
  [Expand]DevExpress.XtraEditors.Repository
  [Expand]DevExpress.XtraEditors.ViewInfo
  [Expand]DevExpress.XtraFilterEditor
  [Expand]DevExpress.XtraGauges.Presets.Styles
  [Expand]DevExpress.XtraGauges.Win
  [Expand]DevExpress.XtraGauges.Win.Base
  [Expand]DevExpress.XtraGauges.Win.Gauges.Circular
  [Expand]DevExpress.XtraGauges.Win.Gauges.Digital
  [Expand]DevExpress.XtraGauges.Win.Gauges.Linear
  [Expand]DevExpress.XtraGauges.Win.Gauges.State
  [Expand]DevExpress.XtraGrid
  [Expand]DevExpress.XtraGrid.Columns
  [Expand]DevExpress.XtraGrid.EditForm
  [Expand]DevExpress.XtraGrid.FilterEditor
  [Expand]DevExpress.XtraGrid.Localization
  [Expand]DevExpress.XtraGrid.Views.BandedGrid
  [Expand]DevExpress.XtraGrid.Views.BandedGrid.ViewInfo
  [Expand]DevExpress.XtraGrid.Views.Base
  [Expand]DevExpress.XtraGrid.Views.Base.ViewInfo
  [Expand]DevExpress.XtraGrid.Views.Card
  [Expand]DevExpress.XtraGrid.Views.Card.ViewInfo
  [Expand]DevExpress.XtraGrid.Views.Grid
  [Expand]DevExpress.XtraGrid.Views.Grid.ViewInfo
  [Expand]DevExpress.XtraGrid.Views.Layout
  [Expand]DevExpress.XtraGrid.Views.Layout.Events
  [Expand]DevExpress.XtraGrid.Views.Layout.ViewInfo
  [Expand]DevExpress.XtraGrid.Views.Printing
  [Expand]DevExpress.XtraGrid.Views.Tile
  [Expand]DevExpress.XtraGrid.Views.WinExplorer
  [Expand]DevExpress.XtraGrid.WinExplorer
  [Expand]DevExpress.XtraLayout
  [Expand]DevExpress.XtraLayout.Customization
  [Expand]DevExpress.XtraLayout.HitInfo
  [Expand]DevExpress.XtraLayout.Localization
  [Expand]DevExpress.XtraLayout.Utils
  [Expand]DevExpress.XtraMap
  [Expand]DevExpress.XtraMap.Printing
  [Expand]DevExpress.XtraNavBar
  [Expand]DevExpress.XtraNavBar.ViewInfo
  [Expand]DevExpress.XtraPdfViewer
  [Expand]DevExpress.XtraPdfViewer.Commands
  [Expand]DevExpress.XtraPdfViewer.Localization
  [Expand]DevExpress.XtraPivotGrid
  [Expand]DevExpress.XtraPivotGrid.Data
  [Expand]DevExpress.XtraPrinting
  [Expand]DevExpress.XtraPrinting.Control
  [Expand]DevExpress.XtraPrinting.Preview
  [Expand]DevExpress.XtraPrintingLinks
  [Expand]DevExpress.XtraReports.UI
  [Expand]DevExpress.XtraRichEdit
  [Expand]DevExpress.XtraRichEdit.Commands
  [Expand]DevExpress.XtraRichEdit.Export
  [Expand]DevExpress.XtraRichEdit.Import
  [Expand]DevExpress.XtraRichEdit.Localization
  [Expand]DevExpress.XtraRichEdit.Menu
  [Expand]DevExpress.XtraScheduler
  [Expand]DevExpress.XtraScheduler.Drawing
  [Expand]DevExpress.XtraScheduler.Printing
  [Expand]DevExpress.XtraScheduler.Reporting
  [Expand]DevExpress.XtraScheduler.Reporting.UI
  [Expand]DevExpress.XtraScheduler.Services
  [Expand]DevExpress.XtraScheduler.Services.Implementation
  [Expand]DevExpress.XtraScheduler.UI
  [Expand]DevExpress.XtraSpellChecker
  [Expand]DevExpress.XtraSpellChecker.Localization
  [Expand]DevExpress.XtraSplashForm
  [Expand]DevExpress.XtraSplashScreen
  [Expand]DevExpress.XtraSpreadsheet
  [Expand]DevExpress.XtraSpreadsheet.Services
  [Expand]DevExpress.XtraTab
  [Expand]DevExpress.XtraTab.Buttons
  [Expand]DevExpress.XtraTab.ViewInfo
  [Expand]DevExpress.XtraTabbedMdi
  [Expand]DevExpress.XtraToolbox
  [Expand]DevExpress.XtraTreeList
  [Expand]DevExpress.XtraTreeList.Columns
  [Expand]DevExpress.XtraTreeList.Data
  [Expand]DevExpress.XtraTreeList.Localization
  [Expand]DevExpress.XtraTreeList.Menu
  [Expand]DevExpress.XtraTreeList.Nodes
  [Expand]DevExpress.XtraTreeList.Nodes.Operations
  [Expand]DevExpress.XtraTreeList.StyleFormatConditions
  [Expand]DevExpress.XtraTreeMap
  [Expand]DevExpress.XtraVerticalGrid
  [Expand]DevExpress.XtraVerticalGrid.Events
  [Expand]DevExpress.XtraVerticalGrid.Localization
  [Expand]DevExpress.XtraVerticalGrid.Rows
  [Expand]DevExpress.XtraWaitForm
  [Expand]DevExpress.XtraWizard
[Expand]ASP.NET Controls and MVC Extensions
[Expand]ASP.NET Bootstrap Controls
[Expand]WPF Controls
[Expand]Xamarin Controls
[Expand]Windows 10 App Controls
[Expand]Document Server
[Expand]Reporting
[Expand]Report Server
[Expand]Dashboard
[Expand]eXpressApp Framework
[Expand]CodeRush
[Expand]Cross-Platform Core Libraries
[Expand]Tools and Utilities
 End-User Documentation

SnapDocument Members

A central element of a Snap application that constitutes a report document and accounts for the creation and editing of a Snap report.

Expanded Public Properties

Show: Inherited
  Name Description
Public property AbstractNumberingLists Provides access to a collection of abstract numbering lists in the document. (Inherited from Document)
Public property ActiveEntity Specifies a Snap field for which the SnapEntity.Active property is enabled. (Inherited from ISnapFieldOwner)
Public property ActiveThemeName Returns the name of the currently applied theme.
Public property Bookmarks Provides access to the collection of document bookmarks. (Inherited from SubDocument)
Public property CalculatedFields Provides access to a SnapDocument's collection of calculated fields. (Inherited from IDataSourceOwner)
Public property CaretPosition Gets or sets the position of the caret within the document. (Inherited from Document)
Public property CharacterStyles Provides access to a collection of character styles in the current document. (Inherited from Document)
Public property Comments Provides access to a collection of comments in the current SubDocument. (Inherited from SubDocument)
Public property CompatibilitySettings Provides access to the document compatibility settings. (Inherited from Document)
Public property CustomMarks Provides access to a collection of custom marks. (Inherited from SubDocument)
Public property CustomProperties Provides access to a collection of the document's custom properties. (Inherited from Document)
Public property DataSource Specifies the datasource for the DataSourceInfo collection. (Inherited from IDataSourceOwner)
Public property DataSources Provides access to the collection of a document's datasources.
Public property DefaultCharacterProperties Provides access to default character formatting for the current document. (Inherited from Document)
Public property DefaultParagraphProperties Provides access to default paragraph formatting for the current document. (Inherited from Document)
Public property DefaultTableProperties Provides access to the default properties for document tables. (Inherited from Document)
Public property DefaultTabWidth Gets or sets the default value of a tab stop width. (Inherited from Document)
Public property DifferentOddAndEvenPages Gets or sets whether the document has different odd and even pages. (Inherited from Document)
Public property DocumentProperties Provides access to the collection of document's core properties. (Inherited from Document)
Public property Fields Provides access to the collection of fields in the current document. (Inherited from SubDocument)
Public property HtmlText Gets or sets the document content as HTML text. (Inherited from Document)
Public property Hyperlinks Provides access to a collection of hyperlinks in the document. (Inherited from SubDocument)
Public property Images Provides access to the collection of all images (inline and floating pictures) in the document . (Inherited from SubDocument)
Public property IsDocumentProtected Gets whether document protection is enabled. (Inherited from Document)
Public property IsEmpty Indicates whether the document is empty, i.e. contains only default content. (Inherited from Document)
Public property Length Gets the character length of the document. (Inherited from SubDocument)
Public property MhtText Gets or sets the document content as MHT text. (Inherited from Document)
Public property NumberingLists Provides access to a collection of definitions for numbering lists instantiated in the document. (Inherited from Document)
Public property OpenDocumentBytes Gets or sets the document content as an array of bytes in Open Office Text (.odt) format. (Inherited from Document)
Public property OpenXmlBytes Gets or sets the document content as an array of bytes in Office Open XML (Docx) format. (Inherited from Document)
Public property PageBackColor Gets the background color of the page. (Inherited from SubDocument)
Public property Paragraphs Provides access to a collection of paragraphs. (Inherited from SubDocument)
Public property ParagraphStyles Provides access to a collection of paragraph styles in the current document. (Inherited from Document)
Public property Parameters Provides access to the report's parameters collection.
Public property ProtectionType Gets the protection type for the document. (Inherited from Document)
Public property Range Gets the range for the current document. (Inherited from SubDocument)
Public property RequiredExportCapabilities Obtains information on the formatting capabilities required to export the current document correctly. (Inherited from Document)
Public property RtfText Gets or sets the formatted text content of the document. (Inherited from Document)
Public property Sections Overloaded. Provides access to a Snap document's collection of sections.
Public property Selection Gets or sets the selected range in the document. (Inherited from Document)
Public property Selections Provides access to a collection of selections in the document. (Inherited from Document)
Public property Shapes Provides access to a collection of Shapes (pictures, text boxes) in the current SubDocument. (Inherited from SubDocument)
Public property ShowPageBackground Gets whether the page background color is shown. (Inherited from SubDocument)
Public property TableCellStyles Provides access to the collection of styles defined for cells in the table.
Public property Tables Provides access to a collection of tables contained in the current document. (Inherited from SubDocument)
Public property TableStyles Provides access to a collection of styles defined for tables in the document. (Inherited from Document)
Public property Text Gets or sets the document's text (plain text). (Inherited from Document)
Public property Themes Provides access to the collection of available themes.
Public property Unit Gets or sets a unit of measure used within the document. (Inherited from Document)
Public property UpdateDocVariablesBeforePrint Gets or sets whether DOCVARIABLE fields are automatically updated before a document is printed. (Inherited from Document)
Public property Variables Provides access to the collection of document variables. (Inherited from Document)
Public property WordMLText Gets or sets the document content as the text in WordProcessingML (Microsoft Office Word 2003 XML) format. (Inherited from Document)
Top

Expanded Public Methods

Show: Inherited
  Name Description
Public method AddParagraphsToList Obsolete. Apply the numbering list format specified by the DevExpress.XtraRichEdit.API.Native.NumberingList object to the paragraphs in the specified range. (Inherited from SubDocument)
Public method AddParagraphToList Overloaded. Apply the numbering list format specified by the DevExpress.XtraRichEdit.API.Native.NumberingList object to the specified paragraph. (Inherited from SubDocument)
Public method AppendDocumentContent Overloaded. Appends content from the stream to the end of the current document. (Inherited from SubDocument)
Public method AppendHtmlText Overloaded. Appends HTML formatted text to the end of the document. (Inherited from SubDocument)
Public method AppendImage Overloaded. Appends a specified image to the end of the document. (Inherited from SubDocument)
Public method AppendParagraph Obsolete. Appends an empty paragraph to the end of the document. (Inherited from SubDocument)
Public method AppendRtfText Overloaded. Appends formatted text to the end of the document. (Inherited from SubDocument)
Public method AppendSection Overloaded. Appends a new empty section to the end of the Snap document.
Public method AppendSingleLineText Appends a single line of text to the end of the current document. (Inherited from SubDocument)
Public method AppendText Appends the specified text to the end of the document. (Inherited from SubDocument)
Public method ApplySyntaxHighlight Performs a batch update of text formatting for document ranges corresponding to specified tokens. (Inherited from SubDocument)
Public method ApplyTheme Applies the specified theme to the current document.
Public method BeginUpdate Locks the SubDocument object by preventing visual updates until the EndUpdate method is called. (Inherited from SubDocument)
Public method BeginUpdateCharacters Overloaded. Starts modifying properties of characters that fall within a specified document range. (Inherited from SubDocument)
Public method BeginUpdateDataSource Updates the DataSourceInfo collection.
Public method BeginUpdateParagraphs Starts modifying properties of the paragraphs that fall within a specified document range. (Inherited from SubDocument)
Public method BeginUpdateRangePermissions Gets the collection of all range permissions in the current document. (Inherited from SubDocument)
Public method CancelUpdateRangePermissions Finalizes the update process, leaving range permissions intact. (Inherited from SubDocument)
Public method ChangeActiveDocument Enables you to operate on selections in documents other than the main document, such as headers and footers. (Inherited from Document)
Public method Copy Overloaded. Copies the specified range of text to the Clipboard. (Inherited from Document)
Public method CreateBookmark Overloaded. Creates a bookmark with the specified name for the range that starts at the specified position and has a specified length. Then, adds it to the DevExpress.XtraRichEdit.API.Native.SubDocument.Bookmarks collection. (Inherited from SubDocument)
Public method CreateCustomMark Obsolete. Creates a custom mark at the specified position and associates specified data with it. (Inherited from SubDocument)
Public method CreateHyperlink Overloaded. Creates a hyperlink for the document range, starting at the specified position, and extending through a specified length. (Inherited from SubDocument)
Public method CreateMailMergeOptions Obsolete. Obsolete. Use the CreateSnapMailMergeExportOptions method instead.
Public method CreatePosition Creates a new position in the current document. (Inherited from SubDocument)
Public method CreateRange Overloaded. Creates a new document range using the specified start position and range length. (Inherited from SubDocument)
Public method CreateSnapMailMergeExportOptions Creates the options that determine how a document is rendered when finishing a mail-merge report.
Public method CreateSnBarCode Adds a Bar Code to the specified position in a document. (Inherited from ISnapFieldOwner)
Public method CreateSnCheckBox Adds a Check Box to the specified position in a document. (Inherited from ISnapFieldOwner)
Public method CreateSnHyperlink Adds a Hyperlink to the specified position in a document. (Inherited from ISnapFieldOwner)
Public method CreateSnImage Adds a Picture to the specified position in a document. (Inherited from ISnapFieldOwner)
Public method CreateSnList Adds a Snap list to the specified position in a document. (Inherited from ISnapFieldOwner)
Public method CreateSnRowIndex Adds a Row Index to the specified position in an document. (Inherited from ISnapFieldOwner)
Public method CreateSnSparkline Adds a Sparkline to the specified position in a document. (Inherited from ISnapFieldOwner)
Public method CreateSnText Adds a text box to the specified position in a document. (Inherited from ISnapFieldOwner)
Public method Cut Overloaded. Removes the currently selected text and copies it to the Clipboard. (Inherited from Document)
Public method Delete Removes the specified range of text from the document. (Inherited from SubDocument)
Public method DeleteCustomMark Obsolete. Delete specified custom mark from the document's collection. (Inherited from SubDocument)
Public method EndUpdate Unlocks the SubDocument object after a call to the BeginUpdate method and causes an immediate visual update. (Inherited from SubDocument)
Public method EndUpdateCharacters Finalizes the modification of character formatting after calling the DevExpress.XtraRichEdit.API.Native.SubDocument.BeginUpdateCharacters method. (Inherited from SubDocument)
Public method EndUpdateDataSource Ends the initialization of the DataSourceInfo collection.
Public method EndUpdateParagraphs Finalizes the modification of paragraph formatting after calling the DevExpress.XtraRichEdit.API.Native.SubDocument.BeginUpdateParagraphs method. (Inherited from SubDocument)
Public method EndUpdateRangePermissions Finalizes the update and applies the changes to range permissions. (Inherited from SubDocument)
Public method ExportDocument Overloaded. Exports the document to a stream in the specified format.
Public method FindAll Overloaded. Finds all text ranges that match the specified string in the specified document range. (Inherited from SubDocument)
Public method FindListByName Searches for a Snap list by its name. (Inherited from ISnapFieldOwner)
Public method GetAuthors Returns the list of the document's authors. (Inherited from Document)
Public method GetCustomMarkByVisualInfo Obsolete. Provides access to a custom mark in the RichEditControl.CustomMarkDraw event handler. (Inherited from SubDocument)
Public method GetDataSourceOwner Returns an object that contains information about the specified data source.
Public method GetHtmlText Overloaded. Gets the text contained in the specified range in HTML format. (Inherited from SubDocument)
Public method GetImages Obsolete. Gets all images (inline pictures and shapes) in the specified document range. Use a method accessible with the RichEditControl.Document.Images.Get(DocumentRange range) notation instead. (Inherited from SubDocument)
Public method GetMhtText Overloaded. Gets the content of the specified document range in MHT format. (Inherited from SubDocument)
Public method GetOpenXmlBytes Overloaded. Gets the content of the specified document range in Office Open XML (Docx) format. (Inherited from SubDocument)
Public method GetParagraph Obsolete. Gets the paragraph encompassing the specified position. (Inherited from SubDocument)
Public method GetParagraphs Obsolete. Provides access to paragraphs to which the specified range belongs. (Inherited from SubDocument)
Public method GetRtfText Overloaded. Gets the formatted string of the text contained in the specified range. (Inherited from SubDocument)
Public method GetSection Overloaded. Gets the section encompassing the specified position.
Public method GetShapes Obsolete. Gets a collection of Shape objects contained in the specified document range. Use a method accessible with the RichEditControl.Document.Shapes.Get(DocumentRange range) notation instead. (Inherited from SubDocument)
Public method GetSubDocumentType Returns the subdocument type. (Inherited from SubDocument)
Public method GetTableCell Obsolete. Gets a table cell in which the specified position is located. (Inherited from SubDocument)
Public method GetText Overloaded. Returns the plain text of the specified document range. (Inherited from SubDocument)
Public method GetWordMLText Overloaded. Gets the text contained in the specified range in WordML format. (Inherited from SubDocument)
Public method InsertDocumentContent Overloaded. Inserts content from the specified range to the current document at the specified position. (Inherited from SubDocument)
Public method InsertHtmlText Overloaded. Inserts the specified HTML text into the specified position. (Inherited from SubDocument)
Public method InsertImage Overloaded. Inserts an image into the specified position in the document. (Inherited from SubDocument)
Public method InsertParagraph Overloaded. Inserts a new paragraph into the document's DevExpress.XtraRichEdit.API.Native.SubDocument.Paragraphs collection at a specified position. (Inherited from SubDocument)
Public method InsertPicture Overloaded. Inserts a picture as a floating object. (Inherited from SubDocument)
Public method InsertRtfText Overloaded. Inserts the specified formatted text into the specified position. (Inherited from SubDocument)
Public method InsertSection Overloaded. Inserts a new section into the document's DevExpress.XtraRichEdit.API.Native.Document.Sections collection at a specified position.
Public method InsertSingleLineText Inserts a single line of text (text without line breaks) at the specified position. (Inherited from SubDocument)
Public method InsertTable Overloaded. Inserts a blank table with the specified number of rows and columns at the specified position. (Inherited from SubDocument)
Public method InsertText Inserts the specified text into the specified position. (Inherited from SubDocument)
Public method InsertTextBox Obsolete. Inserts a floating text box. (Inherited from SubDocument)
Public method LoadDocument Overloaded. Loads a document from the specified file in the specified format. External content is retrieved using the specified source (base) URI. (Inherited from Document)
Public method LoadTheme Overloaded. Loads the specified theme from a stream.
Public method MailMerge Overloaded. Obsolete. Use the SnapMailMerge method instead.
Public method MakeAllTablesWordCompatible Merges all columns with indexes greater than 63 into a single column for all tables in a document. (Inherited from Document)
Public method ParseField Overloaded. Converts the fields of a RichEditControl to Snap fields. (Inherited from ISnapFieldOwner)
Public method Paste Overloaded. Insert a text from the Clipboard into the current DevExpress.XtraRichEdit.API.Native.Document.CaretPosition. (Inherited from Document)
Public method Protect Overloaded. Enforces document protection and sets the specified password. (Inherited from Document)
Public method RemoveBookmark Obsolete. Removes the specified bookmark from the bookmark collection of the document. (Inherited from SubDocument)
Public method RemoveField Removes a Snap field at the specified position. (Inherited from ISnapFieldOwner)
Public method RemoveHyperlink Obsolete. Converts a hyperlink to plain text. (Inherited from SubDocument)
Public method RemoveNumberingFromParagraph Obsolete. Removes the numbering or bullet from the specified paragraph. (Inherited from SubDocument)
Public method RemoveNumberingFromParagraphs Obsolete. Remove the numbering or bullet from all paragraphs intersecting the specified range. (Inherited from SubDocument)
Public method RemoveSnList Removes the specified Snap list from a document. (Inherited from ISnapFieldOwner)
Public method Replace Replaces the specified document range with the specified text string. (Inherited from SubDocument)
Public method ReplaceAll Overloaded. Replaces all occurrences of a character pattern defined by a regular expression with a specified replacement string. (Inherited from SubDocument)
Public method SaveCurrentTheme Overloaded. Saves the current theme to a specified stream.
Public method SaveDocument Overloaded. Saves the document to a stream.
Public method SelectAll Selects all the content in the document. (Inherited from SubDocument)
Public method SelectBookmark Obsolete. Selects a range associated with the specified bookmark. (Inherited from SubDocument)
Public method SetPageBackground Overloaded. Sets the background color of the page and specifies whether it is shown. (Inherited from SubDocument)
Public method SnapMailMerge Overloaded. Starts rendering a mail-merge document and saving it to a stream in the specified format.
Public method StartSearch Overloaded. Provides a search interface for a search in the current document in the specified direction, using the specified options. (Inherited from SubDocument)
Public method Unprotect Removes document protection. (Inherited from Document)
Public method UpdateTemplate Forces the update of the template area.
Top

Expanded Public Events

Show: Inherited
  Name Description
Public event AfterInsertSnList Occurs after the list has been inserted into a document.
Public event AfterInsertSnListColumns Occurs after inserting columns into the target list.
Public event AfterInsertSnListDetail Occurs after the detail section has been added to the list.
Public event AfterInsertSnListRecordData Fires after adding new fields to a document.
Public event BeforeInsertSnList Occurs before a new list is created.
Public event BeforeInsertSnListColumns Occurs before a new set of columns is created.
Public event BeforeInsertSnListDetail Occurs before a new detail list is created.
Public event BeforeInsertSnListRecordData Fires when adding fields to a list without using hot zones (this is only possible if the target list has been previously converted to paragraphs).
Public event CalculateDocumentVariable Fires when the DOCVARIABLE field is updated. (Inherited from Document)
Public event ConfigureDataConnection Allows you to customize connection settings before the SnapDocument connects to a database.
Public event ConnectionError Fires after an attempt to establish a data connection has failed.
Public event ContentChanged Occurs when the document content was changed. (Inherited from Document)
Public event CustomFilterExpression Allows you to include WHERE clauses in SQL queries.
Public event DataSourceChanged Occurs when the data source has been changed.
Public event ModifiedChanged Occurs when the document content has been modified since it was last saved. (Inherited from Document)
Public event PrepareSnList Occurs after generating a list template.
Public event PrepareSnListColumns Occurs for every added column after its body and header templates are created.
Public event PrepareSnListDetail Occurs after generating a detail list template.
Top

Expanded See Also

How would you rate this topic?​​​​​​​