com.aspose.words

Class LineSpacingRule

java.lang.Object

com.aspose.words.LineSpacingRule

public class LineSpacingRule
extends java.lang.Object

Specifies line spacing values for a paragraph.

Examples:

Shows how to work with line spacing.

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

 // Below are three line spacing rules that we can define using the
 // paragraph's "LineSpacingRule" property to configure spacing between paragraphs.
 // 1 -  Set a minimum amount of spacing.
 // This will give vertical padding to lines of text of any size
 // that is too small to maintain the minimum line-height.
 builder.getParagraphFormat().setLineSpacingRule(LineSpacingRule.AT_LEAST);
 builder.getParagraphFormat().setLineSpacing(20.0);

 builder.writeln("Minimum line spacing of 20.");
 builder.writeln("Minimum line spacing of 20.");

 // 2 -  Set exact spacing.
 // Using font sizes that are too large for the spacing will truncate the text.
 builder.getParagraphFormat().setLineSpacingRule(LineSpacingRule.EXACTLY);
 builder.getParagraphFormat().setLineSpacing(5.0);

 builder.writeln("Line spacing of exactly 5.");
 builder.writeln("Line spacing of exactly 5.");

 // 3 -  Set spacing as a multiple of default line spacing, which is 12 points by default.
 // This kind of spacing will scale to different font sizes.
 builder.getParagraphFormat().setLineSpacingRule(LineSpacingRule.MULTIPLE);
 builder.getParagraphFormat().setLineSpacing(18.0);

 builder.writeln("Line spacing of 1.5 default lines.");
 builder.writeln("Line spacing of 1.5 default lines.");

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

Field Summary

Fields

Modifier and Type	Field and Description
static int	AT_LEAST The line spacing can be greater than or equal to, but never less than, the value specified in the ParagraphFormat.getLineSpacing() / ParagraphFormat.setLineSpacing(double) property.
static int	EXACTLY The line spacing never changes from the value specified in the ParagraphFormat.getLineSpacing() / ParagraphFormat.setLineSpacing(double) property, even if a larger font is used within the paragraph.
static int	length
static int	MULTIPLE The line spacing is specified in the ParagraphFormat.getLineSpacing() / ParagraphFormat.setLineSpacing(double) property as the number of lines.

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

AT_LEAST

public static int AT_LEAST

The line spacing can be greater than or equal to, but never less than, the value specified in the ParagraphFormat.getLineSpacing() / ParagraphFormat.setLineSpacing(double) property.

EXACTLY

public static int EXACTLY

The line spacing never changes from the value specified in the ParagraphFormat.getLineSpacing() / ParagraphFormat.setLineSpacing(double) property, even if a larger font is used within the paragraph.

MULTIPLE

public static int MULTIPLE

The line spacing is specified in the ParagraphFormat.getLineSpacing() / ParagraphFormat.setLineSpacing(double) property as the number of lines. One line equals 12 points.

length

public static int length

Method Detail

getName

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

toString

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

fromName

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

getValues

public static int[] getValues()