com.aspose.slides

Class ParagraphFormat

java.lang.Object

com.aspose.slides.PVIObject

com.aspose.slides.ParagraphFormat

All Implemented Interfaces:

IChartParagraphFormat, IParagraphFormat, IPresentationComponent, ISlideComponent

public final class ParagraphFormat
extends PVIObject
implements IParagraphFormat, IChartParagraphFormat

This class contains the paragraph formatting properties. Unlike IParagraphFormatEffectiveData, all properties of this class are writeable.

This class is used to return and manipulate paragraph formatting properties defined for the particular paragraph. This means that no inheritance is applied when getting values so for the majority of cases you will get values meaning "undefined".

In order to get the effective formatting parameter values including inherited you need to use getEffective() method which returns a IParagraphFormatEffectiveData instance.

Constructor Summary

Constructors

Constructor and Description
ParagraphFormat() Initializes a new instance of ParagraphFormat class.

Method Summary

Modifier and Type	Method and Description
int	getAlignment() Returns or sets the text alignment in a paragraph with no inheritance.
IBulletFormat	getBullet() Returns bullet format of the paragraph.
IPortionFormat	getDefaultPortionFormat() Returns default portion format of a paragraph.
float	getDefaultTabSize() Returns or sets default tabulation size with no inheritance.
short	getDepth() Returns or sets depth of the paragraph.
byte	getEastAsianLineBreak() Determines whether the East Asian line break is used in a paragraph.
IParagraphFormatEffectiveData	getEffective() Gets effective paragraph formatting data with the inheritance applied.
int	getFontAlignment() Returns or sets a font alignment in a paragraph with no inheritance.
byte	getHangingPunctuation() Determines whether the hanging punctuation is used in a paragraph.
float	getIndent() Returns or sets paragraph First Line Indent/Hanging Indent with no inheritance.
byte	getLatinLineBreak() Determines whether the Latin line break is used in a paragraph.
float	getMarginLeft() Returns or sets the left margin in a paragraph with no inheritance.
float	getMarginRight() Returns or sets the right margin in a paragraph with no inheritance.
byte	getRightToLeft() Determines whether the Right to Left writing is used in a paragraph.
float	getSpaceAfter() Returns or sets the amount of space after the last line in a paragraph with no inheritance.
float	getSpaceBefore() Returns or sets the amount of space before the first line in a paragraph with no inheritance.
float	getSpaceWithin() Returns or sets the amount of space between base lines in a paragraph.
ITabCollection	getTabs() Returns tabulations of a paragraph.
long	getVersion() Version.
void	setAlignment(int value) Returns or sets the text alignment in a paragraph with no inheritance.
void	setDefaultTabSize(float value) Returns or sets default tabulation size with no inheritance.
void	setDepth(short value) Returns or sets depth of the paragraph.
void	setEastAsianLineBreak(byte value) Determines whether the East Asian line break is used in a paragraph.
void	setFontAlignment(int value) Returns or sets a font alignment in a paragraph with no inheritance.
void	setHangingPunctuation(byte value) Determines whether the hanging punctuation is used in a paragraph.
void	setIndent(float value) Returns or sets paragraph First Line Indent/Hanging Indent with no inheritance.
void	setLatinLineBreak(byte value) Determines whether the Latin line break is used in a paragraph.
void	setMarginLeft(float value) Returns or sets the left margin in a paragraph with no inheritance.
void	setMarginRight(float value) Returns or sets the right margin in a paragraph with no inheritance.
void	setRightToLeft(byte value) Determines whether the Right to Left writing is used in a paragraph.
void	setSpaceAfter(float value) Returns or sets the amount of space after the last line in a paragraph with no inheritance.
void	setSpaceBefore(float value) Returns or sets the amount of space before the first line in a paragraph with no inheritance.
void	setSpaceWithin(float value) Returns or sets the amount of space between base lines in a paragraph.

Methods inherited from class com.aspose.slides.PVIObject

equals, getParent_Immediate, getParent_IPresentationComponent, getParent_ISlideComponent, getPresentation, getSlide, hashCode

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ParagraphFormat

public ParagraphFormat()

Initializes a new instance of ParagraphFormat class.

Method Detail

getBullet

public final IBulletFormat getBullet()

Returns bullet format of the paragraph. Read-only IBulletFormat.

Specified by:

getBullet in interface IParagraphFormat

getDepth

public final short getDepth()

Returns or sets depth of the paragraph. Value 0 means undefined value. Read/write short.

Specified by:

getDepth in interface IParagraphFormat

setDepth

public final void setDepth(short value)

Returns or sets depth of the paragraph. Value 0 means undefined value. Read/write short.

Specified by:

setDepth in interface IParagraphFormat

getAlignment

public final int getAlignment()

Returns or sets the text alignment in a paragraph with no inheritance. Read/write TextAlignment.

 The following sample code shows how to Align Text Paragraphs in PowerPoint Presentation.
 
 // Instantiate a Presentation object that represents a PPTX file
 Presentation pres = new Presentation("ParagraphsAlignment.pptx");
 try {
     // Accessing first slide
     ISlide slide = pres.getSlides().get_Item(0);
     // Accessing the first and second placeholder in the slide and typecasting it as AutoShape
     ITextFrame tf1 = ((IAutoShape)slide.getShapes().get_Item(0)).getTextFrame();
     ITextFrame tf2 = ((IAutoShape)slide.getShapes().get_Item(1)).getTextFrame();
     // Change the text in both placeholders
     tf1.setText("Center Align by Aspose");
     tf2.setText("Center Align by Aspose");
     // Getting the first paragraph of the placeholders
     IParagraph para1 = tf1.getParagraphs().get_Item(0);
     IParagraph para2 = tf2.getParagraphs().get_Item(0);
     // Aligning the text paragraph to center
     para1.getParagraphFormat().setAlignment(TextAlignment.Center);
     para2.getParagraphFormat().setAlignment(TextAlignment.Center);
     //Writing the presentation as a PPTX file
     pres.save("Centeralign_out.pptx", SaveFormat.Pptx);
 } finally {
     if (pres != null) pres.dispose();
 }
 
 

Specified by:

getAlignment in interface IChartParagraphFormat

Specified by:

getAlignment in interface IParagraphFormat

setAlignment

public final void setAlignment(int value)

Returns or sets the text alignment in a paragraph with no inheritance. Read/write TextAlignment.

 The following sample code shows how to Align Text Paragraphs in PowerPoint Presentation.
 
 // Instantiate a Presentation object that represents a PPTX file
 Presentation pres = new Presentation("ParagraphsAlignment.pptx");
 try {
     // Accessing first slide
     ISlide slide = pres.getSlides().get_Item(0);
     // Accessing the first and second placeholder in the slide and typecasting it as AutoShape
     ITextFrame tf1 = ((IAutoShape)slide.getShapes().get_Item(0)).getTextFrame();
     ITextFrame tf2 = ((IAutoShape)slide.getShapes().get_Item(1)).getTextFrame();
     // Change the text in both placeholders
     tf1.setText("Center Align by Aspose");
     tf2.setText("Center Align by Aspose");
     // Getting the first paragraph of the placeholders
     IParagraph para1 = tf1.getParagraphs().get_Item(0);
     IParagraph para2 = tf2.getParagraphs().get_Item(0);
     // Aligning the text paragraph to center
     para1.getParagraphFormat().setAlignment(TextAlignment.Center);
     para2.getParagraphFormat().setAlignment(TextAlignment.Center);
     //Writing the presentation as a PPTX file
     pres.save("Centeralign_out.pptx", SaveFormat.Pptx);
 } finally {
     if (pres != null) pres.dispose();
 }
 
 

Specified by:

setAlignment in interface IChartParagraphFormat

Specified by:

setAlignment in interface IParagraphFormat

getSpaceWithin

public final float getSpaceWithin()

Returns or sets the amount of space between base lines in a paragraph. Positive value means percentage, negative - size in points. No inheritance applied. Read/write float.

Specified by:

getSpaceWithin in interface IChartParagraphFormat

Specified by:

getSpaceWithin in interface IParagraphFormat

setSpaceWithin

public final void setSpaceWithin(float value)

Returns or sets the amount of space between base lines in a paragraph. Positive value means percentage, negative - size in points. No inheritance applied. Read/write float.

Specified by:

setSpaceWithin in interface IChartParagraphFormat

Specified by:

setSpaceWithin in interface IParagraphFormat

getSpaceBefore

public final float getSpaceBefore()

Returns or sets the amount of space before the first line in a paragraph with no inheritance. A positive value specifies the percentage of the font size that the white space should be. A negative value specifies the size of the white space in point size. Read/write float.

Specified by:

getSpaceBefore in interface IChartParagraphFormat

Specified by:

getSpaceBefore in interface IParagraphFormat

setSpaceBefore

public final void setSpaceBefore(float value)

Returns or sets the amount of space before the first line in a paragraph with no inheritance. A positive value specifies the percentage of the font size that the white space should be. A negative value specifies the size of the white space in point size. Read/write float.

Specified by:

setSpaceBefore in interface IChartParagraphFormat

Specified by:

setSpaceBefore in interface IParagraphFormat

getSpaceAfter

public final float getSpaceAfter()

Returns or sets the amount of space after the last line in a paragraph with no inheritance. A positive value specifies the percentage of the font size that the white space should be. A negative value specifies the size of the white space in point size. Read/write float.

Specified by:

getSpaceAfter in interface IChartParagraphFormat

Specified by:

getSpaceAfter in interface IParagraphFormat

setSpaceAfter

public final void setSpaceAfter(float value)

Returns or sets the amount of space after the last line in a paragraph with no inheritance. A positive value specifies the percentage of the font size that the white space should be. A negative value specifies the size of the white space in point size. Read/write float.

Specified by:

setSpaceAfter in interface IChartParagraphFormat

Specified by:

setSpaceAfter in interface IParagraphFormat

getEastAsianLineBreak

public final byte getEastAsianLineBreak()

Determines whether the East Asian line break is used in a paragraph. No inheritance applied. Read/write NullableBool.

Specified by:

getEastAsianLineBreak in interface IChartParagraphFormat

Specified by:

getEastAsianLineBreak in interface IParagraphFormat

setEastAsianLineBreak

public final void setEastAsianLineBreak(byte value)

Determines whether the East Asian line break is used in a paragraph. No inheritance applied. Read/write NullableBool.

Specified by:

setEastAsianLineBreak in interface IChartParagraphFormat

Specified by:

setEastAsianLineBreak in interface IParagraphFormat

getRightToLeft

public final byte getRightToLeft()

Determines whether the Right to Left writing is used in a paragraph. No inheritance applied. Read/write NullableBool.

Specified by:

getRightToLeft in interface IChartParagraphFormat

Specified by:

getRightToLeft in interface IParagraphFormat

setRightToLeft

public final void setRightToLeft(byte value)

Determines whether the Right to Left writing is used in a paragraph. No inheritance applied. Read/write NullableBool.

Specified by:

setRightToLeft in interface IChartParagraphFormat

Specified by:

setRightToLeft in interface IParagraphFormat

getLatinLineBreak

public final byte getLatinLineBreak()

Determines whether the Latin line break is used in a paragraph. No inheritance applied. Read/write NullableBool.

Specified by:

getLatinLineBreak in interface IChartParagraphFormat

Specified by:

getLatinLineBreak in interface IParagraphFormat

setLatinLineBreak

public final void setLatinLineBreak(byte value)

Determines whether the Latin line break is used in a paragraph. No inheritance applied. Read/write NullableBool.

Specified by:

setLatinLineBreak in interface IChartParagraphFormat

Specified by:

setLatinLineBreak in interface IParagraphFormat

getHangingPunctuation

public final byte getHangingPunctuation()

Determines whether the hanging punctuation is used in a paragraph. No inheritance applied. Read/write NullableBool.

Specified by:

getHangingPunctuation in interface IChartParagraphFormat

Specified by:

getHangingPunctuation in interface IParagraphFormat

setHangingPunctuation

public final void setHangingPunctuation(byte value)

Determines whether the hanging punctuation is used in a paragraph. No inheritance applied. Read/write NullableBool.

Specified by:

setHangingPunctuation in interface IChartParagraphFormat

Specified by:

setHangingPunctuation in interface IParagraphFormat

getMarginLeft

public final float getMarginLeft()

Returns or sets the left margin in a paragraph with no inheritance. Read/write float.

Specified by:

getMarginLeft in interface IChartParagraphFormat

Specified by:

getMarginLeft in interface IParagraphFormat

setMarginLeft

public final void setMarginLeft(float value)

Returns or sets the left margin in a paragraph with no inheritance. Read/write float.

Specified by:

setMarginLeft in interface IChartParagraphFormat

Specified by:

setMarginLeft in interface IParagraphFormat

getMarginRight

public final float getMarginRight()

Returns or sets the right margin in a paragraph with no inheritance. Read/write float.

Specified by:

getMarginRight in interface IChartParagraphFormat

Specified by:

getMarginRight in interface IParagraphFormat

setMarginRight

public final void setMarginRight(float value)

Returns or sets the right margin in a paragraph with no inheritance. Read/write float.

Specified by:

setMarginRight in interface IChartParagraphFormat

Specified by:

setMarginRight in interface IParagraphFormat

getIndent

public final float getIndent()

Returns or sets paragraph First Line Indent/Hanging Indent with no inheritance. Hanging Indent can be defined with negative values. Read/write float.

Specified by:

getIndent in interface IChartParagraphFormat

Specified by:

getIndent in interface IParagraphFormat

setIndent

public final void setIndent(float value)

Returns or sets paragraph First Line Indent/Hanging Indent with no inheritance. Hanging Indent can be defined with negative values. Read/write float.

Specified by:

setIndent in interface IChartParagraphFormat

Specified by:

setIndent in interface IParagraphFormat

getDefaultTabSize

public final float getDefaultTabSize()

Returns or sets default tabulation size with no inheritance. Read/write float.

Specified by:

getDefaultTabSize in interface IChartParagraphFormat

Specified by:

getDefaultTabSize in interface IParagraphFormat

setDefaultTabSize

public final void setDefaultTabSize(float value)

Returns or sets default tabulation size with no inheritance. Read/write float.

Specified by:

setDefaultTabSize in interface IChartParagraphFormat

Specified by:

setDefaultTabSize in interface IParagraphFormat

getTabs

public final ITabCollection getTabs()

Returns tabulations of a paragraph. No inheritance applied. Read-only ITabCollection.

Specified by:

getTabs in interface IChartParagraphFormat

Specified by:

getTabs in interface IParagraphFormat

getFontAlignment

public final int getFontAlignment()

Returns or sets a font alignment in a paragraph with no inheritance. Read/write FontAlignment.

Specified by:

getFontAlignment in interface IChartParagraphFormat

Specified by:

getFontAlignment in interface IParagraphFormat

setFontAlignment

public final void setFontAlignment(int value)

Returns or sets a font alignment in a paragraph with no inheritance. Read/write FontAlignment.

Specified by:

setFontAlignment in interface IChartParagraphFormat

Specified by:

setFontAlignment in interface IParagraphFormat

getDefaultPortionFormat

public final IPortionFormat getDefaultPortionFormat()

Returns default portion format of a paragraph. No inheritance applied. Read-only IPortionFormat.

Specified by:

getDefaultPortionFormat in interface IParagraphFormat

getEffective

public final IParagraphFormatEffectiveData getEffective()

Gets effective paragraph formatting data with the inheritance applied.

 This example demonstrates getting some effective paragraph format properties.
 
 Presentation pres = new Presentation("MyPresentation.pptx");
 try
 {
        IAutoShape shape = (IAutoShape)pres.getSlides().get_Item(0).getShapes().get_Item(0);
        IParagraphFormatEffectiveData effectiveParagraphFormat = shape.getTextFrame().getParagraphs().get_Item(0).getParagraphFormat().getEffective();
        System.out.println("Text alignment: " + effectiveParagraphFormat.getAlignment());
        System.out.println("Indent: " + effectiveParagraphFormat.getIndent());
        System.out.println("Bullet type: " + effectiveParagraphFormat.getBullet().getType());
 } finally {
  if (pres != null) pres.dispose();
 }
 
 

Specified by:

getEffective in interface IParagraphFormat

Returns:

A IParagraphFormatEffectiveData.

getVersion

public long getVersion()

Version. Read-only long.

Overrides:

getVersion in class PVIObject