Paragraph.EndUpdateTabs(TabInfoCollection) Method

Finalizes modifications of tab stops for the paragraph.

Namespace: DevExpress.XtraRichEdit.API.Native

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

NuGet Package: DevExpress.RichEdit.Core

Declaration

C#

public abstract void EndUpdateTabs(
    TabInfoCollection tabs
)

VB.NET

Public MustOverride Sub EndUpdateTabs(
    tabs As TabInfoCollection
)

Parameters

Name	Type	Description
tabs	TabInfoCollection	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

PageLayout.cs

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

PageLayout.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)

Related GitHub Examples

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.

C#

how-to-set-tab-stops-so-that-each-tab-is-of-certain-characters-width-e3198/CS/TabStop_EachNCharacters/Form1.cs#L41

finally {
    document.Paragraphs[0].EndUpdateTabs(tabs);
}

how-to-use-api-to-set-tab-stops-tab-leading-characters-and-the-tab-marker-e3081/CS/TabStops/Form1.cs#L39

tabs.Add(tab2);
richEditControl1.Document.Paragraphs[0].EndUpdateTabs(tabs);
#endregion #tabs

how-to-set-tab-stops-so-that-each-tab-is-of-certain-characters-width-e5203/CS/TabStop_EachNCharacters/MainWindow.xaml.cs#L54

{
    document.Paragraphs[0].EndUpdateTabs(tabs);
}

wpf-richedit-document-api/CS/DXRichEditControlAPISample/CodeExamples/PageLayoutActions.cs#L65

tabs.Add(tab2);
document.Paragraphs[0].EndUpdateTabs(tabs);
#endregion #TabStops

winforms-richedit-document-api/CS/RichEditAPISample/CodeExamples/PageLayout.cs#L70

tabs.Add(tab2);
document.Paragraphs[0].EndUpdateTabs(tabs);
#endregion #TabStops

VB.NET

how-to-set-tab-stops-so-that-each-tab-is-of-certain-characters-width-e3198/VB/TabStop_EachNCharacters/Form1.vb#L38

Finally
    document.Paragraphs(0).EndUpdateTabs(tabs)
End Try

how-to-use-api-to-set-tab-stops-tab-leading-characters-and-the-tab-marker-e3081/VB/TabStops/Form1.vb#L37

            tabs.Add(tab2)
            richEditControl1.Document.Paragraphs(0).EndUpdateTabs(tabs)
'            #End Region ' #tabs

how-to-set-tab-stops-so-that-each-tab-is-of-certain-characters-width-e5203/VB/TabStop_EachNCharacters/MainWindow.xaml.vb#L45

Finally
    document.Paragraphs(0).EndUpdateTabs(tabs)
End Try

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

            tabs.Add(tab2)
            document.Paragraphs(0).EndUpdateTabs(tabs)
'            #End Region ' #TabStops

winforms-richedit-document-api/VB/RichEditAPISample/CodeExamples/PageLayout.vb#L65

            tabs.Add(tab2)
            document.Paragraphs(CInt((0))).EndUpdateTabs(tabs)
#End Region  ' #TabStops