Section.LineNumbering Property

Provides access to the object containing line numbering parameters for the current section.

Namespace: DevExpress.XtraRichEdit.API.Native

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

Declaration

C#

SectionLineNumbering LineNumbering { get; }

VB.NET

ReadOnly Property LineNumbering As SectionLineNumbering

Property Value

Type	Description
SectionLineNumbering	A SectionLineNumbering class instance representing parameters specific to line numbering.

Example

Set the RichEditView.AllowDisplayLineNumbers option for the current view to true and specify the SectionLineNumbering.CountBy property to any value other than 0 to enable Line Numbering.

In SimpleView and DraftView view line numbers are outside the default visible area, so you have to provide a space to display them. Use the SimpleView.Padding or the DraftView.Padding property to set the left padding to a higher value.

The line numbering font face and font color are specified by the Line Number character style.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/winforms-the-richeditcontrols-common-api-t210437

RichEditControlActions.cs

richEditControl.LoadDocument("Documents\\Grimm.docx", DevExpress.XtraRichEdit.DocumentFormat.OpenXml);
richEditControl.Views.SimpleView.Padding = new System.Windows.Forms.Padding(60, 4, 4, 0);
richEditControl.Views.SimpleView.AllowDisplayLineNumbers = true;
richEditControl.ActiveViewType = RichEditViewType.Simple;
richEditControl.Document.Sections[0].LineNumbering.CountBy = 1;
richEditControl.Document.CharacterStyles["Line Number"].ForeColor = Color.LightGray;
richEditControl.Document.CharacterStyles["Line Number"].Bold = true;

RichEditControlActions.vb

richEditControl.LoadDocument("Documents\Grimm.docx", DevExpress.XtraRichEdit.DocumentFormat.OpenXml)
richEditControl.Views.SimpleView.Padding = New System.Windows.Forms.Padding(60, 4, 4, 0)
richEditControl.Views.SimpleView.AllowDisplayLineNumbers = True
richEditControl.ActiveViewType = RichEditViewType.Simple
richEditControl.Document.Sections(0).LineNumbering.CountBy = 1
richEditControl.Document.CharacterStyles("Line Number").ForeColor = System.Drawing.Color.LightGray
richEditControl.Document.CharacterStyles("Line Number").Bold = True

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the LineNumbering property.

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#L54

document.Sections[0].Page.Width = Units.InchesToDocumentsF(100);
document.Sections[0].LineNumbering.CountBy = 1;
document.Sections[0].LineNumbering.RestartType = LineNumberingRestart.Continuous;

VB.NET

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

document.Sections(0).Page.Width = Units.InchesToDocumentsF(100)
document.Sections(0).LineNumbering.CountBy = 1
document.Sections(0).LineNumbering.RestartType = LineNumberingRestart.Continuous