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]SnapChart Interface
   [Expand]SnapCheckBox Interface
   [Expand]SnapDocument Interface
   [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
   [Collapse]SnapSubDocument Interface
     SnapSubDocument Members
    [Expand]SnapSubDocument Properties
    [Expand]SnapSubDocument Methods
   [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.Extensions.UI
  [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]ASP.NET Core 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]CodeRush Classic
[Expand]Cross-Platform Core Libraries
[Expand]Tools and Utilities
 End-User Documentation

SnapSubDocument Members

Provides the essential Snap document functionality.

Expanded Public Properties

Show: Inherited
  Name Description
Public property ActiveEntity Specifies a Snap field for which the SnapEntity.Active property is enabled. (Inherited from ISnapFieldOwner)
Public property Bookmarks Provides access to the collection of document bookmarks. (Inherited from SubDocument)
Public property Comments Provides access to a collection of comments in the current SubDocument. (Inherited from SubDocument)
Public property CustomMarks Provides access to a collection of custom marks. (Inherited from SubDocument)
Public property Fields Provides access to the collection of fields in the current document. (Inherited from SubDocument)
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 Length Gets the character length of the document. (Inherited from SubDocument)
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 Range Gets the range for the current Snap 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 Tables Provides access to a collection of tables contained in the current document. (Inherited from SubDocument)
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 specified range 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 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 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 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 CreateBookmark Overloaded. Creates a bookmark for the specified range with the specified name and 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 CreatePosition Overloaded. Creates a new position in the current document.
Public method CreateRange Overloaded. Creates a new document range using the specified start position and range length.
Public method CreateSnBarCode Adds a Bar Code to the specified position in a document. (Inherited from ISnapFieldOwner)
Public method CreateSnChart Inserts a Chart into 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 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 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 FindAll Overloaded. Finds all occurrences of a character pattern specified by the regular expression. (Inherited from SubDocument)
Public method FindListByName Searches for a Snap list by its name. (Inherited from ISnapFieldOwner)
Public method GetCustomMarkByVisualInfo Obsolete. Provides access to a custom mark in the RichEditControl.CustomMarkDraw event handler. (Inherited from SubDocument)
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 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 file 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 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 at the specified position. (Inherited from SubDocument)
Public method InsertTextBox Obsolete. Inserts a floating text box. (Inherited from SubDocument)
Public method ParseField Overloaded. Converts the fields of a RichEditControl to Snap fields. (Inherited from ISnapFieldOwner)
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 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. Set the background color of the page. (Inherited from SubDocument)
Public method StartSearch Overloaded. Provides a search interface with default parameters. (Inherited from SubDocument)
Top

Expanded See Also

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