The requested page is not available for the requested platform. You are viewing the content for .NET Framework 4.5.2+ platform.
.NET Framework 4.5.2+
.NET Framework 4.5.2+
.NET Standard 2.0+

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.v19.1.Core.dll

Declaration

[ComVisible(true)]
public interface NumberingList : NumberingListBase
<ComVisible(True)>
Public Interface NumberingList
    Inherits NumberingListBase
[ComVisible(true)]
public interface NumberingList : NumberingListBase
<ComVisible(True)>
Public Interface NumberingList
    Inherits NumberingListBase

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.

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();
See Also