com.aspose.slides

Interfaces

Classes

Exceptions

com.aspose.slides

Interface IBulletFormat

  • All Known Implementing Classes:
    BulletFormat


    public interface IBulletFormat

    Represents paragraph bullet formatting properties.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method and Description
      void applyDefaultParagraphIndentsShifts()
      Sets default non-zero shifts for effective paragraph Indent and MarginLeft when bullets is enabled (like PowerPoint do if enable paragraph bullets/numbering in it).
      char getChar()
      Returns or sets the bullet char of a paragraph with no inheritance.
      IColorFormat getColor()
      Returns the color format of a bullet of a paragraph with no inheritance.
      IBulletFormatEffectiveData getEffective()
      Gets effective bullet formatting data with the inheritance applied.
      IFontData getFont()
      Returns or sets the bullet font of a paragraph with no inheritance.
      float getHeight()
      Returns or sets the bullet height of a paragraph with no inheritance.
      short getNumberedBulletStartWith()
      Returns or sets the first number which is used for group of numbered bullets with no inheritance.
      byte getNumberedBulletStyle()
      Returns or sets the style of a numbered bullet with no inheritance.
      ISlidesPicture getPicture()
      Returns the picture used as a bullet in a paragraph with no inheritance.
      byte getType()
      Returns or sets the bullet type of a paragraph with no inheritance.
      byte isBulletHardColor()
      Determines whether the bullet has own color or inherits it from the first portion in the paragraph.
      byte isBulletHardFont()
      Determines whether the bullet has own font or inherits it from the first portion in the paragraph.
      void setBulletHardColor(byte value)
      Determines whether the bullet has own color or inherits it from the first portion in the paragraph.
      void setBulletHardFont(byte value)
      Determines whether the bullet has own font or inherits it from the first portion in the paragraph.
      void setChar(char value)
      Returns or sets the bullet char of a paragraph with no inheritance.
      void setFont(IFontData value)
      Returns or sets the bullet font of a paragraph with no inheritance.
      void setHeight(float value)
      Returns or sets the bullet height of a paragraph with no inheritance.
      void setNumberedBulletStartWith(short value)
      Returns or sets the first number which is used for group of numbered bullets with no inheritance.
      void setNumberedBulletStyle(byte value)
      Returns or sets the style of a numbered bullet with no inheritance.
      void setType(byte value)
      Returns or sets the bullet type of a paragraph with no inheritance.
    • Method Detail

      • getType

        byte getType()

        Returns or sets the bullet type of a paragraph with no inheritance. Read/write BulletType.

      • setType

        void setType(byte value)

        Returns or sets the bullet type of a paragraph with no inheritance. Read/write BulletType.

      • getChar

        char getChar()

        Returns or sets the bullet char of a paragraph with no inheritance. Read/write char.

      • setChar

        void setChar(char value)

        Returns or sets the bullet char of a paragraph with no inheritance. Read/write char.

      • getFont

        IFontData getFont()

        Returns or sets the bullet font of a paragraph with no inheritance. Read/write IFontData.

      • setFont

        void setFont(IFontData value)

        Returns or sets the bullet font of a paragraph with no inheritance. Read/write IFontData.

      • getHeight

        float getHeight()

        Returns or sets the bullet height of a paragraph with no inheritance. Value Float.NaN determines that bullet inherits height from the first portion in the paragraph. Read/write float.

      • setHeight

        void setHeight(float value)

        Returns or sets the bullet height of a paragraph with no inheritance. Value Float.NaN determines that bullet inherits height from the first portion in the paragraph. Read/write float.

      • getColor

        IColorFormat getColor()

        Returns the color format of a bullet of a paragraph with no inheritance. Read-only IColorFormat.

      • getPicture

        ISlidesPicture getPicture()

        Returns the picture used as a bullet in a paragraph with no inheritance. Read-only ISlidesPicture.

      • getNumberedBulletStartWith

        short getNumberedBulletStartWith()

        Returns or sets the first number which is used for group of numbered bullets with no inheritance. Read/write short.

      • setNumberedBulletStartWith

        void setNumberedBulletStartWith(short value)

        Returns or sets the first number which is used for group of numbered bullets with no inheritance. Read/write short.

      • isBulletHardColor

        byte isBulletHardColor()

        Determines whether the bullet has own color or inherits it from the first portion in the paragraph. <b>NullableBool.True</b> if bullet has own color and <b>NullableBool.False</b> if bullet inherits color from the first portion in the paragraph. Read/write NullableBool.

      • setBulletHardColor

        void setBulletHardColor(byte value)

        Determines whether the bullet has own color or inherits it from the first portion in the paragraph. <b>NullableBool.True</b> if bullet has own color and <b>NullableBool.False</b> if bullet inherits color from the first portion in the paragraph. Read/write NullableBool.

      • isBulletHardFont

        byte isBulletHardFont()

        Determines whether the bullet has own font or inherits it from the first portion in the paragraph. <b>NullableBool.True</b> if bullet has own font and <b>NullableBool.False</b> if bullet inherits font from the first portion in the paragraph. Read/write NullableBool.

      • setBulletHardFont

        void setBulletHardFont(byte value)

        Determines whether the bullet has own font or inherits it from the first portion in the paragraph. <b>NullableBool.True</b> if bullet has own font and <b>NullableBool.False</b> if bullet inherits font from the first portion in the paragraph. Read/write NullableBool.

      • applyDefaultParagraphIndentsShifts

        void applyDefaultParagraphIndentsShifts()

        Sets default non-zero shifts for effective paragraph Indent and MarginLeft when bullets is enabled (like PowerPoint do if enable paragraph bullets/numbering in it). If bullets is disabled then just reset paragraph Indent and MarginLeft (like PowerPoint do if disable paragraph bullets/numbering in it). Indents shifts are applied in regard to current bullet context - IBulletFormat.Type, .NumberedBulletStyle and FontHeight of first portion. Non-zero indents shifts are applied to effective Indent and MarginLeft of current paragraph (make result values to be local values).

        Throws:
        com.aspose.ms.System.InvalidOperationException - Calling this method doesn't matter and throw InvalidOperationException in following cases: if parent formatted object is not a paragraph (for example calling ITextStyle.DefaultParagraphFormat.Bullet.ApplyDefaultParagraphIndentsShifts() will throw exception); or if paragraph wasn't added to any ITextFrame.Paragraphs collection (add it first);
      • getEffective

        IBulletFormatEffectiveData getEffective()

        Gets effective bullet formatting data with the inheritance applied.


         This example demonstrates getting some effective bullet format properties.
         
         Presentation pres = new Presentation("MyPresentation.pptx");
         try {
             IAutoShape shape = (IAutoShape)pres.getSlides().get_Item(0).getShapes().get_Item(0);
             IBulletFormatEffectiveData effectiveBulletFormat = shape.getTextFrame().getParagraphs().get_Item(0).getParagraphFormat().getBullet().getEffective();
             System.out.println("Bullet type: " + effectiveBulletFormat.getType());
             if (effectiveBulletFormat.getType() == BulletType.Numbered)
             {
                 System.out.println("Numbered style: " + effectiveBulletFormat.getNumberedBulletStyle());
                 System.out.println("Starting number: " + effectiveBulletFormat.getNumberedBulletStartWith());
             }
         } finally {
             if (pres != null) pres.dispose();
         }
         
        Returns:
        A IBulletFormatEffectiveData.