NumberingList Interface

A numbering definition instance referenced by paragraphs in a document that comprises a numbering list.

Namespace: DevExpress.XtraRichEdit.API.Native

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

Declaration

C#

[ComVisible(true)]
public interface NumberingList :
    NumberingListBase

VB.NET

<ComVisible(True)>
Public Interface NumberingList
    Inherits NumberingListBase

Related API Members

The following members return NumberingList objects:

• NumberingListCollection.Add(Int32)
• NumberingListCollection.CreateNew(Int32)

Remarks

The NumberingList object is based on an abstract numbering definition which can be accessed via the NumberingList.AbstractNumberingList property.

Document paragraphs are included into a numbering list by using the ParagraphCollection.AddParagraphsToList method.

The list to which a specific paragraph belongs can be obtained via the Paragraph.ListIndex property.

For an example of use see the AbstractNumberingList article.

View Example

ListsActions.cs

Document document = server.Document;

document.BeginUpdate();

//Create a new pattern object
AbstractNumberingList abstractListNumberingRoman = document.AbstractNumberingLists.Add();

//Specify the list's type
abstractListNumberingRoman.NumberingType = NumberingType.Simple;

//Define the first level's properties
ListLevel level = abstractListNumberingRoman.Levels[0];
level.ParagraphProperties.LeftIndent = 150;

// Align list with the surrounding text
level.ParagraphProperties.FirstLineIndentType = ParagraphFirstLineIndent.Hanging;
level.ParagraphProperties.FirstLineIndent = 75;
level.Start = 1;

//Specify the roman format
level.NumberingFormat = NumberingFormat.LowerRoman;
level.DisplayFormatString = "{0}.";

//Create a new list based on the specific pattern
NumberingList numberingList = document.NumberingLists.Add(0);

document.EndUpdate();

document.BeginUpdate();
ParagraphCollection paragraphs = document.Paragraphs;
//Add paragraphs to the list
paragraphs.AddParagraphsToList(document.Range, numberingList, 0);
document.EndUpdate();

ListsActions.vb

document.BeginUpdate()

'Create a new pattern object
Dim abstractListNumberingRoman As AbstractNumberingList = document.AbstractNumberingLists.Add()

'Specify the list's type
abstractListNumberingRoman.NumberingType = NumberingType.Simple

'Define the first level's properties
Dim level As ListLevel = abstractListNumberingRoman.Levels(0)
level.ParagraphProperties.LeftIndent = 150

' Align list with the surrounding text
level.ParagraphProperties.FirstLineIndentType = ParagraphFirstLineIndent.Hanging
level.ParagraphProperties.FirstLineIndent = 75

level.Start = 1
level.NumberingFormat = NumberingFormat.LowerRoman
level.DisplayFormatString = "{0}."

'Create a new list based on the specific pattern
Dim numberingList As NumberingList = document.NumberingLists.Add(0)
document.EndUpdate()

document.BeginUpdate()
Dim paragraphs As ParagraphCollection = document.Paragraphs

'Add paragraphs to the list
paragraphs.AddParagraphsToList(document.Range, numberingList, 0)
document.EndUpdate()

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the NumberingList interface.

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#

wpf-richedit-document-api-t213968/CS/DXRichEditControlAPISample/CodeExamples/ListActions.cs#L32

//Create a new list based on the given pattern
NumberingList bulletedList = document.NumberingLists.Add(0);

word-processing-document-api-examples-t418535/CS/CodeExamples/ListsActions.cs#L35

//Create a new list based on the specific pattern
NumberingList bulletedList = document.NumberingLists.Add(0);

word-document-api-examples/CS/CodeExamples/ListsActions.cs#L46

// Create a new list based on the specified pattern.
NumberingList bulletedList = document.NumberingLists.Add(0);

winforms-richedit-document-api-e5219/CS/RichEditAPISample/CodeExamples/List.cs#L32

//Create a new list based on the specific pattern
NumberingList bulletedList = document.NumberingLists.Add(0);

how-to-apply-different-list-types-to-certain-paragraphs-dynamically-e3791/CS/Form1.cs#L109

NumberingList newList = document.NumberingLists.Add(currentAbstractIndex);

VB.NET

wpf-richedit-document-api-t213968/VB/DXRichEditControlAPISample/CodeExamples/ListActions.vb#L29

'Create a new list based on the given pattern
Dim bulletedList As NumberingList = document.NumberingLists.Add(0)

word-processing-document-api-examples-t418535/VB/CodeExamples/ListsActions.vb#L32

'Create a new list based on the specific pattern
Dim bulletedList As NumberingList = document.NumberingLists.Add(0)

word-document-api-examples/VB/CodeExamples/ListsActions.vb#L40

' Create a new list based on the specified pattern.
Dim bulletedList As DevExpress.XtraRichEdit.API.Native.NumberingList = document.NumberingLists.Add(0)
' Access the collection of paragraphs.

winforms-richedit-document-api-e5219/VB/RichEditAPISample/CodeExamples/List.vb#L29

'Create a new list based on the specific pattern
Dim bulletedList As NumberingList = document.NumberingLists.Add(0)

how-to-apply-different-list-types-to-certain-paragraphs-dynamically-e3791/VB/Form1.vb#L102

Dim newList As NumberingList = document.NumberingLists.Add(currentAbstractIndex)