SectionLineNumbering Interface

Defines line numbers in the left margin or to the left of each column in the document’s Section.

Namespace: DevExpress.XtraRichEdit.API.Native

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

NuGet Packages: DevExpress.RichEdit.Core, DevExpress.Win.Navigation

Declaration

C#

[ComVisible(true)]
public interface SectionLineNumbering

VB.NET

<ComVisible(True)>
Public Interface SectionLineNumbering

Related API Members

The following members return SectionLineNumbering objects:

• Section.LineNumbering

Remarks

The SectionLineNumbering interface is accessible via the Section.LineNumbering property of the document’s section.

By default, line numbering is suppressed. To switch line numbering on, set the AllowDisplayLineNumbers property of the required view to true and also set the SectionLineNumbering.CountBy property to any non-zero positive integer value.

Example

View Example: Word Processing Document API – How to Process Word Documents in Code

PageLayoutActions.cs

using DevExpress.XtraRichEdit.API.Native;
using DevExpress.XtraRichEdit;
using DevExpress.Office;

static void LineNumbering(RichEditDocumentServer wordProcessor) {

    // Load a document from a file.
    wordProcessor.LoadDocument("Documents\\Grimm.docx", DocumentFormat.OpenXml);

    // Access a document.
    Document document = wordProcessor.Document;

    // Specify the document’s measure units.
    document.Unit = DevExpress.Office.DocumentUnit.Inch;

    // Access the first document section.
    Section sec = document.Sections[0];

    // Specify line numbering parameters for the section.
    sec.LineNumbering.CountBy = 2;
    sec.LineNumbering.Start = 1;
    sec.LineNumbering.Distance = 0.25f;
    sec.LineNumbering.RestartType = LineNumberingRestart.NewSection;
}

PageLayoutActions.vb

Imports DevExpress.XtraRichEdit.API.Native
Imports DevExpress.XtraRichEdit
Imports DevExpress.Office

Private Shared Sub LineNumbering(ByVal wordProcessor As RichEditDocumentServer)

    ' Load a document from a file.
    wordProcessor.LoadDocument("Documents\Grimm.docx", DevExpress.XtraRichEdit.DocumentFormat.OpenXml)

    ' Access a document.
    Dim document As Document = wordProcessor.Document

    ' Specify the document’s measure units.
    document.Unit = DocumentUnit.Inch

    ' Access the first document section.
    Dim sec As Section = document.Sections(0)

    ' Specify line numbering parameters for the section.
    sec.LineNumbering.CountBy = 2
    sec.LineNumbering.Start = 1
    sec.LineNumbering.Distance = 0.25F
    sec.LineNumbering.RestartType = LineNumberingRestart.NewSection
End Sub