General Information
.NET Subscription
Desktop
Web
Controls and Extensions
Mainteinance Mode
Enterprise and Analytic Tools
Quality Assurance and Productivity
Frameworks and Libraries
DocumentRange.EndUpdateDocument(SubDocument) Method
Finalizes modifications of the document obtained via the document's range (e.g. via selection).
Namespace: DevExpress.XtraRichEdit.API.Native
Assembly: DevExpress.RichEdit.v19.2.Core.dll
Declaration
Parameters
| Name | Type | Description |
|---|---|---|
| document | SubDocument | A SubDocument instance obtained via the previously called DocumentRange.BeginUpdateDocument method. |
Parameters
| Name | Type | Description |
|---|---|---|
| document | SubDocument | A SubDocument instance obtained via the previously called DocumentRange.BeginUpdateDocument method. |
Parameters
| Name | Type | Description |
|---|---|---|
| document | SubDocument | A SubDocument instance obtained via the previously called DocumentRange.BeginUpdateDocument method. |
Remarks
Use the DocumentRange.BeginUpdateDocument - DocumentRange.EndUpdateDocument pair to modify the document obtained via selection (i.e. by using the Document.Selection property). In that case, it is very important to distinguish different parts of the document, such as header, footer or body. The EndUpdateDocument method implements this requirement.
Examples
The following code replaces the selected text with asterisks.
The RichEditControl instance is passed to the BarItem.ItemClick event handler using the BarItem.Tag property.
Note
A complete sample project is available at https://github.com/DevExpress-Examples/winforms-the-richeditcontrols-common-api-t210437
Private Shared Sub buttonCustomAction_ItemClick_Replace(ByVal sender As Object, ByVal e As ItemClickEventArgs)
Dim richEdit As RichEditControl = TryCast(e.Item.Tag, RichEditControl)
Dim range As DocumentRange = richEdit.Document.Selection
Dim selLength As Integer = range.Length
Dim s As New String("*"c, selLength)
Dim doc As SubDocument = range.BeginUpdateDocument()
doc.InsertSingleLineText(range.Start, s)
Dim rangeToRemove As DocumentRange = doc.CreateRange(range.Start, selLength)
doc.Delete(rangeToRemove)
range.EndUpdateDocument(doc)
End Sub