ParagraphStyle Interface

Exposes methods and characteristics of a paragraph style in a document.

Namespace: DevExpress.XtraRichEdit.API.Native

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

Declaration

C#

[ComVisible(true)]
public interface ParagraphStyle :
    ParagraphPropertiesWithTabs,
    ParagraphPropertiesBase,
    CharacterPropertiesBase

VB.NET

<ComVisible(True)>
Public Interface ParagraphStyle
    Inherits ParagraphPropertiesWithTabs,
             ParagraphPropertiesBase,
             CharacterPropertiesBase

Related API Members

The following members return ParagraphStyle objects:

• CharacterStyle.LinkedStyle
• ListLevel.ParagraphStyle
• Paragraph.Style
• ParagraphProperties.Style
• ParagraphStyle.NextStyle
• ParagraphStyle.Parent
• ParagraphStyleCollection.CreateNew()
• ParagraphStyleCollection.Item[String]

Remarks

Use the paragraph style to change both character (a font type, size, color, etc.) and paragraph (alignment, spacing before and after, etc.) attributes as in the current example. RichEditDocumentServer doesn’t have any predefined document styles. Use members from the table below to create a new document style.

The code sample below demonstrates creates a new paragraph style and apply it to every chapter.

C#

//Open the document for editing
document.BeginUpdate();

//Create a new paragraph style instance
//and specify the required properties
ParagraphStyle chapterStyle = document.ParagraphStyles.CreateNew();
chapterStyle.Name = "MyTitleStyle";
chapterStyle.ForeColor = Color.SteelBlue;
chapterStyle.FontSize = 16;
chapterStyle.FontName = "Segoe UI Semilight";
chapterStyle.Alignment = ParagraphAlignment.Left;
chapterStyle.SpacingBefore = Units.InchesToDocumentsF(0.2f);
chapterStyle.SpacingAfter = Units.InchesToDocumentsF(0.2f);
chapterStyle.OutlineLevel = 2;

//Add the object to the document collection
document.ParagraphStyles.Add(chapterStyle);

//Finalize the editing
document.EndUpdate();

//Apply the created style to every chapter in the document 
for (int i = 0; i < document.Paragraphs.Count; i++)
{
    string var = document.GetText(document.Paragraphs[i].Range);
    if (var.Contains("Chapter "))
    {
        document.Paragraphs[i].Style = chapterStyle;
    }
}
return;

VB.NET

'Open the document for editing
document.BeginUpdate()

'Create a new paragraph style instance
'and specify the required properties
Dim chapterStyle As ParagraphStyle = document.ParagraphStyles.CreateNew()
chapterStyle.Name = "MyTitleStyle"
chapterStyle.ForeColor = Color.SteelBlue
chapterStyle.FontSize = 16
chapterStyle.FontName = "Segoe UI Semilight"
chapterStyle.Alignment = ParagraphAlignment.Left
chapterStyle.SpacingBefore = Units.InchesToDocumentsF(0.2F)
chapterStyle.SpacingAfter = Units.InchesToDocumentsF(0.2F)
chapterStyle.OutlineLevel = 2

'Add the object to the document collection
document.ParagraphStyles.Add(chapterStyle)

'Finalize the editing
document.EndUpdate()

'Apply the created style to every chapter in the document
For i As Integer = 0 To document.Paragraphs.Count - 1
    Dim var As String = document.GetText(document.Paragraphs(i).Range)
    If var.Contains("Chapter ") Then
        document.Paragraphs(i).Style = chapterStyle
    End If
Next i
Return

If the loaded document already has document styles, they are automatically added to the document’s CharacterStyleCollection or ParagraphStyleCollection and you can use them as shown in the code snippet below.

C#

//Apply style to the paragraph
richEditDocumentServer1.Document.Paragraphs[1].Style = richEditDocumentServer1.Document.ParagraphStyles["Heading 2"];

//Apply style to the character range
DocumentRange range = richEditDocumentServer1.Document.Paragraphs[1].Range;
CharacterProperties rangeProperties = richEditDocumentServer1.Document.BeginUpdateCharacters(range);
rangeProperties.Style = richEditDocumentServer1.Document.CharacterStyles["Heading 2"];
richEditDocumentServer1.Document.EndUpdateCharacters(rangeProperties);

VB.NET

'Apply style to the paragraph
richEditDocumentServer1.Document.Paragraphs(1).Style = richEditDocumentServer1.Document.ParagraphStyles("Heading 2")

'Apply style to the character range
Dim range As DocumentRange = richEditDocumentServer1.Document.Paragraphs(1).Range
Dim rangeProperties As CharacterProperties = richEditDocumentServer1.Document.BeginUpdateCharacters(range)
rangeProperties.Style = richEditDocumentServer1.Document.CharacterStyles("Heading 2")
richEditDocumentServer1.Document.EndUpdateCharacters(rangeProperties)

Tip

Load an empty document created in Microsoft® Word® using the Document.LoadDocument method in the RichEditDocumentServer.EmptyDocumentCreated event handler to fill the collection of a newly created document with the predefined styles.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the ParagraphStyle interface.

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#L68

ParagraphStyle style_Header = doc.ParagraphStyles.CreateNew();
style_Header.FontName = "Comic Sans";

table-api-creating-table-a-simple-example-e3242/CS/Walkthrough_Creating_Table/Form1.cs#L126

// Define Headings paragraph style
ParagraphStyle pStyleHeadings = richEditControl1.Document.ParagraphStyles.CreateNew();
pStyleHeadings.Bold = true;

VB.NET

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

Dim style_Header As ParagraphStyle = doc.ParagraphStyles.CreateNew()
style_Header.FontName = "Comic Sans"

table-api-creating-table-a-simple-example-e3242/VB/Walkthrough_Creating_Table/Form1.vb#L122

' Define Headings paragraph style
Dim pStyleHeadings As ParagraphStyle = richEditControl1.Document.ParagraphStyles.CreateNew()
pStyleHeadings.Bold = True