com.aspose.words

Class LineNumberRestartMode

java.lang.Object

com.aspose.words.LineNumberRestartMode

public class LineNumberRestartMode
extends java.lang.Object

Determines when automatic line numbering restarts.

Examples:

Shows how to enable line numbering for a section.

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

 // We can use the section's PageSetup object to display numbers to the left of the section's text lines.
 // This is the same behavior as a List object,
 // but it covers the entire section and does not modify the text in any way.
 // Our section will restart the numbering on each new page from 1 and display the number,
 // if it is a multiple of 3, at 50pt to the left of the line.
 PageSetup pageSetup = builder.getPageSetup();
 pageSetup.setLineStartingNumber(1);
 pageSetup.setLineNumberCountBy(3);
 pageSetup.setLineNumberRestartMode(LineNumberRestartMode.RESTART_PAGE);
 pageSetup.setLineNumberDistanceFromText(50.0d);

 for (int i = 1; i <= 25; i++)
     builder.writeln(MessageFormat.format("Line {0}.", i));

 // The line counter will skip any paragraph with the "SuppressLineNumbers" flag set to "true".
 // This paragraph is on the 15th line, which is a multiple of 3, and thus would normally display a line number.
 // The section's line counter will also ignore this line, treat the next line as the 15th,
 // and continue the count from that point onward.
 doc.getFirstSection().getBody().getParagraphs().get(14).getParagraphFormat().setSuppressLineNumbers(true);

 doc.save(getArtifactsDir() + "PageSetup.LineNumbers.docx");
 
 

See Also:

PageSetup, PageSetup.getLineNumberRestartMode(), PageSetup.setLineNumberRestartMode(int)

Field Summary

Fields

Modifier and Type	Field and Description
static int	CONTINUOUS Line numbering continuous from the previous section.
static int	length
static int	RESTART_PAGE Line numbering restarts at the start of every page.
static int	RESTART_SECTION Line numbering restarts at the section start.

Method Summary

Modifier and Type	Method and Description
static int	fromName(java.lang.String lineNumberRestartModeName)
static java.lang.String	getName(int lineNumberRestartMode)
static int[]	getValues()
static java.lang.String	toString(int lineNumberRestartMode)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

RESTART_PAGE

public static int RESTART_PAGE

Line numbering restarts at the start of every page.

RESTART_SECTION

public static int RESTART_SECTION

Line numbering restarts at the section start.

CONTINUOUS

public static int CONTINUOUS

Line numbering continuous from the previous section.

length

public static int length

Method Detail

getName

public static java.lang.String getName(int lineNumberRestartMode)

toString

public static java.lang.String toString(int lineNumberRestartMode)

fromName

public static int fromName(java.lang.String lineNumberRestartModeName)

getValues

public static int[] getValues()