TabInfo Class

A tab stop.

Namespace: DevExpress.XtraRichEdit.API.Native

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

NuGet Package: DevExpress.RichEdit.Core

NuGet Packages: DevExpress.RichEdit.Core, DevExpress.WindowsDesktop.RichEdit.Core

Declaration

C#

[ComVisible(true)]
public class TabInfo

VB.NET

<ComVisible(True)>
Public Class TabInfo

Remarks

Use the ParagraphPropertiesWithTabs.BeginUpdateTabs method to get access to the collection of TabInfo objects for the current paragraph and specify their alignment type via the TabInfo.Alignment property.

Note

To specify default tab stop width, use the Document.DefaultTabWidth property.

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 TabInfo class.

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-use-api-to-set-tab-stops-tab-leading-characters-and-the-tab-marker-e3081/CS/TabStops/Form1.cs#L28

TabInfoCollection tabs = richEditControl1.Document.Paragraphs[0].BeginUpdateTabs(true);
TabInfo tab1 = new TabInfo();
// Sets tab stop at 2.5 inch

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

for (int i = 1; i <= 30; i++) {
    DevExpress.XtraRichEdit.API.Native.TabInfo tab = new DevExpress.XtraRichEdit.API.Native.TabInfo();
    tab.Position = i * tabSize.Width;

VB.NET

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

Dim tabs As TabInfoCollection = richEditControl1.Document.Paragraphs(0).BeginUpdateTabs(True)
Dim tab1 As New  DevExpress.XtraRichEdit.API.Native.TabInfo()
' Sets tab stop at 2.5 inch

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

For i As Integer = 1 To 30
    Dim tab As New DevExpress.XtraRichEdit.API.Native.TabInfo()
    tab.Position = i * tabSize.Width

Inheritance

Object

TabInfo