OutlineLevel

OutlineLevel enumeration

Specifies the outline level of a paragraph in the document.

public enum OutlineLevel

Values

NameValueDescription
Level10The paragraph is at the outline level 1 (topmost level).
Level21The paragraph is at the outline level 2.
Level32The paragraph is at the outline level 3.
Level43The paragraph is at the outline level 4.
Level54The paragraph is at the outline level 5.
Level65The paragraph is at the outline level 6.
Level76The paragraph is at the outline level 7.
Level87The paragraph is at the outline level 8.
Level98The paragraph is at the outline level 9.
BodyText9The paragraph is at the level of the main text.

Examples

Shows how to configure paragraph outline levels to create collapsible text.

Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

// Each paragraph has an OutlineLevel, which could be any number from 1 to 9, or at the default "BodyText" value.
// Setting the property to one of the numbered values will show an arrow to the left
// of the beginning of the paragraph.
builder.ParagraphFormat.OutlineLevel = OutlineLevel.Level1;
builder.Writeln("Paragraph outline level 1.");

// Level 1 is the topmost level. If there is a paragraph with a lower level below a paragraph with a higher level,
// collapsing the higher-level paragraph will collapse the lower level paragraph.
builder.ParagraphFormat.OutlineLevel = OutlineLevel.Level2;
builder.Writeln("Paragraph outline level 2.");

// Two paragraphs of the same level will not collapse each other,
// and the arrows do not collapse the paragraphs they point to.
builder.ParagraphFormat.OutlineLevel = OutlineLevel.Level3;
builder.Writeln("Paragraph outline level 3.");
builder.Writeln("Paragraph outline level 3.");

// The default "BodyText" value is the lowest, which a paragraph of any level can collapse.
builder.ParagraphFormat.OutlineLevel = OutlineLevel.BodyText;
builder.Writeln("Paragraph at main text level.");

doc.Save(ArtifactsDir + "ParagraphFormat.ParagraphOutlineLevel.docx");

See Also