com.aspose.words
Class OutlineLevel

java.lang.Object
    extended by com.aspose.words.OutlineLevel

public class OutlineLevel 
extends java.lang.Object

Utility class containing constants. Specifies the outline level of a paragraph in the document.

Example:

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.getParagraphFormat().setOutlineLevel(OutlineLevel.LEVEL_1);
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.getParagraphFormat().setOutlineLevel(OutlineLevel.LEVEL_2);
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.getParagraphFormat().setOutlineLevel(OutlineLevel.LEVEL_3);
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.getParagraphFormat().setOutlineLevel(OutlineLevel.BODY_TEXT);
builder.writeln("Paragraph at main text level.");

doc.save(getArtifactsDir() + "ParagraphFormat.ParagraphOutlineLevel.docx");

Field Summary
static final intLEVEL_1 = 0
           The paragraph is at the outline level 1 (topmost level).
static final intLEVEL_2 = 1
           The paragraph is at the outline level 2.
static final intLEVEL_3 = 2
           The paragraph is at the outline level 3.
static final intLEVEL_4 = 3
           The paragraph is at the outline level 4.
static final intLEVEL_5 = 4
           The paragraph is at the outline level 5.
static final intLEVEL_6 = 5
           The paragraph is at the outline level 6.
static final intLEVEL_7 = 6
           The paragraph is at the outline level 7.
static final intLEVEL_8 = 7
           The paragraph is at the outline level 8.
static final intLEVEL_9 = 8
           The paragraph is at the outline level 9.
static final intBODY_TEXT = 9
           The paragraph is at the level of the main text.
 

Field Detail

LEVEL_1 = 0

public static final int LEVEL_1
The paragraph is at the outline level 1 (topmost level).

LEVEL_2 = 1

public static final int LEVEL_2
The paragraph is at the outline level 2.

LEVEL_3 = 2

public static final int LEVEL_3
The paragraph is at the outline level 3.

LEVEL_4 = 3

public static final int LEVEL_4
The paragraph is at the outline level 4.

LEVEL_5 = 4

public static final int LEVEL_5
The paragraph is at the outline level 5.

LEVEL_6 = 5

public static final int LEVEL_6
The paragraph is at the outline level 6.

LEVEL_7 = 6

public static final int LEVEL_7
The paragraph is at the outline level 7.

LEVEL_8 = 7

public static final int LEVEL_8
The paragraph is at the outline level 8.

LEVEL_9 = 8

public static final int LEVEL_9
The paragraph is at the outline level 9.

BODY_TEXT = 9

public static final int BODY_TEXT
The paragraph is at the level of the main text.

See Also:
          Aspose.Words Documentation - the home page for the Aspose.Words Product Documentation.
          Aspose.Words Support Forum - our preferred method of support.