Log In
Home
Support
Demos
Documentation
Blogs
Training
Webinars
[Expand]General Information
[Expand]WinForms Controls
[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
[Collapse]Cross-Platform Core Libraries
 [Expand]DevExpress ORM Tool
 [Expand]DevExpress Data Library
 [Expand]Miscellaneous
 [Collapse]API Reference
  [Expand]DevExpress.Data
  [Expand]DevExpress.Data.Browsing
  [Expand]DevExpress.Data.Browsing.Design
  [Expand]DevExpress.Data.Camera
  [Expand]DevExpress.Data.Controls
  [Expand]DevExpress.Data.Controls.ExpressionEditor
  [Expand]DevExpress.Data.Entity
  [Expand]DevExpress.Data.Filtering
  [Expand]DevExpress.Data.Filtering.Exceptions
  [Expand]DevExpress.Data.Filtering.Helpers
  [Expand]DevExpress.Data.Linq
  [Expand]DevExpress.Data.ODataLinq
  [Expand]DevExpress.Data.PivotGrid
  [Expand]DevExpress.Data.PLinq
  [Expand]DevExpress.Data.TreeList
  [Expand]DevExpress.Data.Utils
  [Expand]DevExpress.Data.Utils.ServiceModel
  [Expand]DevExpress.Data.WcfLinq
  [Expand]DevExpress.Data.WizardFramework
  [Expand]DevExpress.Data.XtraReports.DataProviders
  [Expand]DevExpress.Data.XtraReports.Labels
  [Expand]DevExpress.Data.XtraReports.ServiceModel
  [Expand]DevExpress.Data.XtraReports.ServiceModel.DataContracts
  [Expand]DevExpress.Data.XtraReports.Wizard
  [Expand]DevExpress.Data.XtraReports.Wizard.Presenters
  [Expand]DevExpress.Data.XtraReports.Wizard.Views
  [Expand]DevExpress.DataAccess
  [Expand]DevExpress.DataAccess.ConnectionParameters
  [Expand]DevExpress.DataAccess.EntityFramework
  [Expand]DevExpress.DataAccess.Excel
  [Expand]DevExpress.DataAccess.ExpressionEditor
  [Expand]DevExpress.DataAccess.Localization
  [Expand]DevExpress.DataAccess.ObjectBinding
  [Expand]DevExpress.DataAccess.Sql
  [Expand]DevExpress.DataAccess.Sql.DataApi
  [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.DataAccess.Web
  [Expand]DevExpress.DataAccess.Wizard
  [Expand]DevExpress.DataAccess.Wizard.Model
  [Expand]DevExpress.DataAccess.Wizard.Presenters
  [Expand]DevExpress.DataAccess.Wizard.Services
  [Expand]DevExpress.DataAccess.Wizard.Views
  [Expand]DevExpress.Diagram.Core
  [Expand]DevExpress.Diagram.Core.Layout
  [Expand]DevExpress.Diagram.Core.Localization
  [Expand]DevExpress.Diagram.Core.Shapes
  [Expand]DevExpress.Diagram.Core.Themes
  [Expand]DevExpress.DocumentServices.ServiceModel
  [Expand]DevExpress.DocumentServices.ServiceModel.Client
  [Expand]DevExpress.DocumentServices.ServiceModel.DataContracts
  [Expand]DevExpress.DocumentView
  [Expand]DevExpress.Entity.Model
  [Expand]DevExpress.Entity.ProjectModel
  [Expand]DevExpress.Export
  [Expand]DevExpress.Export.Xl
  [Expand]DevExpress.Map
  [Expand]DevExpress.Mvvm
  [Expand]DevExpress.Mvvm.DataAnnotations
  [Expand]DevExpress.Mvvm.DataModel
  [Expand]DevExpress.Mvvm.ModuleInjection
  [Expand]DevExpress.Mvvm.UI
  [Expand]DevExpress.Mvvm.Utils
  [Expand]DevExpress.Mvvm.ViewModel
  [Expand]DevExpress.Office
  [Expand]DevExpress.Office.Crypto
  [Expand]DevExpress.Office.Drawing
  [Expand]DevExpress.Office.Export
  [Expand]DevExpress.Office.Export.Html
  [Expand]DevExpress.Office.Import
  [Expand]DevExpress.Office.Localization
  [Expand]DevExpress.Office.Options
  [Expand]DevExpress.Office.Services
  [Expand]DevExpress.Office.Utils
  [Expand]DevExpress.Pdf
  [Expand]DevExpress.Pdf.Localization
  [Expand]DevExpress.PivotGrid.Printing
  [Expand]DevExpress.Printing
  [Expand]DevExpress.Printing.Core
  [Expand]DevExpress.ReportServer.Printing
  [Expand]DevExpress.ReportServer.Printing.Services
  [Expand]DevExpress.ReportServer.ServiceModel.Client
  [Expand]DevExpress.ReportServer.ServiceModel.ConnectionProviders
  [Expand]DevExpress.ReportServer.ServiceModel.DataContracts
  [Expand]DevExpress.Schedule
  [Expand]DevExpress.Services
  [Expand]DevExpress.Sparkline
  [Expand]DevExpress.Spreadsheet
  [Expand]DevExpress.Spreadsheet.Charts
  [Expand]DevExpress.Spreadsheet.Drawings
  [Expand]DevExpress.Spreadsheet.Export
  [Expand]DevExpress.Spreadsheet.Formulas
  [Expand]DevExpress.Spreadsheet.Functions
  [Expand]DevExpress.TreeMap
  [Expand]DevExpress.Utils
  [Expand]DevExpress.Utils.Commands
  [Expand]DevExpress.Utils.Controls
  [Expand]DevExpress.Utils.Filtering.Internal
  [Expand]DevExpress.Utils.IoC
  [Expand]DevExpress.Utils.Localization
  [Expand]DevExpress.Utils.Serializing.Helpers
  [Expand]DevExpress.WebUtils
  [Expand]DevExpress.Xpf.Core
  [Expand]DevExpress.Xpf.Printing
  [Expand]DevExpress.Xpo
  [Expand]DevExpress.Xpo.DB
  [Expand]DevExpress.Xpo.DB.Exceptions
  [Expand]DevExpress.Xpo.DB.Helpers
  [Expand]DevExpress.Xpo.Exceptions
  [Expand]DevExpress.Xpo.Helpers
  [Expand]DevExpress.Xpo.Metadata
  [Expand]DevExpress.XtraCharts
  [Expand]DevExpress.XtraCharts.Localization
  [Expand]DevExpress.XtraCharts.Printing
  [Expand]DevExpress.XtraEditors
  [Expand]DevExpress.XtraEditors.DXErrorProvider
  [Expand]DevExpress.XtraExport.Csv
  [Expand]DevExpress.XtraGauges.Base
  [Expand]DevExpress.XtraGauges.Core
  [Expand]DevExpress.XtraGauges.Core.Base
  [Expand]DevExpress.XtraGauges.Core.Drawing
  [Expand]DevExpress.XtraGauges.Core.Localization
  [Expand]DevExpress.XtraGauges.Core.Model
  [Expand]DevExpress.XtraGauges.Core.Primitive
  [Expand]DevExpress.XtraGrid
  [Expand]DevExpress.XtraPivotGrid
  [Expand]DevExpress.XtraPivotGrid.Customization
  [Expand]DevExpress.XtraPivotGrid.Data
  [Expand]DevExpress.XtraPivotGrid.Localization
  [Expand]DevExpress.XtraPivotGrid.Selection
  [Expand]DevExpress.XtraPrinting
  [Expand]DevExpress.XtraPrinting.BarCode
  [Expand]DevExpress.XtraPrinting.DataNodes
  [Expand]DevExpress.XtraPrinting.Drawing
  [Expand]DevExpress.XtraPrinting.Export
  [Expand]DevExpress.XtraPrinting.Export.Web
  [Expand]DevExpress.XtraPrinting.Localization
  [Expand]DevExpress.XtraPrinting.Native
  [Expand]DevExpress.XtraPrinting.Shape
  [Expand]DevExpress.XtraPrinting.Shape.Native
  [Expand]DevExpress.XtraPrinting.WebClientUIControl.DataContracts
  [Expand]DevExpress.XtraPrinting.XamlExport
  [Expand]DevExpress.XtraPrintingLinks
  [Expand]DevExpress.XtraReports
  [Expand]DevExpress.XtraReports.Design
  [Expand]DevExpress.XtraReports.Parameters
  [Expand]DevExpress.XtraReports.ReportGeneration
  [Expand]DevExpress.XtraReports.UI
  [Expand]DevExpress.XtraRichEdit
  [Expand]DevExpress.XtraRichEdit.API.Layout
  [Collapse]DevExpress.XtraRichEdit.API.Native
   [Expand]AbstractNumberingList Interface
   [Expand]AbstractNumberingListCollection Interface
    AutoFitBehaviorType Enumeration
   [Expand]Bookmark Interface
   [Expand]BookmarkCollection Interface
   [Expand]Capture Interface
   [Expand]CaptureCollection Interface
   [Expand]CharacterProperties Interface
   [Expand]CharacterPropertiesBase Interface
    CharacterPropertiesMask Enumeration
   [Expand]CharacterStyle Interface
   [Expand]CharacterStyleCollection Interface
   [Expand]Comment Interface
   [Expand]CommentCollection Interface
    CompatibilityMode Enumeration
   [Expand]CompatibilitySettings Interface
    ConditionalTableStyleFormattingTypes Enumeration
   [Expand]CustomMark Interface
   [Expand]CustomMarkCollection Interface
   [Expand]Document Interface
   [Expand]DocumentBookmark Class
   [Expand]DocumentBookmarkEnd Class
   [Expand]DocumentBookmarkStart Class
   [Expand]DocumentCommentElement Class
   [Expand]DocumentCommentEnd Class
   [Expand]DocumentCommentStart Class
   [Expand]DocumentCustomProperties Interface
   [Expand]DocumentElementBase Class
    DocumentElementType Enumeration
   [Expand]DocumentFieldCodeEnd Class
   [Expand]DocumentFieldCodeStart Class
   [Expand]DocumentFieldResultEnd Class
   [Expand]DocumentHyperlink Class
   [Expand]DocumentHyperlinkEnd Class
   [Expand]DocumentHyperlinkStart Class
   [Expand]DocumentImage Interface
   [Expand]DocumentImageCollection Interface
   [Expand]DocumentImageSource Class
   [Expand]DocumentInlinePicture Class
   [Expand]DocumentIterator Class
   [Expand]DocumentParagraphEnd Class
   [Expand]DocumentParagraphStart Class
   [Expand]DocumentPicture Class
   [Expand]DocumentPosition Class
   [Expand]DocumentProperties Interface
    DocumentProtectionType Enumeration
   [Expand]DocumentRange Interface
   [Expand]DocumentRangePermissionEnd Class
   [Expand]DocumentRangePermissionStart Class
   [Expand]DocumentSectionEnd Class
   [Expand]DocumentSectionStart Class
   [Expand]DocumentTableCellBorder Class
   [Expand]DocumentText Class
   [Expand]DocumentTextBox Class
   [Expand]Field Interface
   [Expand]FieldCollection Interface
   [Expand]FixedRange Class
   [Expand]Group Interface
   [Expand]GroupCollection Interface
    HeaderFooterType Enumeration
    HeightType Enumeration
   [Expand]Hyperlink Interface
   [Expand]HyperlinkCollection Interface
   [Expand]IDocumentElement Interface
   [Expand]IDocumentVisitor Interface
    InsertOptions Enumeration
   [Expand]IRegexSearchResult Interface
   [Expand]ISearchResult Interface
    LineNumberingRestart Enumeration
   [Expand]ListLevel Interface
   [Expand]ListLevelProperties Interface
    MailMergeNumberingRestart Enumeration
   [Expand]MailMergeOptions Interface
   [Expand]Match Interface
   [Expand]MergeFieldName Class
    MergeMode Enumeration
    NumberingFormat Enumeration
   [Expand]NumberingList Interface
   [Expand]NumberingListBase Interface
   [Expand]NumberingListCollection Interface
    NumberingType Enumeration
   [Expand]Paragraph Class
    ParagraphAlignment Enumeration
   [Expand]ParagraphCollection Interface
    ParagraphFirstLineIndent Enumeration
    ParagraphLineSpacing Enumeration
   [Expand]ParagraphProperties Interface
   [Expand]ParagraphPropertiesBase Interface
    ParagraphPropertiesMask Enumeration
   [Expand]ParagraphPropertiesWithTabs Interface
   [Expand]ParagraphStyle Interface
   [Expand]ParagraphStyleCollection Interface
   [Expand]RangePermission Class
   [Expand]RangePermissionCollection Class
   [Expand]ReadOnlyBookmarkCollection Interface
   [Expand]ReadOnlyCommentCollection Interface
   [Expand]ReadOnlyCustomMarkCollection Interface
   [Expand]ReadOnlyDocumentImageCollection Interface
   [Expand]ReadOnlyFieldCollection Interface
   [Expand]ReadOnlyHyperlinkCollection Interface
   [Expand]ReadOnlyParagraphCollection Interface
   [Expand]ReadOnlyParagraphProperties Interface
   [Expand]ReadOnlyParagraphPropertiesBase Interface
   [Expand]ReadOnlyParagraphStyle Interface
   [Expand]ReadOnlySectionLineNumbering Interface
   [Expand]ReadOnlySectionMargins Interface
   [Expand]ReadOnlySectionPage Interface
   [Expand]ReadOnlySectionPageNumbering Interface
   [Expand]ReadOnlySectionsProperties Interface
   [Expand]ReadOnlyShapeCollection Interface
   [Expand]ReadOnlyTableCellBorderProperties Class
   [Expand]ReadOnlyTableCollection Interface
   [Expand]ReadOnlyTextProperties Interface
   [Expand]ReadOnlyTextPropertiesBase Interface
    SearchDirection Enumeration
    SearchOptions Enumeration
   [Expand]Section Interface
   [Expand]SectionCollection Interface
   [Expand]SectionColumn Class
   [Expand]SectionColumnCollection Class
   [Expand]SectionColumns Interface
   [Expand]SectionLineNumbering Interface
   [Expand]SectionMargins Interface
   [Expand]SectionPage Interface
   [Expand]SectionPageNumbering Interface
    SectionStartType Enumeration
   [Expand]SelectionCollection Class
   [Expand]Shape Interface
   [Expand]ShapeCollection Interface
   [Expand]ShapeFill Interface
    ShapeHorizontalAlignment Enumeration
   [Expand]ShapeLine Interface
    ShapeRelativeHorizontalPosition Enumeration
    ShapeRelativeVerticalPosition Enumeration
    ShapeVerticalAlignment Enumeration
    StrikeoutType Enumeration
   [Collapse]SubDocument Interface
     SubDocument Members
    [Expand]SubDocument Properties
    [Collapse]SubDocument Methods
      AddParagraphsToList Method
     [Expand]AddParagraphToList Method
     [Expand]AppendDocumentContent Method
     [Expand]AppendHtmlText Method
     [Expand]AppendImage Method
      AppendParagraph Method
     [Expand]AppendRtfText Method
      AppendSingleLineText Method
      AppendText Method
      ApplySyntaxHighlight Method
      BeginUpdate Method
     [Expand]BeginUpdateCharacters Method
      BeginUpdateParagraphs Method
      BeginUpdateRangePermissions Method
      CancelUpdateRangePermissions Method
     [Expand]CreateBookmark Method
      CreateCustomMark Method
     [Expand]CreateHyperlink Method
      CreatePosition Method
     [Expand]CreateRange Method
      Delete Method
      DeleteCustomMark Method
      EndUpdate Method
      EndUpdateCharacters Method
      EndUpdateParagraphs Method
      EndUpdateRangePermissions Method
     [Expand]FindAll Method
      GetCustomMarkByVisualInfo Method
     [Expand]GetHtmlText Method
      GetImages Method
     [Expand]GetMhtText Method
     [Expand]GetOpenXmlBytes Method
      GetParagraph Method
      GetParagraphs Method
     [Expand]GetRtfText Method
      GetShapes Method
      GetSubDocumentType Method
      GetTableCell Method
     [Expand]GetText Method
     [Expand]GetWordMLText Method
     [Expand]InsertDocumentContent Method
     [Expand]InsertHtmlText Method
     [Expand]InsertImage Method
     [Expand]InsertParagraph Method
     [Expand]InsertPicture Method
     [Expand]InsertRtfText Method
      InsertSingleLineText Method
     [Expand]InsertTable Method
      InsertText Method
      InsertTextBox Method
      RemoveBookmark Method
      RemoveHyperlink Method
      RemoveNumberingFromParagraph Method
      RemoveNumberingFromParagraphs Method
      Replace Method
     [Expand]ReplaceAll Method
      SelectAll Method
      SelectBookmark Method
     [Expand]SetPageBackground Method
     [Expand]StartSearch Method
    SubDocumentType Enumeration
   [Expand]SyntaxHighlightProperties Class
   [Expand]SyntaxHighlightToken Class
    TabAlignmentType Enumeration
   [Expand]TabInfo Class
   [Expand]TabInfoCollection Class
   [Expand]Table Interface
    TabLeaderType Enumeration
   [Expand]TableBorder Interface
    TableBorderLineStyle Enumeration
   [Expand]TableBorders Interface
   [Expand]TableCell Interface
   [Expand]TableCellBorder Interface
   [Expand]TableCellBorders Interface
   [Expand]TableCellCollection Interface
    TableCellProcessorDelegate Delegate
   [Expand]TableCellPropertiesBase Interface
    TableCellPropertiesMask Enumeration
   [Expand]TableCellStyle Interface
   [Expand]TableCellStyleCollection Interface
    TableCellVerticalAlignment Enumeration
   [Expand]TableCollection Interface
   [Expand]TableConditionalStyle Interface
   [Expand]TableConditionalStyleProperties Interface
    TableLayoutType Enumeration
    TableLookTypes Enumeration
   [Expand]TablePropertiesBase Interface
    TablePropertiesMask Enumeration
   [Expand]TableRow Interface
    TableRowAlignment Enumeration
   [Expand]TableRowCollection Interface
    TableRowProcessorDelegate Delegate
   [Expand]TableStyle Interface
   [Expand]TableStyleCollection Interface
   [Expand]TemplateAbstractNumberingList Interface
   [Expand]TextBox Interface
    TextBoxSizeRule Enumeration
    TextWrappingType Enumeration
    UnderlineType Enumeration
    VerticalMergingState Enumeration
    WidthType Enumeration
  [Expand]DevExpress.XtraRichEdit.API.Native.Implementation
  [Expand]DevExpress.XtraRichEdit.Commands
  [Expand]DevExpress.XtraRichEdit.Export
  [Expand]DevExpress.XtraRichEdit.Export.Html
  [Expand]DevExpress.XtraRichEdit.Export.Rtf
  [Expand]DevExpress.XtraRichEdit.Forms
  [Expand]DevExpress.XtraRichEdit.Import
  [Expand]DevExpress.XtraRichEdit.Localization
  [Expand]DevExpress.XtraRichEdit.Services
  [Expand]DevExpress.XtraRichEdit.Utils
  [Expand]DevExpress.XtraScheduler
  [Expand]DevExpress.XtraScheduler.Compatibility
  [Expand]DevExpress.XtraScheduler.Drawing
  [Expand]DevExpress.XtraScheduler.Exchange
  [Expand]DevExpress.XtraScheduler.iCalendar
  [Expand]DevExpress.XtraScheduler.iCalendar.Components
  [Expand]DevExpress.XtraScheduler.Localization
  [Expand]DevExpress.XtraScheduler.Native
  [Expand]DevExpress.XtraScheduler.Outlook
  [Expand]DevExpress.XtraScheduler.Outlook.Interop
  [Expand]DevExpress.XtraScheduler.Reporting
  [Expand]DevExpress.XtraScheduler.Services
  [Expand]DevExpress.XtraScheduler.Services.Implementation
  [Expand]DevExpress.XtraScheduler.Tools
  [Expand]DevExpress.XtraScheduler.UI
  [Expand]DevExpress.XtraScheduler.Xml
  [Expand]DevExpress.XtraSpellChecker
  [Expand]DevExpress.XtraSpreadsheet
  [Expand]DevExpress.XtraSpreadsheet.Export
  [Expand]DevExpress.XtraSpreadsheet.Export.Html
  [Expand]DevExpress.XtraSpreadsheet.Import
  [Expand]DevExpress.XtraSpreadsheet.Localization
  [Expand]DevExpress.XtraSpreadsheet.Services
[Expand]Tools and Utilities
 End-User Documentation

SubDocument.BeginUpdate Method

Locks the SubDocument object by preventing visual updates until the EndUpdate method is called.

Namespace:DevExpress.XtraRichEdit.API.Native
Assembly:DevExpress.RichEdit.v17.2.Core.dll

Expanded Syntax

Expanded Remarks

The BeginUpdate and EndUpdate methods allow you to avoid flickering while performing batch modifications to the SubDocument's settings. Once the BeginUpdate method has been called, modifying the SubDocument's settings does not result in immediate repainting. So, multiple modifications can be made to the object without a major impact on performance or screen flickering. After all the desired operations have been finished, call the EndUpdate method.

The BeginUpdate and EndUpdate methods use an internal counter to implement the update functionality. The counter's initial value is 0. Visual updates are forbidden if the counter's value is greater than 0, and the updates are enabled if the counter's value is 0. The BeginUpdate method increments the counter. The EndUpdate method decrements the counter. If the counter's new value is 0, an immediate visual update occurs. Each call to BeginUpdate must be paired with a call to EndUpdate. To ensure that EndUpdate is always called even if an exception occurs, use the try...finally statement.

Expanded See Also

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