Paragraph.OutlineLevel Property

Gets or sets the outline level of a paragraph.

Namespace: DevExpress.XtraRichEdit.API.Native

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

Declaration

C#

public abstract int OutlineLevel { get; set; }

VB.NET

Public MustOverride Property OutlineLevel As Integer

Property Value

Type	Description
Int32	An integer specifying the level number, or null to indicate a mix of values.

Remarks

Outline levels are used to build a table of contents without changing the appearance of your text.

When a document is exported to HTML with default settings, the outline level specifies the tag in which the paragraph is enclosed. Outline levels from1 to 6 result in H1 - H6 tags respectively; paragraphs with outline levels higher than 6 are exported as text enclosed in a P tag. You can set the HtmlDocumentExporterOptions.IgnoreParagraphOutlineLevel option to true to export all paragraphs using only <P> tags, disregarding their outline levels.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the OutlineLevel 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#

generating-table-of-contents-toc-practical-guide-e4138/CS/Form1.cs#L56

SearchForTOCEntries(delegate(DocumentPosition location, int level) {
    Document.GetParagraph(location).OutlineLevel = level;
});

how-to-implement-the-document-map-feature-for-richeditcontrols-document-using-a-treelist-c-t164630/CS/WindowsFormsApplication1/Form1.cs#L25

foreach(Paragraph item in richEditControl1.Document.Paragraphs) {
    if(item.OutlineLevel == 0) continue;
    string description = richEditControl1.Document.GetText(item.Range);

how-to-manually-create-a-table-of-contents-t488553/CS/TableOfContentsExample/MainWindow.xaml.cs#L118

Paragraph paragraph = document.Paragraphs.Insert(document.Paragraphs[1].Range.End);
paragraph.OutlineLevel = 0;

VB.NET

generating-table-of-contents-toc-practical-guide-e4138/VB/Form1.vb#L68

Private Function AnonymousMethod2(ByVal location As DocumentPosition, ByVal level As Integer) As Boolean
    Document.GetParagraph(location).OutlineLevel = level
    Return True

how-to-implement-the-document-map-feature-for-richeditcontrols-document-using-a-treelist-c-t164630/VB/WindowsFormsApplication1/Form1.vb#L27

For Each item As Paragraph In richEditControl1.Document.Paragraphs
    If item.OutlineLevel = 0 Then
        Continue For

how-to-manually-create-a-table-of-contents-t488553/VB/TableOfContentsExample/MainWindow.xaml.vb#L107

Dim paragraph As Paragraph = document.Paragraphs.Insert(document.Paragraphs(1).Range.End)
paragraph.OutlineLevel = 0