com.aspose.slides

Interfaces

Classes

Exceptions

com.aspose.slides

Interface IParagraphFormat

  • All Known Implementing Classes:
    ParagraphFormat


    public interface IParagraphFormat

    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 IParagraph.createParagraphFormatEffective() method which returns a IParagraphFormatEffectiveData instance.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      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.
      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.
      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.
    • Method Detail

      • getDepth

        short getDepth()

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

      • setDepth

        void setDepth(short value)

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

      • getAlignment

        int getAlignment()

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

      • setAlignment

        void setAlignment(int value)

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

      • getSpaceWithin

        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.

      • setSpaceWithin

        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.

      • getSpaceBefore

        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.

      • setSpaceBefore

        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.

      • getSpaceAfter

        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.

      • setSpaceAfter

        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.

      • getEastAsianLineBreak

        byte getEastAsianLineBreak()

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

      • setEastAsianLineBreak

        void setEastAsianLineBreak(byte value)

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

      • getRightToLeft

        byte getRightToLeft()

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

      • setRightToLeft

        void setRightToLeft(byte value)

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

      • getLatinLineBreak

        byte getLatinLineBreak()

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

      • setLatinLineBreak

        void setLatinLineBreak(byte value)

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

      • getHangingPunctuation

        byte getHangingPunctuation()

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

      • setHangingPunctuation

        void setHangingPunctuation(byte value)

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

      • getMarginLeft

        float getMarginLeft()

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

      • setMarginLeft

        void setMarginLeft(float value)

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

      • getMarginRight

        float getMarginRight()

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

      • setMarginRight

        void setMarginRight(float value)

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

      • getIndent

        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.

      • setIndent

        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.

      • getDefaultTabSize

        float getDefaultTabSize()

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

      • setDefaultTabSize

        void setDefaultTabSize(float value)

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

      • getFontAlignment

        int getFontAlignment()

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

      • setFontAlignment

        void setFontAlignment(int value)

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

      • getDefaultPortionFormat

        IPortionFormat getDefaultPortionFormat()

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