Back to Devexpress

ParagraphPropertiesWithTabs.EndUpdateTabs(TabInfoCollection) Method

officefileapi-devexpress-dot-xtrarichedit-dot-api-dot-native-dot-paragraphpropertieswithtabs-dot-endupdatetabs-x28-devexpress-dot-xtrarichedit-dot-api-dot-native-dot-tabinfocollection-x29.md

latest6.8 KB
Original Source

ParagraphPropertiesWithTabs.EndUpdateTabs(TabInfoCollection) Method

Finalizes modifications of tab stops for the current paragraph.

Namespace : DevExpress.XtraRichEdit.API.Native

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

NuGet Package : DevExpress.RichEdit.Core

Declaration

csharp
void EndUpdateTabs(
    TabInfoCollection tabs
)
vb
Sub EndUpdateTabs(
    tabs As TabInfoCollection
)

Parameters

NameTypeDescription
tabsTabInfoCollection

A TabInfoCollection collection containing information about tab stops.

|

Example

The code sample below sets the document measurement Document.Unit to inches and specifies tab stops. Tab stops are set and updated for the target paragraph only.

View Example

csharp
using XtraRichEdit.API.Native;
using DevExpress.Office;

using (var wordProcessor = new RichEditDocumentServer())
{
    wordProcessor.LoadDocument("FirstLook.docx");
    Document document = wordProcessor.Document;

    document.Unit = DocumentUnit.Inch;

    // Access first paragraph tabs
    TabInfoCollection tabs = document.Paragraphs[0].BeginUpdateTabs(true);

    // Set the first tab stop at 2.5 inch
    TabInfo tab1 = new TabInfo();
    tab1.Position = 2.5f;
    tab1.Alignment = TabAlignmentType.Left;
    tab1.Leader = TabLeaderType.MiddleDots;
    tabs.Add(tab1);

    // Set the second tab stop at 5.5 inch
    TabInfo tab2 = new TabInfo();
    tab2.Position = 5.5f;
    tab2.Alignment = TabAlignmentType.Decimal;
    tab2.Leader = TabLeaderType.EqualSign;
    tabs.Add(tab2);

    document.Paragraphs[0].EndUpdateTabs(tabs);
}
vb
Imports XtraRichEdit.API.Native
Imports DevExpress.Office

Using wordProcessor = New RichEditDocumentServer()
    wordProcessor.LoadDocument("FirstLook.docx")
    Dim document As Document = wordProcessor.Document

    document.Unit = DocumentUnit.Inch

    ' Access first paragraph tabs
    Dim tabs As TabInfoCollection = document.Paragraphs(0).BeginUpdateTabs(True)

    ' Set the first tab stop at 2.5 inch
    Dim tab1 As New TabInfo()
    tab1.Position = 2.5F
    tab1.Alignment = TabAlignmentType.Left
    tab1.Leader = TabLeaderType.MiddleDots
    tabs.Add(tab1)

    ' Set the second tab stop at 5.5 inch
    Dim tab2 As New TabInfo()
    tab2.Position = 5.5F
    tab2.Alignment = TabAlignmentType.Decimal
    tab2.Leader = TabLeaderType.EqualSign
    tabs.Add(tab2)

    document.Paragraphs(0).EndUpdateTabs(tabs)
End Using

[BeginUpdateTabs] xref:DevExpress.XtraRichEdit.API.Native.Paragraph.BeginUpdateTabs(System.Boolean)

The following code snippets (auto-collected from DevExpress Examples) contain references to the EndUpdateTabs(TabInfoCollection) 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-rich-edit-text-formatting/CS/Text Formatting Example/Form1.cs#L82

csharp
tbiColl.Add(tbi);
titleParagraphFormatting.EndUpdateTabs(tbiColl);

winforms-richedit-document-api/CS/RichEditAPISample/CodeExamples/Formatting.cs#L76

csharp
tbiColl.Add(tbi);
pp.EndUpdateTabs(tbiColl);

wpf-richedit-document-api/CS/DXRichEditControlAPISample/CodeExamples/FormattingActions.cs#L63

csharp
tbiColl.Add(tbi);
pp.EndUpdateTabs(tbiColl);
document.EndUpdateParagraphs(pp);

winforms-rich-edit-text-formatting/VB/Text Formatting Example/Form1.vb#L78

vb
tbiColl.Add(tbi)
titleParagraphFormatting.EndUpdateTabs(tbiColl)

winforms-richedit-document-api/VB/RichEditAPISample/CodeExamples/Formatting.vb#L69

vb
tbiColl.Add(tbi)
pp.EndUpdateTabs(tbiColl)
'Finalize modifications

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

vb
tbiColl.Add(tbi)
pp.EndUpdateTabs(tbiColl)
document.EndUpdateParagraphs(pp)

word-document-api-examples/VB/CodeExamples/FormattingActions.vb#L121

vb
' Finalize to modify tab stops in the paragraph.
pp.EndUpdateTabs(tbiColl)
' Finalize to edit the paragraph.

See Also

BeginUpdateTabs(Boolean)

ParagraphPropertiesWithTabs Interface

ParagraphPropertiesWithTabs Members

DevExpress.XtraRichEdit.API.Native Namespace