com.aspose.words

Class ParagraphFormat

  • java.lang.Object
    • com.aspose.words.ParagraphFormat
public class ParagraphFormat 
extends java.lang.Object

Represents all the formatting for a paragraph.

Example:

Creates a simple document from scratch using the Aspose.Words object model.
// Create an "empty" document. Note that like in Microsoft Word,
// the empty document has one section, body and one paragraph in it.
Document doc = new Document();

// This truly makes the document empty. No sections (not possible in Microsoft Word).
doc.removeAllChildren();

// Create a new section node.
// Note that the section has not yet been added to the document,
// but we have to specify the parent document.
Section section = new Section(doc);

// Append the section to the document.
doc.appendChild(section);

// Lets set some properties for the section.
section.getPageSetup().setSectionStart(SectionStart.NEW_PAGE);
section.getPageSetup().setPaperSize(PaperSize.LETTER);

// The section that we created is empty, lets populate it. The section needs at least the Body node.
Body body = new Body(doc);
section.appendChild(body);

// The body needs to have at least one paragraph.
// Note that the paragraph has not yet been added to the document,
// but we have to specify the parent document.
// The parent document is needed so the paragraph can correctly work
// with styles and other document-wide information.
Paragraph para = new Paragraph(doc);
body.appendChild(para);

// We can set some formatting for the paragraph
para.getParagraphFormat().setStyleName("Heading 1");
para.getParagraphFormat().setAlignment(ParagraphAlignment.CENTER);

// So far we have one empty paragraph in the document.
// The document is valid and can be saved, but lets add some text before saving.
// Create a new run of text and add it to our paragraph.
Run run = new Run(doc);
run.setText("Hello World!");
run.getFont().setColor(Color.RED);
para.appendChild(run);

// As a matter of interest, you can retrieve text of the whole document and
// see that \x000c is automatically appended. \x000c is the end of section character.
System.out.println(doc.getText());

// Save the document.
doc.save(getMyDir() + "\\Artifacts\\Section.CreateFromScratch.doc");

Property Getters/Setters Summary
booleangetAddSpaceBetweenFarEastAndAlpha()
void
           Gets or sets a flag indicating whether inter-character spacing is automatically adjusted between regions of Latin text and regions of East Asian text in the current paragraph.
booleangetAddSpaceBetweenFarEastAndDigit()
void
           Gets or sets a flag indicating whether inter-character spacing is automatically adjusted between regions of numbers and regions of East Asian text in the current paragraph.
intgetAlignment()
void
setAlignment(intvalue)
           Gets or sets text alignment for the paragraph. The value of the property is ParagraphAlignment integer constant.
booleangetBidi()
void
setBidi(booleanvalue)
           Gets or sets whether this is a right-to-left paragraph.
BorderCollectiongetBorders()
Gets collection of borders of the paragraph.
intgetDropCapPosition()
void
           Gets or sets the position for a drop cap text. The value of the property is DropCapPosition integer constant.
booleangetFarEastLineBreakControl()
void
           Gets or sets a flag indicating whether East Asian line-breaking rules are applied to the current paragraph.
doublegetFirstLineIndent()
void
setFirstLineIndent(doublevalue)
           Gets or sets the value (in points) for a first line or hanging indent. Use a positive value to set a first-line indent, and use a negative value to set a hanging indent.
booleangetHangingPunctuation()
void
setHangingPunctuation(booleanvalue)
           Gets or sets a flag indicating whether hanging punctuation is enabled for the current paragraph.
booleanisHeading()
True when the paragraph style is one of the built-in Heading styles.
booleanisListItem()
True when the paragraph is an item in a bulleted or numbered list.
booleangetKeepTogether()
void
setKeepTogether(booleanvalue)
           True if all lines in the paragraph are to remain on the same page.
booleangetKeepWithNext()
void
setKeepWithNext(booleanvalue)
           True if the paragraph is to remains on the same page as the paragraph that follows it.
doublegetLeftIndent()
void
setLeftIndent(doublevalue)
           Gets or sets the value (in points) that represents the left indent for paragraph.
doublegetLineSpacing()
void
setLineSpacing(doublevalue)
           Gets or sets the line spacing (in points) for the paragraph.
intgetLineSpacingRule()
void
           Gets or sets the line spacing for the paragraph. The value of the property is LineSpacingRule integer constant.
intgetLinesToDrop()
void
setLinesToDrop(intvalue)
           Gets or sets the number of lines of the paragraph text used to calculate the drop cap height.
booleangetNoSpaceBetweenParagraphsOfSameStyle()
void
           When true, SpaceBefore and SpaceAfter will be ignored between the paragraphs of the same style.
intgetOutlineLevel()
void
setOutlineLevel(intvalue)
           Specifies the outline level of the paragraph in the document. The value of the property is OutlineLevel integer constant.
booleangetPageBreakBefore()
void
setPageBreakBefore(booleanvalue)
           True if a page break is forced before the paragraph.
doublegetRightIndent()
void
setRightIndent(doublevalue)
           Gets or sets the value (in points) that represents the right indent for paragraph.
ShadinggetShading()
Returns a Shading object that refers to the shading formatting for the paragraph.
doublegetSpaceAfter()
void
setSpaceAfter(doublevalue)
           Gets or sets the amount of spacing (in points) after the paragraph.
booleangetSpaceAfterAuto()
void
setSpaceAfterAuto(booleanvalue)
           True if the amount of spacing after the paragraph is set automatically.
doublegetSpaceBefore()
void
setSpaceBefore(doublevalue)
           Gets or sets the amount of spacing (in points) before the paragraph.
booleangetSpaceBeforeAuto()
void
setSpaceBeforeAuto(booleanvalue)
           True if the amount of spacing before the paragraph is set automatically.
StylegetStyle()
void
setStyle(Style value)
           Gets or sets the paragraph style applied to this formatting.
intgetStyleIdentifier()
void
           Gets or sets the locale independent style identifier of the paragraph style applied to this formatting. The value of the property is StyleIdentifier integer constant.
java.lang.StringgetStyleName()
void
setStyleName(java.lang.Stringvalue)
           Gets or sets the name of the paragraph style applied to this formatting.
booleangetSuppressAutoHyphens()
void
           Specifies whether the current paragraph should be exempted from any hyphenation which is applied in the document settings.
booleangetSuppressLineNumbers()
void
           Specifies whether the current paragraph's lines should be exempted from line numbering which is applied in the parent section.
TabStopCollectiongetTabStops()
Gets the collection of custom tab stops defined for this object.
booleangetWidowControl()
void
setWidowControl(booleanvalue)
           True if the first and last lines in the paragraph are to remain on the same page as the rest of the paragraph.
booleangetWordWrap()
void
setWordWrap(booleanvalue)
           If this property is false, Latin text in the middle of a word can be wrapped for the current paragraph. Otherwise Latin text is wrapped by whole words.
 
Method Summary
voidclearFormatting()
Resets to default paragraph formatting.
 

    • Property Getters/Setters Detail

      • getAddSpaceBetweenFarEastAndAlpha/setAddSpaceBetweenFarEastAndAlpha

        public boolean getAddSpaceBetweenFarEastAndAlpha() / public void setAddSpaceBetweenFarEastAndAlpha(boolean value)
        
        Gets or sets a flag indicating whether inter-character spacing is automatically adjusted between regions of Latin text and regions of East Asian text in the current paragraph.

        Example:

        Shows how to insert a paragraph into the document.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        // Specify font formatting
        Font font = builder.getFont();
        font.setSize(16);
        font.setBold(true);
        font.setColor(Color.BLUE);
        font.setName("Arial");
        font.setUnderline(Underline.DASH);
        
        // Specify paragraph formatting
        ParagraphFormat paragraphFormat = builder.getParagraphFormat();
        paragraphFormat.setFirstLineIndent(8);
        paragraphFormat.setAlignment(ParagraphAlignment.JUSTIFY);
        paragraphFormat.setAddSpaceBetweenFarEastAndAlpha(true);
        paragraphFormat.setAddSpaceBetweenFarEastAndDigit(true);
        paragraphFormat.setKeepTogether(true);
        
        builder.writeln("A whole paragraph.");
      • getAddSpaceBetweenFarEastAndDigit/setAddSpaceBetweenFarEastAndDigit

        public boolean getAddSpaceBetweenFarEastAndDigit() / public void setAddSpaceBetweenFarEastAndDigit(boolean value)
        
        Gets or sets a flag indicating whether inter-character spacing is automatically adjusted between regions of numbers and regions of East Asian text in the current paragraph.

        Example:

        Shows how to insert a paragraph into the document.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        // Specify font formatting
        Font font = builder.getFont();
        font.setSize(16);
        font.setBold(true);
        font.setColor(Color.BLUE);
        font.setName("Arial");
        font.setUnderline(Underline.DASH);
        
        // Specify paragraph formatting
        ParagraphFormat paragraphFormat = builder.getParagraphFormat();
        paragraphFormat.setFirstLineIndent(8);
        paragraphFormat.setAlignment(ParagraphAlignment.JUSTIFY);
        paragraphFormat.setAddSpaceBetweenFarEastAndAlpha(true);
        paragraphFormat.setAddSpaceBetweenFarEastAndDigit(true);
        paragraphFormat.setKeepTogether(true);
        
        builder.writeln("A whole paragraph.");
      • getAlignment/setAlignment

        public int getAlignment() / public void setAlignment(int value)
        
        Gets or sets text alignment for the paragraph. The value of the property is ParagraphAlignment integer constant.

        Example:

        Shows how to insert a paragraph into the document.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        // Specify font formatting
        Font font = builder.getFont();
        font.setSize(16);
        font.setBold(true);
        font.setColor(Color.BLUE);
        font.setName("Arial");
        font.setUnderline(Underline.DASH);
        
        // Specify paragraph formatting
        ParagraphFormat paragraphFormat = builder.getParagraphFormat();
        paragraphFormat.setFirstLineIndent(8);
        paragraphFormat.setAlignment(ParagraphAlignment.JUSTIFY);
        paragraphFormat.setAddSpaceBetweenFarEastAndAlpha(true);
        paragraphFormat.setAddSpaceBetweenFarEastAndDigit(true);
        paragraphFormat.setKeepTogether(true);
        
        builder.writeln("A whole paragraph.");

        Example:

        Creates a simple document from scratch using the Aspose.Words object model.
        // Create an "empty" document. Note that like in Microsoft Word,
        // the empty document has one section, body and one paragraph in it.
        Document doc = new Document();
        
        // This truly makes the document empty. No sections (not possible in Microsoft Word).
        doc.removeAllChildren();
        
        // Create a new section node.
        // Note that the section has not yet been added to the document,
        // but we have to specify the parent document.
        Section section = new Section(doc);
        
        // Append the section to the document.
        doc.appendChild(section);
        
        // Lets set some properties for the section.
        section.getPageSetup().setSectionStart(SectionStart.NEW_PAGE);
        section.getPageSetup().setPaperSize(PaperSize.LETTER);
        
        // The section that we created is empty, lets populate it. The section needs at least the Body node.
        Body body = new Body(doc);
        section.appendChild(body);
        
        // The body needs to have at least one paragraph.
        // Note that the paragraph has not yet been added to the document,
        // but we have to specify the parent document.
        // The parent document is needed so the paragraph can correctly work
        // with styles and other document-wide information.
        Paragraph para = new Paragraph(doc);
        body.appendChild(para);
        
        // We can set some formatting for the paragraph
        para.getParagraphFormat().setStyleName("Heading 1");
        para.getParagraphFormat().setAlignment(ParagraphAlignment.CENTER);
        
        // So far we have one empty paragraph in the document.
        // The document is valid and can be saved, but lets add some text before saving.
        // Create a new run of text and add it to our paragraph.
        Run run = new Run(doc);
        run.setText("Hello World!");
        run.getFont().setColor(Color.RED);
        para.appendChild(run);
        
        // As a matter of interest, you can retrieve text of the whole document and
        // see that \x000c is automatically appended. \x000c is the end of section character.
        System.out.println(doc.getText());
        
        // Save the document.
        doc.save(getMyDir() + "\\Artifacts\\Section.CreateFromScratch.doc");
      • getBidi/setBidi

        public boolean getBidi() / public void setBidi(boolean value)
        
        Gets or sets whether this is a right-to-left paragraph.

        When true, the runs and other inline objects in this paragraph are laid out right to left.

      • getBorders

        public BorderCollection getBorders()
        
        Gets collection of borders of the paragraph.

        Example:

        Inserts a paragraph with a top border.
        DocumentBuilder builder = new DocumentBuilder();
        
        Border topBorder = builder.getParagraphFormat().getBorders().getByBorderType(BorderType.TOP);
        topBorder.setColor(Color.RED);
        topBorder.setLineStyle(LineStyle.DASH_SMALL_GAP);
        topBorder.setLineWidth(4);
        
        builder.writeln("Hello World!");
      • getDropCapPosition/setDropCapPosition

        public int getDropCapPosition() / public void setDropCapPosition(int value)
        
        Gets or sets the position for a drop cap text. The value of the property is DropCapPosition integer constant.
      • getFarEastLineBreakControl/setFarEastLineBreakControl

        public boolean getFarEastLineBreakControl() / public void setFarEastLineBreakControl(boolean value)
        
        Gets or sets a flag indicating whether East Asian line-breaking rules are applied to the current paragraph.

        Example:

        Shows how to set special properties for Asian typography.
        Document doc = new Document(getMyDir() + "Document.docx");
        
        ParagraphFormat format = doc.getFirstSection().getBody().getParagraphs().get(0).getParagraphFormat();
        format.setFarEastLineBreakControl(true);
        format.setWordWrap(false);
        format.setHangingPunctuation(true);
        
        doc.save(getMyDir() + "\\Artifacts\\Paragraph.AsianTypographyProperties.docx");
      • getFirstLineIndent/setFirstLineIndent

        public double getFirstLineIndent() / public void setFirstLineIndent(double value)
        
        Gets or sets the value (in points) for a first line or hanging indent. Use a positive value to set a first-line indent, and use a negative value to set a hanging indent.

        Example:

        Shows how to insert a paragraph into the document.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        // Specify font formatting
        Font font = builder.getFont();
        font.setSize(16);
        font.setBold(true);
        font.setColor(Color.BLUE);
        font.setName("Arial");
        font.setUnderline(Underline.DASH);
        
        // Specify paragraph formatting
        ParagraphFormat paragraphFormat = builder.getParagraphFormat();
        paragraphFormat.setFirstLineIndent(8);
        paragraphFormat.setAlignment(ParagraphAlignment.JUSTIFY);
        paragraphFormat.setAddSpaceBetweenFarEastAndAlpha(true);
        paragraphFormat.setAddSpaceBetweenFarEastAndDigit(true);
        paragraphFormat.setKeepTogether(true);
        
        builder.writeln("A whole paragraph.");
      • getHangingPunctuation/setHangingPunctuation

        public boolean getHangingPunctuation() / public void setHangingPunctuation(boolean value)
        
        Gets or sets a flag indicating whether hanging punctuation is enabled for the current paragraph.

        Example:

        Shows how to set special properties for Asian typography.
        Document doc = new Document(getMyDir() + "Document.docx");
        
        ParagraphFormat format = doc.getFirstSection().getBody().getParagraphs().get(0).getParagraphFormat();
        format.setFarEastLineBreakControl(true);
        format.setWordWrap(false);
        format.setHangingPunctuation(true);
        
        doc.save(getMyDir() + "\\Artifacts\\Paragraph.AsianTypographyProperties.docx");
      • isHeading

        public boolean isHeading()
        
        True when the paragraph style is one of the built-in Heading styles.
      • isListItem

        public boolean isListItem()
        
        True when the paragraph is an item in a bulleted or numbered list.
      • getKeepTogether/setKeepTogether

        public boolean getKeepTogether() / public void setKeepTogether(boolean value)
        
        True if all lines in the paragraph are to remain on the same page.

        Example:

        Shows how to insert a paragraph into the document.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        // Specify font formatting
        Font font = builder.getFont();
        font.setSize(16);
        font.setBold(true);
        font.setColor(Color.BLUE);
        font.setName("Arial");
        font.setUnderline(Underline.DASH);
        
        // Specify paragraph formatting
        ParagraphFormat paragraphFormat = builder.getParagraphFormat();
        paragraphFormat.setFirstLineIndent(8);
        paragraphFormat.setAlignment(ParagraphAlignment.JUSTIFY);
        paragraphFormat.setAddSpaceBetweenFarEastAndAlpha(true);
        paragraphFormat.setAddSpaceBetweenFarEastAndDigit(true);
        paragraphFormat.setKeepTogether(true);
        
        builder.writeln("A whole paragraph.");
      • getKeepWithNext/setKeepWithNext

        public boolean getKeepWithNext() / public void setKeepWithNext(boolean value)
        
        True if the paragraph is to remains on the same page as the paragraph that follows it.

        Example:

        Shows how to set a table to stay together on the same page.
        // To keep a table from breaking across a page we need to enable KeepWithNext
        // for every paragraph in the table except for the last paragraphs in the last
        // row of the table.
        for (Cell cell : (Iterable<Cell>) table.getChildNodes(NodeType.CELL, true))
            for (Paragraph para : cell.getParagraphs())
                if (!(cell.getParentRow().isLastRow() && para.isEndOfCell()))
                    para.getParagraphFormat().setKeepWithNext(true);
      • getLeftIndent/setLeftIndent

        public double getLeftIndent() / public void setLeftIndent(double value)
        
        Gets or sets the value (in points) that represents the left indent for paragraph.

        Example:

        Shows how to set paragraph formatting.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        // Set paragraph formatting properties
        ParagraphFormat paragraphFormat = builder.getParagraphFormat();
        paragraphFormat.setAlignment(ParagraphAlignment.CENTER);
        paragraphFormat.setLeftIndent(50);
        paragraphFormat.setRightIndent(50);
        paragraphFormat.setSpaceAfter(25);
        
        // Output text
        builder.writeln("I'm a very nice formatted paragraph. I'm intended to demonstrate how the left and right indents affect word wrapping.");
        builder.writeln("I'm another nice formatted paragraph. I'm intended to demonstrate how the space after paragraph looks like.");
      • getLineSpacing/setLineSpacing

        public double getLineSpacing() / public void setLineSpacing(double value)
        
        Gets or sets the line spacing (in points) for the paragraph.

        When LineSpacingRule property is set to AtLeast, the line spacing can be greater than or equal to, but never less than the specified LineSpacing value.

        When LineSpacingRule property is set to Exactly, the line spacing never changes from the specified LineSpacing value, even if a larger font is used within the paragraph.

      • getLineSpacingRule/setLineSpacingRule

        public int getLineSpacingRule() / public void setLineSpacingRule(int value)
        
        Gets or sets the line spacing for the paragraph. The value of the property is LineSpacingRule integer constant.
      • getLinesToDrop/setLinesToDrop

        public int getLinesToDrop() / public void setLinesToDrop(int value)
        
        Gets or sets the number of lines of the paragraph text used to calculate the drop cap height.
      • getNoSpaceBetweenParagraphsOfSameStyle/setNoSpaceBetweenParagraphsOfSameStyle

        public boolean getNoSpaceBetweenParagraphsOfSameStyle() / public void setNoSpaceBetweenParagraphsOfSameStyle(boolean value)
        
        When true, SpaceBefore and SpaceAfter will be ignored between the paragraphs of the same style.

        This setting only takes affect when applied to a paragraph style. If applied to a paragraph directly, it has no effect.

      • getOutlineLevel/setOutlineLevel

        public int getOutlineLevel() / public void setOutlineLevel(int value)
        
        Specifies the outline level of the paragraph in the document. The value of the property is OutlineLevel integer constant.
      • getPageBreakBefore/setPageBreakBefore

        public boolean getPageBreakBefore() / public void setPageBreakBefore(boolean value)
        
        True if a page break is forced before the paragraph.
      • getRightIndent/setRightIndent

        public double getRightIndent() / public void setRightIndent(double value)
        
        Gets or sets the value (in points) that represents the right indent for paragraph.

        Example:

        Shows how to set paragraph formatting.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        // Set paragraph formatting properties
        ParagraphFormat paragraphFormat = builder.getParagraphFormat();
        paragraphFormat.setAlignment(ParagraphAlignment.CENTER);
        paragraphFormat.setLeftIndent(50);
        paragraphFormat.setRightIndent(50);
        paragraphFormat.setSpaceAfter(25);
        
        // Output text
        builder.writeln("I'm a very nice formatted paragraph. I'm intended to demonstrate how the left and right indents affect word wrapping.");
        builder.writeln("I'm another nice formatted paragraph. I'm intended to demonstrate how the space after paragraph looks like.");
      • getShading

        public Shading getShading()
        
        Returns a Shading object that refers to the shading formatting for the paragraph.

        Example:

        Shows how to apply borders and shading to a paragraph.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        // Set paragraph borders
        BorderCollection borders = builder.getParagraphFormat().getBorders();
        borders.setDistanceFromText(20);
        borders.getByBorderType(BorderType.LEFT).setLineStyle(LineStyle.DOUBLE);
        borders.getByBorderType(BorderType.RIGHT).setLineStyle(LineStyle.DOUBLE);
        borders.getByBorderType(BorderType.TOP).setLineStyle(LineStyle.DOUBLE);
        borders.getByBorderType(BorderType.BOTTOM).setLineStyle(LineStyle.DOUBLE);
        
        // Set paragraph shading
        Shading shading = builder.getParagraphFormat().getShading();
        shading.setTexture(TextureIndex.TEXTURE_DIAGONAL_CROSS);
        shading.setBackgroundPatternColor(new Color(240, 128, 128));  // Light Coral
        shading.setForegroundPatternColor(new Color(255, 160, 122));  // Light Salmon
        
        builder.write("I'm a formatted paragraph with double border and nice shading.");
      • getSpaceAfter/setSpaceAfter

        public double getSpaceAfter() / public void setSpaceAfter(double value)
        
        Gets or sets the amount of spacing (in points) after the paragraph.

        Has no effect when SpaceAfterAuto is true.

        Example:

        Shows how to set paragraph formatting.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        // Set paragraph formatting properties
        ParagraphFormat paragraphFormat = builder.getParagraphFormat();
        paragraphFormat.setAlignment(ParagraphAlignment.CENTER);
        paragraphFormat.setLeftIndent(50);
        paragraphFormat.setRightIndent(50);
        paragraphFormat.setSpaceAfter(25);
        
        // Output text
        builder.writeln("I'm a very nice formatted paragraph. I'm intended to demonstrate how the left and right indents affect word wrapping.");
        builder.writeln("I'm another nice formatted paragraph. I'm intended to demonstrate how the space after paragraph looks like.");
      • getSpaceAfterAuto/setSpaceAfterAuto

        public boolean getSpaceAfterAuto() / public void setSpaceAfterAuto(boolean value)
        
        True if the amount of spacing after the paragraph is set automatically.

        When set to true, overrides the effect of SpaceAfter.

        When you set paragraph Space Before and Space After to Auto, Microsoft Word adds 14 points spacing between paragraphs automatically according to the following rules:

        • Normally, spacing is added after all paragraphs.
        • In a bulleted or numbered list, spacing is added only after the last item in the list. Spacing is not added between the list items.
        • In a nested bulleted or numbered list spacing is not added.
        • Spacing is normally added after a table.
        • Spacing is not added after a table if it is the last block in a table cell.
        • Spacing is not added after the last paragraph in a table cell.
      • getSpaceBefore/setSpaceBefore

        public double getSpaceBefore() / public void setSpaceBefore(double value)
        
        Gets or sets the amount of spacing (in points) before the paragraph.

        Has no effect when SpaceBeforeAuto is true.

      • getSpaceBeforeAuto/setSpaceBeforeAuto

        public boolean getSpaceBeforeAuto() / public void setSpaceBeforeAuto(boolean value)
        
        True if the amount of spacing before the paragraph is set automatically.

        When set to true, overrides the effect of SpaceBefore.

        When you set paragraph Space Before and Space After to Auto, Microsoft Word adds 14 points spacing between paragraphs automatically according to the following rules:

        • Normally, spacing is added after all paragraphs.
        • In a bulleted or numbered list, spacing is added only after the last item in the list. Spacing is not added between the list items.
        • In a nested bulleted or numbered list spacing is not added.
        • Spacing is normally added after a table.
        • Spacing is not added after a table if it is the last block in a table cell.
        • Spacing is not added after the last paragraph in a table cell.
      • getStyle/setStyle

        public Style getStyle() / public void setStyle(Style value)
        
        Gets or sets the paragraph style applied to this formatting.

        Example:

        Shows how to create and use a paragraph style with list formatting.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        // Create a paragraph style and specify some formatting for it.
        Style style = doc.getStyles().add(StyleType.PARAGRAPH, "MyStyle1");
        style.getFont().setSize(24);
        style.getFont().setName("Verdana");
        style.getParagraphFormat().setSpaceAfter(12);
        
        // Create a list and make sure the paragraphs that use this style will use this list.
        style.getListFormat().setList(doc.getLists().add(ListTemplate.BULLET_DEFAULT));
        style.getListFormat().setListLevelNumber(0);
        
        // Apply the paragraph style to the current paragraph in the document and add some text.
        builder.getParagraphFormat().setStyle(style);
        builder.writeln("Hello World: MyStyle1, bulleted.");
        
        // Change to a paragraph style that has no list formatting.
        builder.getParagraphFormat().setStyle(doc.getStyles().get("Normal"));
        builder.writeln("Hello World: Normal.");
        
        builder.getDocument().save(getMyDir() + "\\Artifacts\\Lists.ParagraphStyleBulleted.doc");
      • getStyleIdentifier/setStyleIdentifier

        public int getStyleIdentifier() / public void setStyleIdentifier(int value)
        
        Gets or sets the locale independent style identifier of the paragraph style applied to this formatting. The value of the property is StyleIdentifier integer constant.

        Example:

        Demonstrates how to insert a Table of contents (TOC) into a document using heading styles as entries.
        // Use a blank document
        Document doc = new Document();
        // Create a document builder to insert content with into document.
        DocumentBuilder builder = new DocumentBuilder(doc);
        // Insert a table of contents at the beginning of the document.
        builder.insertTableOfContents("\\o \"1-3\" \\h \\z \\u");
        // Start the actual document content on the second page.
        builder.insertBreak(BreakType.PAGE_BREAK);
        // Build a document with complex structure by applying different heading styles thus creating TOC entries.
        builder.getParagraphFormat().setStyleIdentifier(StyleIdentifier.HEADING_1);
        
        builder.writeln("Heading 1");
        
        builder.getParagraphFormat().setStyleIdentifier(StyleIdentifier.HEADING_2);
        
        builder.writeln("Heading 1.1");
        builder.writeln("Heading 1.2");
        
        builder.getParagraphFormat().setStyleIdentifier(StyleIdentifier.HEADING_1);
        
        builder.writeln("Heading 2");
        builder.writeln("Heading 3");
        
        builder.getParagraphFormat().setStyleIdentifier(StyleIdentifier.HEADING_2);
        
        builder.writeln("Heading 3.1");
        
        builder.getParagraphFormat().setStyleIdentifier(StyleIdentifier.HEADING_3);
        
        builder.writeln("Heading 3.1.1");
        builder.writeln("Heading 3.1.2");
        builder.writeln("Heading 3.1.3");
        
        builder.getParagraphFormat().setStyleIdentifier(StyleIdentifier.HEADING_2);
        
        builder.writeln("Heading 3.2");
        builder.writeln("Heading 3.3");
        
        // Call the method below to update the TOC.
        doc.updateFields();
      • getStyleName/setStyleName

        public java.lang.String getStyleName() / public void setStyleName(java.lang.String value)
        
        Gets or sets the name of the paragraph style applied to this formatting.

        Example:

        Creates a simple document from scratch using the Aspose.Words object model.
        // Create an "empty" document. Note that like in Microsoft Word,
        // the empty document has one section, body and one paragraph in it.
        Document doc = new Document();
        
        // This truly makes the document empty. No sections (not possible in Microsoft Word).
        doc.removeAllChildren();
        
        // Create a new section node.
        // Note that the section has not yet been added to the document,
        // but we have to specify the parent document.
        Section section = new Section(doc);
        
        // Append the section to the document.
        doc.appendChild(section);
        
        // Lets set some properties for the section.
        section.getPageSetup().setSectionStart(SectionStart.NEW_PAGE);
        section.getPageSetup().setPaperSize(PaperSize.LETTER);
        
        // The section that we created is empty, lets populate it. The section needs at least the Body node.
        Body body = new Body(doc);
        section.appendChild(body);
        
        // The body needs to have at least one paragraph.
        // Note that the paragraph has not yet been added to the document,
        // but we have to specify the parent document.
        // The parent document is needed so the paragraph can correctly work
        // with styles and other document-wide information.
        Paragraph para = new Paragraph(doc);
        body.appendChild(para);
        
        // We can set some formatting for the paragraph
        para.getParagraphFormat().setStyleName("Heading 1");
        para.getParagraphFormat().setAlignment(ParagraphAlignment.CENTER);
        
        // So far we have one empty paragraph in the document.
        // The document is valid and can be saved, but lets add some text before saving.
        // Create a new run of text and add it to our paragraph.
        Run run = new Run(doc);
        run.setText("Hello World!");
        run.getFont().setColor(Color.RED);
        para.appendChild(run);
        
        // As a matter of interest, you can retrieve text of the whole document and
        // see that \x000c is automatically appended. \x000c is the end of section character.
        System.out.println(doc.getText());
        
        // Save the document.
        doc.save(getMyDir() + "\\Artifacts\\Section.CreateFromScratch.doc");
      • getSuppressAutoHyphens/setSuppressAutoHyphens

        public boolean getSuppressAutoHyphens() / public void setSuppressAutoHyphens(boolean value)
        
        Specifies whether the current paragraph should be exempted from any hyphenation which is applied in the document settings.
      • getSuppressLineNumbers/setSuppressLineNumbers

        public boolean getSuppressLineNumbers() / public void setSuppressLineNumbers(boolean value)
        
        Specifies whether the current paragraph's lines should be exempted from line numbering which is applied in the parent section.
      • getTabStops

        public TabStopCollection getTabStops()
        
        Gets the collection of custom tab stops defined for this object.

        Example:

        Shows how to modify the position of the right tab stop in TOC related paragraphs.
        Document doc = new Document(getMyDir() + "Document.TableOfContents.doc");
        
        // Iterate through all paragraphs in the document
        for (Paragraph para : (Iterable<Paragraph>) doc.getChildNodes(NodeType.PARAGRAPH, true))
        {
            // Check if this paragraph is formatted using the TOC result based styles. This is any style between TOC and TOC9.
            if (para.getParagraphFormat().getStyle().getStyleIdentifier() >= StyleIdentifier.TOC_1 && para.getParagraphFormat().getStyle().getStyleIdentifier() <= StyleIdentifier.TOC_9)
            {
                // Get the first tab used in this paragraph, this should be the tab used to align the page numbers.
                TabStop tab = para.getParagraphFormat().getTabStops().get(0);
                // Remove the old tab from the collection.
                para.getParagraphFormat().getTabStops().removeByPosition(tab.getPosition());
                // Insert a new tab using the same properties but at a modified position.
                // We could also change the separators used (dots) by passing a different Leader type
                para.getParagraphFormat().getTabStops().add(tab.getPosition() - 50, tab.getAlignment(), tab.getLeader());
            }
        }
        
        doc.save(getMyDir() + "\\Artifacts\\Document.TableOfContentsTabStops.doc");
      • getWidowControl/setWidowControl

        public boolean getWidowControl() / public void setWidowControl(boolean value)
        
        True if the first and last lines in the paragraph are to remain on the same page as the rest of the paragraph.
      • getWordWrap/setWordWrap

        public boolean getWordWrap() / public void setWordWrap(boolean value)
        
        If this property is false, Latin text in the middle of a word can be wrapped for the current paragraph. Otherwise Latin text is wrapped by whole words.

        Example:

        Shows how to set special properties for Asian typography.
        Document doc = new Document(getMyDir() + "Document.docx");
        
        ParagraphFormat format = doc.getFirstSection().getBody().getParagraphs().get(0).getParagraphFormat();
        format.setFarEastLineBreakControl(true);
        format.setWordWrap(false);
        format.setHangingPunctuation(true);
        
        doc.save(getMyDir() + "\\Artifacts\\Paragraph.AsianTypographyProperties.docx");
    • Method Detail

      • clearFormatting

        public void clearFormatting()
        Resets to default paragraph formatting. Default paragraph formatting is Normal style, left aligned, no indentation, no spacing, no borders and no shading.