ParagraphPropertiesBase.Alignment Property

Gets or sets the paragraph’s text alignment.

Namespace: DevExpress.XtraRichEdit.API.Native

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

Declaration

C#

ParagraphAlignment? Alignment { get; set; }

VB.NET

Property Alignment As ParagraphAlignment?

Property Value

Type	Description
Nullable<ParagraphAlignment>	A ParagraphAlignment enumeration value or null (Nothing in Visual Basic) for a mixture of paragraphs with different alignments.

Available values:

Name	Description
Left	Text is aligned to the left of the paragraph.
Right	Text is aligned to the right of the paragraph.
Center	Text is aligned to the center of the paragraph.
Justify	Text is justified to the entire width of the paragraph.

Remarks

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.

Note

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

Formatting.vb

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

'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)
tbiColl.Add(tbi)
pp.EndUpdateTabs(tbiColl)

'Finalize modifications
' with this method call
document.EndUpdateParagraphs(pp)

Formatting.cs

document.BeginUpdate();
document.AppendText("Modified Paragraph\nNormal\nNormal");
document.EndUpdate();

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

// Create and customize an object  
// that sets character formatting for the selected range
ParagraphProperties pp = 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"
TabInfoCollection tbiColl = pp.BeginUpdateTabs(true);
TabInfo tbi = new DevExpress.XtraRichEdit.API.Native.TabInfo();
tbi.Alignment = TabAlignmentType.Center;
tbi.Position = DevExpress.Office.Utils.Units.InchesToDocumentsF(1.5f);
tbiColl.Add(tbi);
pp.EndUpdateTabs(tbiColl);

//Finalize modifications
// with this method call
document.EndUpdateParagraphs(pp);

Related GitHub Examples

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

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-creating-table-a-simple-example-e3242/CS/Walkthrough_Creating_Table/Form1.cs#L65

ParagraphProperties pp_HeadingSize = doc.BeginUpdateParagraphs(tbl[0, 1].Range);
pp_HeadingSize.Alignment = ParagraphAlignment.Right;
doc.EndUpdateParagraphs(pp_HeadingSize);

how-to-change-formatting-of-text-and-paragraph-e2206/CS/HowToChangeFormatting/Form1.cs#L52

// Center paragraph
pp.Alignment = ParagraphAlignment.Center;
// Set triple spacing

how-to-dynamically-generate-table-of-contents-by-adding-toc-field-with-different-nesting-l-t424524/CS/WindowsFormsApplication1/TOCHelpers.cs#L72

ParagraphProperties pp = myFooter.BeginUpdateParagraphs(myFooter.Range);
pp.Alignment = ParagraphAlignment.Right;
myFooter.EndUpdateParagraphs(pp);

how-to-create-and-apply-document-styles-e2670/CS/Styles/Form1.cs#L56

pStyle.LineSpacingType = ParagraphLineSpacing.Double;
pStyle.Alignment = ParagraphAlignment.Center;
richEditControl1.Document.ParagraphStyles.Add(pStyle);

how-to-change-character-and-paragraph-formatting-e3323/CS/HowToChangeFormatting/MainWindow.xaml.cs#L38

// Center paragraph
pp.Alignment = ParagraphAlignment.Center;
// Set triple spacing

VB.NET

how-to-change-formatting-of-text-and-paragraph-e2206/VB/HowToChangeFormatting/Form1.vb#L49

' Center paragraph
pp.Alignment = ParagraphAlignment.Center
' Set triple spacing

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

Dim pp_HeadingSize As ParagraphProperties = doc.BeginUpdateParagraphs(tbl(0, 1).Range)
pp_HeadingSize.Alignment = ParagraphAlignment.Right
doc.EndUpdateParagraphs(pp_HeadingSize)

how-to-dynamically-generate-table-of-contents-by-adding-toc-field-with-different-nesting-l-t424524/VB/WindowsFormsApplication1/TOCHelpers.vb#L76

Dim pp As ParagraphProperties = myFooter.BeginUpdateParagraphs(myFooter.Range)
pp.Alignment = ParagraphAlignment.Right
myFooter.EndUpdateParagraphs(pp)

wpf-richedit-document-api-t213968/VB/DXRichEditControlAPISample/CodeExamples/StylesActions.vb#L38

pstyle.LineSpacingType = ParagraphLineSpacing.Double
pstyle.Alignment = ParagraphAlignment.Center
document.ParagraphStyles.Add(pstyle)

how-to-create-and-apply-document-styles-e2670/VB/Styles/Form1.vb#L50

pStyle.LineSpacingType = ParagraphLineSpacing.Double
pStyle.Alignment = ParagraphAlignment.Center
richEditControl1.Document.ParagraphStyles.Add(pStyle)