ParagraphStyle Interface

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

Namespace: DevExpress.XtraRichEdit.API.Native

Assembly: DevExpress.RichEdit.v19.1.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

A style pertains to a document. It belongs to a particular document model and you cannot just add the style object from a style collection of one document to the style collection of another document.

The following code snippet creates a new paragraph style via the ParagraphStyleCollection.CreateNew method, specifies style settings, adds it to the document style collection and applies the style to the currently selected paragraph.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/winforms-richedit-document-api-e5219

Styles.vb

document.LoadDocument("Grimm.docx", DevExpress.XtraRichEdit.DocumentFormat.OpenXml)
Dim pstyle As ParagraphStyle = document.ParagraphStyles("MyPStyle")
If pstyle Is Nothing Then
    pstyle = document.ParagraphStyles.CreateNew()
    pstyle.Name = "MyPStyle"
    pstyle.LineSpacingType = ParagraphLineSpacing.Double
    pstyle.Alignment = ParagraphAlignment.Center
    document.ParagraphStyles.Add(pstyle)
End If
document.Paragraphs(2).Style = pstyle

Styles.cs

document.LoadDocument("Grimm.docx", DevExpress.XtraRichEdit.DocumentFormat.OpenXml);
ParagraphStyle pstyle = document.ParagraphStyles["MyPStyle"];
if (pstyle == null)
{
    pstyle = document.ParagraphStyles.CreateNew();
    pstyle.Name = "MyPStyle";
    pstyle.LineSpacingType = ParagraphLineSpacing.Double;
    pstyle.Alignment = ParagraphAlignment.Center;
    document.ParagraphStyles.Add(pstyle);
}
document.Paragraphs[2].Style = pstyle;

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