SubDocument.Delete(DocumentRange) Method

Removes content from the specified range.

Namespace: DevExpress.XtraRichEdit.API.Native

Assembly: DevExpress.RichEdit.v20.2.Core.dll

NuGet Package: DevExpress.RichEdit.Core

NuGet Packages: DevExpress.RichEdit.Core, DevExpress.WindowsDesktop.RichEdit.Core

Declaration

C#

void Delete(
    DocumentRange range
)

VB.NET

Sub Delete(
    range As DocumentRange
)

Parameters

Name	Type	Description
range	DocumentRange	A range with the content to delete.

Remarks

Use the Delete method to remove document content (text, images, etc.) located in the specified range.

The code sample below removes specific words from a document:

C#

using DevExpress.XtraRichEdit.API.Native;

using (RichEditDocumentServer wordProcessor = new RichEditDocumentServer())
{
    wordProcessor.LoadDocument("FirstLook.docx");
    RemoveSpecificWords(wordProcessor.Document);
}

static void RemoveSpecificWords(Document document)
{
    string word = "Ounce";
    DocumentRange[] found = document.FindAll
      (word, SearchOptions.WholeWord);
    foreach (DocumentRange range in found)
    {
        document.Delete(range);
    }
}

VB.NET

Imports DevExpress.XtraRichEdit.API.Native

Using wordProcessor As New RichEditDocumentServer()
    wordProcessor.LoadDocument("FirstLook.docx")
    RemoveSpecificWords(wordProcessor.Document)
End Using

static void RemoveSpecificWords(Document document)
    Dim word As String = "Ounce"
    Dim found() As DocumentRange = document.FindAll
      (word, SearchOptions.WholeWord)
    For Each range As DocumentRange In found
      document.Delete(range)
    Next range
End Sub

If the DocumentRange passed as the method parameter contains only table cells without the text surrounding the table, the Delete method clears the only the cells content. If you want do delete a table row or other table elements, utilize the following methods instead:

• TableRow.Delete()
• TableCell.Delete()
• TableCollection.Remove(Table)

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Delete(DocumentRange) method.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

how-to-merge-documents-with-headers-and-footers-into-a-single-document-e4404/CS/DocumentMerger/Helpers/SectionsMerger.cs#L31

SubDocument target = targetSection.BeginUpdateHeader(headerFooterType);
target.Delete(target.Range);
target.InsertDocumentContent(target.Range.Start, source.Range, InsertOptions.KeepSourceFormatting);

word-document-api-examples/CS/CodeExamples/BasicActions.cs#L49

//Delete last empty paragraph
tempServer.Document.Delete(tempServer.Document.Paragraphs.First().Range);
//Save the result

how-to-add-a-watermark-with-a-text-or-image-to-the-document-e4184/CS/Form1.cs#L28

SubDocument subDocument = section.BeginUpdateHeader();
subDocument.Delete(subDocument.Range);
Shape shape = subDocument.Shapes.InsertTextBox(subDocument.Range.Start);

how-to-add-remove-a-specific-watermark-only-for-a-particular-section-of-the-richeditcontrols-e4901/CS/WindowsFormsApplication1/Form1.cs#L51

SubDocument subDocument = currentSection.BeginUpdateHeader();
subDocument.Delete(subDocument.Range);
Shape shape = subDocument.Shapes.InsertPicture(subDocument.Range.Start, watermarkImage);

wpf-richedit-document-api/CS/DXRichEditControlAPISample/CodeExamples/NotesActions.cs#L53

//Clear the range:
footnote.Delete(noteTextRange);

VB.NET

how-to-merge-documents-with-headers-and-footers-into-a-single-document-e4404/VB/DocumentMerger/Helpers/SectionsMerger.vb#L33

Dim target As SubDocument = targetSection.BeginUpdateHeader(headerFooterType)
target.Delete(target.Range)
target.InsertDocumentContent(target.Range.Start, source.Range, InsertOptions.KeepSourceFormatting)

word-document-api-examples/VB/CodeExamples/NotesActions.vb#L43

'Clear the range:
footnote.Delete(noteTextRange)
'Append a new text:

how-to-add-a-watermark-with-a-text-or-image-to-the-document-e4184/VB/Form1.vb#L30

Dim subDocument As SubDocument = section.BeginUpdateHeader()
subDocument.Delete(subDocument.Range)
Dim shape As Shape = subDocument.Shapes.InsertTextBox(subDocument.Range.Start)

how-to-add-remove-a-specific-watermark-only-for-a-particular-section-of-the-richeditcontrols-e4901/VB/WindowsFormsApplication1/Form1.vb#L53

Dim subDocument As SubDocument = currentSection.BeginUpdateHeader()
subDocument.Delete(subDocument.Range)
Dim shape As Shape = subDocument.Shapes.InsertPicture(subDocument.Range.Start, watermarkImage)

wpf-richedit-document-api/VB/DXRichEditControlAPISample/CodeExamples/NotesActions.vb#L47

'Clear the range:
footnote.Delete(noteTextRange)