How To: Obtain a Specific Document Part

• Sep 25, 2023
• 3 minutes to read

This example demonstrates how to retrieve the DocumentRange occupied by a specific document part.

Obtain Section Content

Use the Section.Range property to access the required section’s range.

Obtain Page Content

Call the DocumentLayout.GetPage method to iterate through the document pages. The LayoutPage.MainContentRange property returns the obtained page’s range as a FixedRange object. Call the SubDocument.CreateRange method to convert the retrieved FixedRange to DocumentRange.

C#

int pageCount = richEditControl1.DocumentLayout.GetPageCount();
for (int i = 0; i < pageCount; i++)
{
    LayoutPage layoutPage = richEditControl.DocumentLayout.GetPage(i);
    FixedRange contentRange = layoutPage.MainContentRange;
    DocumentRange mainBodyRange =
         richEditControl.Document.CreateRange(contentRange.Start, contentRange.Length);
}

VB.NET

Private Sub SurroundingSub()
Dim pageCount As Integer = richEditControl1.DocumentLayout.GetPageCount()

For i As Integer = 0 To pageCount - 1
  Dim layoutPage As LayoutPage = richEditControl.DocumentLayout.GetPage(i)
  Dim contentRange As FixedRange = layoutPage.MainContentRange
  Dim mainBodyRange As DocumentRange =
     richEditControl.Document.CreateRange(contentRange.Start, contentRange.Length)
Next
End Sub

Obtain Paragraphs with Headings

Applying the Heading style to the paragraph changes its outline level. Find all paragraphs with the required Paragraph.OutlineLevel property value. Then obtain the range located between these paragraphs (including the paragraph with the heading).

C#

Document document = richEditControl1.Document;
List<Paragraph> paragraphs = document.Paragraphs.Where(paragraph => paragraph.OutlineLevel == 1).ToList();
for (int i = 0; i < paragraphs.Count; i++)
{
  DocumentRange range;
  DocumentPosition startPos = paragraphs[i].Range.Start;
  if (i == paragraphs.Count - 1)
    range = document.CreateRange(startPos, document.Range.End.ToInt() - startPos.ToInt());
  else
    range = document.CreateRange(startPos, paragraphs[i + 1].Range.Start.ToInt() - startPos.ToInt());
}

VB.NET

Dim document As Document = richEditControl1.Document
Dim paragraphs As List(Of Paragraph) = document.Paragraphs.Where(Function(paragraph) paragraph.OutlineLevel = 1).ToList()

For i As Integer = 0 To paragraphs.Count - 1
Dim range As DocumentRange
Dim startPos As DocumentPosition = paragraphs(i).Range.Start

  If i = paragraphs.Count - 1 Then
    range = document.CreateRange(startPos, document.Range.[End].ToInt() - startPos.ToInt())
  Else
    range = document.CreateRange(startPos, paragraphs(i + 1).Range.Start.ToInt() - startPos.ToInt())
  End If
Next

Retrieve Text from a Range

You can get text from the DocumentRange instance. The table below shows API used to retrieve and insert format-specific content:

Format	Retrieve	Insert
Plain Text	SubDocument.GetText	SubDocument.AppendText - Appends the specified text. SubDocument.AppendSingleLineText - Appends text as a single line. SubDocument.InsertText - Inserts the specified text at the specified position. SubDocument.InsertSingleLineText - Inserts a single line of text (text without line breaks) at the specified position.
Rich Text Format	SubDocument.GetRtfText	SubDocument.AppendRtfText - Appends formatted text. SubDocument.InsertRtfText - Inserts the specified formatted text into the specified position.
HTML	SubDocument.GetHtmlText	SubDocument.AppendHtmlText - Appends HTML formatted text. SubDocument.InsertHtmlText - Inserts the specified HTML text into the specified position.
MHT	SubDocument.GetMhtText
WordML	SubDocument.GetWordMLText
OpenXML array	SubDocument.GetOpenXmlBytes