Paragraph Class

A document paragraph.

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#

[ComVisible(true)]
public abstract class Paragraph

VB.NET

<ComVisible(True)>
Public MustInherit Class Paragraph

Related API Members

The following members return Paragraph objects:

• ParagraphCollection.Append()
• ParagraphCollection.Insert(DocumentPosition, InsertOptions)
• ParagraphCollection.Insert(DocumentPosition)
• ReadOnlyParagraphCollection.Get(DocumentPosition)

Remarks

Access Paragraphs

The ParagraphCollection contains all document paragraphs. Use the SubDocument.Paragraphs property to access a specific paragraph by its index. The Section.Paragraphs property obtains a collection of paragraphs in a specific document section. Call the ReadOnlyParagraphCollection.Get method to retrieve a paragraph related to a specific range.

Format Paragraphs

Yoy can format paragraphs directly or use document styles. Refer to the following topic for more examples on how to format paragraphs:

Read Tutorial: Text Formatting

Example

The code sample below appends a paragraph and inserts a paragraph at the start of the second section:

C#

using DevExpress.XtraRichEdit.API.Native;

using (var wordProcessor = new RichEditDocumentServer())
{
  wordProcessor.LoadDocument("FirstLook.docx");
  Document document = wordProcessor.Document;

  // Start the document update:
  document.BeginUpdate();

  // Append a paragraph:
  Paragraph appendedParagraph = document.Paragraphs.Append();
  document.InsertText(appendedParagraph.Range.Start, "Appended paragraph");

  // Insert a paragraph at the start of the second section:
  Paragraph paragraph =
     document.Paragraphs.Insert(document.Sections[1].Range.Start);
  DocumentPosition position =
     document.Paragraphs[paragraph.Index - 1].Range.Start;
  document.InsertText(position, "Inserted paragraph");

  // Finalize the document update:
  document.EndUpdate();
}

VB.NET

Imports DevExpress.XtraRichEdit.API.Native

Using wordProcessor = New RichEditDocumentServer()
  wordProcessor.LoadDocument("FirstLook.docx")
  Dim document As Document = wordProcessor.Document

  ' Start the document update:
  document.BeginUpdate()

  ' Append a paragraph:
  Dim appendedParagraph As Paragraph = document.Paragraphs.Append()
  document.InsertText(appendedParagraph.Range.Start, "Appended paragraph")

  ' Insert a paragraph at the start of the second section:
  Dim paragraph As Paragraph =
     document.Paragraphs.Insert(document.Sections(1).Range.Start)
  Dim position As DocumentPosition =
     document.Paragraphs(paragraph.Index - 1).Range.Start
  document.InsertText(position, "Inserted paragraph")

  ' Finalize the document update:
  document.EndUpdate()

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the Paragraph class.

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#

table-api-how-to-create-a-multiplication-table-in-code-e3231/CS/Table_API_Example/Form1.cs#L101

foreach (Paragraph p in doc.Paragraphs.Get(header_Row.Next.Range))
{

VB.NET

table-api-how-to-create-a-multiplication-table-in-code-e3231/VB/Table_API_Example/Form1.vb#L94

For Each p As Paragraph In doc.Paragraphs.Get(header_Row.Next.Range)
    p.Style = doc.ParagraphStyles("MyTableCaptionStyle")

Inheritance

Object

Paragraph