TabInfo Class

A tab stop.

Namespace: DevExpress.XtraRichEdit.API.Native

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

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

This code snippet sets the document measurement Document.Unit to inches and specifies tab stops. Tab stops are set and updated for the current paragraph only (see the Paragraph.BeginUpdateTabs parameter).

Note

A complete sample project is available at https://github.com/DevExpress-Examples/word-processing-document-api-examples-t418535

PageLayout.cs

document.Unit = DevExpress.Office.DocumentUnit.Inch;
TabInfoCollection tabs = document.Paragraphs[0].BeginUpdateTabs(true);
DevExpress.XtraRichEdit.API.Native.TabInfo tab1 = new DevExpress.XtraRichEdit.API.Native.TabInfo();
// Sets tab stop at 2.5 inch.
tab1.Position = 2.5f;
tab1.Alignment = TabAlignmentType.Left;
tab1.Leader = TabLeaderType.MiddleDots;
tabs.Add(tab1);
DevExpress.XtraRichEdit.API.Native.TabInfo tab2 = new DevExpress.XtraRichEdit.API.Native.TabInfo();
tab2.Position = 5.5f;
tab2.Alignment = TabAlignmentType.Decimal;
tab2.Leader = TabLeaderType.EqualSign;
tabs.Add(tab2);
document.Paragraphs[0].EndUpdateTabs(tabs);

PageLayout.vb

document.Unit = DevExpress.Office.DocumentUnit.Inch
Dim tabs As TabInfoCollection = document.Paragraphs(0).BeginUpdateTabs(True)
Dim tab1 As New DevExpress.XtraRichEdit.API.Native.TabInfo()
' Sets tab stop at 2.5 inch.
tab1.Position = 2.5F
tab1.Alignment = TabAlignmentType.Left
tab1.Leader = TabLeaderType.MiddleDots
tabs.Add(tab1)
Dim tab2 As New DevExpress.XtraRichEdit.API.Native.TabInfo()
tab2.Position = 5.5F
tab2.Alignment = TabAlignmentType.Decimal
tab2.Leader = TabLeaderType.EqualSign
tabs.Add(tab2)
document.Paragraphs(0).EndUpdateTabs(tabs)

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