officefileapi-devexpress-dot-xtrarichedit-dot-api-dot-native-dot-subdocument-dot-beginupdateparagraphs-x28-devexpress-dot-xtrarichedit-dot-api-dot-native-dot-documentrange-x29.md
Starts modifying properties of the paragraphs that fall within a specified document range.
Namespace : DevExpress.XtraRichEdit.API.Native
Assembly : DevExpress.RichEdit.v25.2.Core.dll
NuGet Package : DevExpress.RichEdit.Core
ParagraphProperties BeginUpdateParagraphs(
DocumentRange range
)
Function BeginUpdateParagraphs(
range As DocumentRange
) As ParagraphProperties
| Name | Type | Description |
|---|---|---|
| range | DocumentRange |
A DocumentRange specifying the DocumentRange.Start and DocumentRange.End of the text.
|
| Type | Description |
|---|---|
| ParagraphProperties |
A ParagraphProperties object representing paragraph formatting.
|
The following code snippet changes paragraph formatting in code:
using DevExpress.XtraRichEdit.API.Native;
using DevExpress.Office.Utils;
using (var wordProcessor = new RicheditDocumentServer())
{
// Access a document.
Document document = wordProcessor.Document;
// Start to edit the document.
document.BeginUpdate();
// Append text to the document.
document.AppendText("Modified Paragraph\nNormal\nNormal");
// Finalize document modification.
document.EndUpdate();
// Access the first paragraph's range
DocumentRange range = document.Paragraphs[0].Range;
// Start to edit the paragraph.
ParagraphProperties pp = document.BeginUpdateParagraphs(range);
// Specify the paragraph's alignment.
pp.Alignment = ParagraphAlignment.Center;
// Specify the paragraph's line spacing.
pp.LineSpacingType = ParagraphLineSpacing.Multiple;
pp.LineSpacingMultiplier = 3;
// Set the paragraph's left indent to 0.5 document unit.
// Default unit is 1/300 of an inch (a document unit).
pp.LeftIndent = Units.InchesToDocumentsF(0.5f);
// Start to modify tab stops in the paragraph.
TabInfoCollection tbiColl = pp.BeginUpdateTabs(true);
// Create a new tab stop for the paragraph.
TabInfo tbi = TabInfo();
// Specify the tab stop's alignment type.
tbi.Alignment = TabAlignmentType.Center;
// Set the tab stop position to 1.5 document unit.
tbi.Position = Units.InchesToDocumentsF(1.5f);
// Add the tab stop to the collection of tab stops.
tbiColl.Add(tbi);
// Finalize tab stop modification.
pp.EndUpdateTabs(tbiColl);
// Finalize the paragraph edit operation.
document.EndUpdateParagraphs(pp);
}
Imports Microsoft.VisualBasic
Imports DevExpress.XtraRichEdit.API.Native
Imports DevExpress.Office.Utils
Using wordProcessor = New RicheditDocumentServer()
' Access a document.
Dim document As Document = wordProcessor.Document
' Start to edit the document.
document.BeginUpdate()
' Append text to the document.
document.AppendText("Modified Paragraph\nNormal\nNormal")
' Finalize document modification.
document.EndUpdate()
' Access the first paragraph range
Dim range As DocumentRange = document.Paragraphs(0).Range
' Start to edit the paragraph.
Dim pp As ParagraphProperties = document.BeginUpdateParagraphs(range)
' Specify the paragraph's alignment.
pp.Alignment = ParagraphAlignment.Center
' Specify the paragraph's line spacing.
pp.LineSpacingType = ParagraphLineSpacing.Multiple
pp.LineSpacingMultiplier = 3
' Set the paragraph's left indent to 0.5 document unit.
' Default unit is 1/300 of an inch (a document unit).
pp.LeftIndent =.Units.InchesToDocumentsF(0.5F)
' Start to modify tab stops in the paragraph.
Dim tbiColl As TabInfoCollection = pp.BeginUpdateTabs(True)
' Create a new tab stop for the paragraph.
Dim tbi As TabInfo = TabInfo()
' Specify the tab stop's alignment type.
tbi.Alignment = TabAlignmentType.Center
' Set the tab stop position to 1.5 document unit.
tbi.Position = Units.InchesToDocumentsF(1.5F)
' Add the tab stop to the collection of tab stops.
tbiColl.Add(tbi)
' Finalize tab stop modification.
pp.EndUpdateTabs(tbiColl)
' Finalize the paragraph edit operation.
document.EndUpdateParagraphs(pp)
End Using
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.
winforms-richedit-document-api/CS/RichEditAPISample/CodeExamples/Formatting.cs#L61
// that sets character formatting for the selected range
ParagraphProperties pp = document.BeginUpdateParagraphs(range);
// Center paragraph
wpf-richedit-document-api/CS/DXRichEditControlAPISample/CodeExamples/FormattingActions.cs#L48
DocumentRange range = document.CreateRange(pos, 0);
ParagraphProperties pp = document.BeginUpdateParagraphs(range);
// Center paragraph
winforms-richedit-tables-simple-example/CS/TablesSimpleExample/Form1.cs#L133
document.EndUpdateCharacters(properties);
ParagraphProperties alignment = document.BeginUpdateParagraphs(table[0, 2].ContentRange);
alignment.Alignment = ParagraphAlignment.Center;
word-document-api-table-examples/CS/Program.cs#L115
document.EndUpdateCharacters(properties);
ParagraphProperties alignment = document.BeginUpdateParagraphs(table[0, 1].ContentRange);
alignment.Alignment = ParagraphAlignment.Center;
winforms-rich-edit-implement-ms-office-word-format-painter/CS/DXApplication9/Form1.cs#L115
DevExpress.XtraRichEdit.API.Native.ParagraphProperties targetParagraphProperties = targetSubDocument.BeginUpdateParagraphs(targetSelectedRange);
DevExpress.XtraRichEdit.API.Native.ParagraphProperties sourceParagraphProperties = subDocument.BeginUpdateParagraphs(sourceSelectedRange);
winforms-richedit-document-api/VB/RichEditAPISample/CodeExamples/Formatting.vb#L54
' that sets character formatting for the selected range
Dim pp As DevExpress.XtraRichEdit.API.Native.ParagraphProperties = document.BeginUpdateParagraphs(range)
' Center paragraph
wpf-richedit-document-api/VB/DXRichEditControlAPISample/CodeExamples/FormattingActions.vb#L43
Dim range As DocumentRange = document.CreateRange(pos, 0)
Dim pp As ParagraphProperties = document.BeginUpdateParagraphs(range)
' Center paragraph
winforms-richedit-tables-simple-example/VB/TablesSimpleExample/Form1.vb#L109
document.EndUpdateCharacters(properties)
Dim alignment As ParagraphProperties = document.BeginUpdateParagraphs(table(0, 2).ContentRange)
alignment.Alignment = ParagraphAlignment.Center
word-document-api-table-examples/VB/Program.vb#L91
document.EndUpdateCharacters(properties)
Dim alignment As ParagraphProperties = document.BeginUpdateParagraphs(table(0, 1).ContentRange)
alignment.Alignment = ParagraphAlignment.Center
winforms-rich-edit-implement-ms-office-word-format-painter/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)
See Also