SubDocument.EndUpdateParagraphs(ParagraphProperties) Method

Finalizes the modification of paragraph formatting after calling the SubDocument.BeginUpdateParagraphs method.

Namespace: DevExpress.XtraRichEdit.API.Native

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

Declaration

C#

void EndUpdateParagraphs(
    ParagraphProperties properties
)

VB.NET

Sub EndUpdateParagraphs(
    properties As ParagraphProperties
)

Parameters

Name	Type	Description
properties	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 EndUpdateParagraphs(ParagraphProperties) 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#L66

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/CS/WindowsFormsApplication1/TOCHelpers.cs#L73

pp.Alignment = ParagraphAlignment.Right;
myFooter.EndUpdateParagraphs(pp);

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

targetParagraphProperties.Assign(sourceParagraphProperties);
subDocument.EndUpdateParagraphs(sourceParagraphProperties);
targetSubDocument.EndUpdateParagraphs(targetParagraphProperties);

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

pp.EndUpdateTabs(tbiColl);
doc.EndUpdateParagraphs(pp);
#endregion #formatparagraph

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

    pp_Headings.Style = doc.ParagraphStyles["My Headings Style"];
    doc.EndUpdateParagraphs(pp_Headings);
}

VB.NET

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

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

pp.Alignment = ParagraphAlignment.Right
myFooter.EndUpdateParagraphs(pp)

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

targetParagraphProperties.Assign(sourceParagraphProperties)
subDocument.EndUpdateParagraphs(sourceParagraphProperties)
targetSubDocument.EndUpdateParagraphs(targetParagraphProperties)

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

            pp.EndUpdateTabs(tbiColl)
            document.EndUpdateParagraphs(pp)
'            #End Region ' #FormatParagraph

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

            pp.EndUpdateTabs(tbiColl)
            doc.EndUpdateParagraphs(pp)
'            #End Region ' #formatparagraph