Back to Devexpress

SectionPageNumbering Interface

officefileapi-devexpress-dot-xtrarichedit-dot-api-dot-native-55e9d564.md

latest3.3 KB
Original Source

SectionPageNumbering Interface

Exposes members used to specify page numbering options.

Namespace : DevExpress.XtraRichEdit.API.Native

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

NuGet Package : DevExpress.RichEdit.Core

Declaration

csharp
[ComVisible(true)]
public interface SectionPageNumbering
vb
<ComVisible(True)>
Public Interface SectionPageNumbering

The following members return SectionPageNumbering objects:

Remarks

Use the SectionPageNumbering class properties to specify section page numbering options. Before you apply new options, set the SectionPageNumbering.ContinueNumbering property to false to reset numbering options.

The PAGE field shows a document’s page number. To apply new settings to existing page numbers, call the Document.UpdateAllFields() method to update all fields.

Example

The following code sample specifies the initial number and NumberingFormat.CardinalText numbering format, and inserts the PAGE field to the section footer.

csharp
using DevExpress.XtraRichEdit;
using DevExpress.XtraRichEdit.API.Native;

using (var wordProcessor = new RichEditDocumentServer())
{
    wordProcessor.CreateNewDocument();
    Section section = wordProcessor.Document.Sections[0];
    section.PageNumbering.ContinueNumbering = false;
    section.PageNumbering.FirstPageNumber = 3;
    section.PageNumbering.NumberingFormat = NumberingFormat.CardinalText;

    var footer = section.BeginUpdateFooter();
    footer.Fields.Create(footer.Range.End, "PAGE");
    section.EndUpdateFooter(footer);

    wordProcessor.Document.UpdateAllFields();
}
vb
Imports DevExpress.XtraRichEdit
Imports DevExpress.XtraRichEdit.API.Native

Using wordProcessor As New RichEditDocumentServer()
    wordProcessor.CreateNewDocument()
    Dim section As Section = wordProcessor.Document.Sections(0)
    section.PageNumbering.ContinueNumbering = False
    section.PageNumbering.FirstPageNumber = 3
    section.PageNumbering.NumberingFormat = NumberingFormat.CardinalText

    Dim footer = section.BeginUpdateFooter()
    footer.Fields.Create(footer.Range.End, "PAGE")
    section.EndUpdateFooter(footer)

    wordProcessor.Document.UpdateAllFields()
End Using

See Also

SectionPageNumbering Members

DevExpress.XtraRichEdit.API.Native Namespace