ParagraphPropertiesWithTabs.BeginUpdateTabs(Boolean) Method

Starts modifying tab stops in a paragraph.

Namespace: DevExpress.XtraRichEdit.API.Native

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

Declaration

C#

TabInfoCollection BeginUpdateTabs(
    bool onlyOwnTabs
)

VB.NET

Function BeginUpdateTabs(
    onlyOwnTabs As Boolean
) As TabInfoCollection

Parameters

Name	Type	Description
onlyOwnTabs	Boolean	true to get tab stops set for the current paragraph only, disregarding style; otherwise, if set to false, merges tab stops which are set for the paragraph style and for the individual paragraph.

Returns

Type	Description
TabInfoCollection	A TabInfoCollection object containing information about tab stops.

Remarks

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/winforms-richedit-document-api-e5219

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)

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

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the BeginUpdateTabs(Boolean) 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-change-character-and-paragraph-formatting-e3323/CS/HowToChangeFormatting/MainWindow.xaml.cs#L47

// Set tab stop at 1.5"
TabInfoCollection tbiColl = pp.BeginUpdateTabs(true);
TabInfo tbi = new TabInfo();

how-to-change-formatting-of-text-and-paragraph-e2206/CS/HowToChangeFormatting/Form1.cs#L60

// Set tab stop at 1.5"
TabInfoCollection tbiColl = pp.BeginUpdateTabs(true);
TabInfo tbi = new TabInfo();

VB.NET

how-to-change-character-and-paragraph-formatting-e3323/VB/HowToChangeFormatting/MainWindow.xaml.vb#L48

' Set tab stop at 1.5"
Dim tbiColl As TabInfoCollection = pp.BeginUpdateTabs(True)
Dim tbi As New DevExpress.XtraRichEdit.API.Native.TabInfo()

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

' Set tab stop at 1.5"
Dim tbiColl As TabInfoCollection = pp.BeginUpdateTabs(True)
Dim tbi As New TabInfo()

how-to-change-formatting-of-text-and-paragraph-e2206/VB/HowToChangeFormatting/Form1.vb#L57

' Set tab stop at 1.5"
Dim tbiColl As TabInfoCollection = pp.BeginUpdateTabs(True)
Dim tbi As New TabInfo()