Skip to main content
A newer version of this page is available. .
.NET Framework 4.5.2+

ParagraphPropertiesBase Interface

Serves as the base for the ParagraphProperties interface, providing access to paragraph properties.

Namespace: DevExpress.XtraRichEdit.API.Native

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


public interface ParagraphPropertiesBase


The ParagraphPropertiesBase interface allows you to get/set paragraph characteristics.

Use the SubDocument.BeginUpdateParagraphs and the SubDocument.EndUpdateParagraphs paired methods to modify paragraph formatting, such as the ParagraphPropertiesBase.LineSpacing, Paragraph.Alignment, Paragraph.SpacingBefore etc.

To accomplish this, call the SubDocument.BeginUpdateParagraphs method for the specified range, modify the properties of the returned ParagraphProperties object and call the SubDocument.EndUpdateParagraphs method to finalize the modification.

The following code snippet changes the first line indent and the line spacing of the paragraph containing the selection. It also adds a new tab stop for the paragraph using the Paragraph.BeginUpdateTabs - Paragraph.EndUpdateTabs pair of methods.

document.AppendText("Modified Paragraph" & vbLf & "Normal" & vbLf & "Normal")

'The target range is the first paragraph
Dim pos As DocumentPosition = document.Range.Start
Dim range As DocumentRange = document.CreateRange(pos, 0)

' Create and customize an object  
' that sets character formatting for the selected range
Dim pp As ParagraphProperties = document.BeginUpdateParagraphs(range)
' Center paragraph
pp.Alignment = ParagraphAlignment.Center
' Set triple spacing
pp.LineSpacingType = ParagraphLineSpacing.Multiple
pp.LineSpacingMultiplier = 3
' Set left indent at 0.5".
' Default unit is 1/300 of an inch (a document unit).
pp.LeftIndent = DevExpress.Office.Utils.Units.InchesToDocumentsF(0.5F)
' Set tab stop at 1.5"
Dim tbiColl As TabInfoCollection = pp.BeginUpdateTabs(True)
Dim tbi As TabInfo = New DevExpress.XtraRichEdit.API.Native.TabInfo()
tbi.Alignment = TabAlignmentType.Center
tbi.Position = DevExpress.Office.Utils.Units.InchesToDocumentsF(1.5F)

'Finalize modifications
' with this method call
See Also