SubDocument.BeginUpdateParagraphs(DocumentRange) Method

Starts modifying properties of the paragraphs that fall within a specified document range.

Namespace: DevExpress.XtraRichEdit.API.Native

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

Declaration

C#

ParagraphProperties BeginUpdateParagraphs(
    DocumentRange range
)

VB.NET

Function BeginUpdateParagraphs(
    range As DocumentRange
) As ParagraphProperties

Parameters

Name	Type	Description
range	DocumentRange	A DocumentRange specifying the DocumentRange.Start and DocumentRange.End of the text.

Returns

Type	Description
ParagraphProperties	A ParagraphProperties object representing paragraph formatting.

Remarks

Note

A complete sample project is available at: WinForms RichEdit Document API

C#

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);

VB.NET

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)

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the BeginUpdateParagraphs(DocumentRange) method.

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

doc.InsertSingleLineText(tbl[0, 1].Range.Start, "Size");
ParagraphProperties pp_HeadingSize = doc.BeginUpdateParagraphs(tbl[0, 1].Range);
pp_HeadingSize.Alignment = ParagraphAlignment.Right;

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

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

how-to-implement-the-basic-idea-of-the-ms-office-word-format-painter-for-richeditcontrol-e5223/CS/DXApplication9/Form1.cs#L115

DevExpress.XtraRichEdit.API.Native.ParagraphProperties targetParagraphProperties = targetSubDocument.BeginUpdateParagraphs(targetSelectedRange);
DevExpress.XtraRichEdit.API.Native.ParagraphProperties sourceParagraphProperties = subDocument.BeginUpdateParagraphs(sourceSelectedRange);

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

DocumentRange range = doc.CreateRange(pos, 0);
ParagraphProperties pp = doc.BeginUpdateParagraphs(range);
// Center paragraph

dxrichedit-for-wpf-table-api-creating-table-a-simple-example-e3266/CS/MainWindow.xaml.cs#L160

}
ParagraphProperties pp_Headings = doc.BeginUpdateParagraphs(tbl.Rows.First.Range);
pp_Headings.Style = doc.ParagraphStyles["My Headings Style"];

VB.NET

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

doc.InsertSingleLineText(tbl(0, 1).Range.Start, "Size")
Dim pp_HeadingSize As ParagraphProperties = doc.BeginUpdateParagraphs(tbl(0, 1).Range)
pp_HeadingSize.Alignment = ParagraphAlignment.Right

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

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

how-to-implement-the-basic-idea-of-the-ms-office-word-format-painter-for-richeditcontrol-e5223/VB/DXApplication9/Form1.vb#L104

Dim targetParagraphProperties As DevExpress.XtraRichEdit.API.Native.ParagraphProperties = targetSubDocument.BeginUpdateParagraphs(targetSelectedRange)
Dim sourceParagraphProperties As DevExpress.XtraRichEdit.API.Native.ParagraphProperties = subDocument.BeginUpdateParagraphs(sourceSelectedRange)

wpf-richedit-document-api-t213968/VB/DXRichEditControlAPISample/CodeExamples/FormattingActions.vb#L47

Dim range As DocumentRange = document.CreateRange(pos, 0)
Dim pp As ParagraphProperties = document.BeginUpdateParagraphs(range)
' Center paragraph

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

Dim range As DocumentRange = doc.CreateRange(pos, 0)
Dim pp As ParagraphProperties = doc.BeginUpdateParagraphs(range)
' Center paragraph