IBulletFormat

public interface IBulletFormat

Represents paragraph bullet formatting properties.

Methods

Method Description
getType() Returns or sets the bullet type of a paragraph with no inheritance.
setType(byte value) Returns or sets the bullet type of a paragraph with no inheritance.
getChar() Returns or sets the bullet char of a paragraph with no inheritance.
setChar(char value) Returns or sets the bullet char of a paragraph with no inheritance.
getFont() Returns or sets the bullet font of a paragraph with no inheritance.
setFont(IFontData value) Returns or sets the bullet font of a paragraph with no inheritance.
getHeight() Returns or sets the bullet height of a paragraph with no inheritance.
setHeight(float value) Returns or sets the bullet height of a paragraph with no inheritance.
getColor() Returns the color format of a bullet of a paragraph with no inheritance.
getPicture() Returns the picture used as a bullet in a paragraph with no inheritance.
getNumberedBulletStartWith() Returns or sets the first number which is used for group of numbered bullets with no inheritance.
setNumberedBulletStartWith(short value) Returns or sets the first number which is used for group of numbered bullets with no inheritance.
getNumberedBulletStyle() Returns or sets the style of a numbered bullet with no inheritance.
setNumberedBulletStyle(byte value) Returns or sets the style of a numbered bullet with no inheritance.
isBulletHardColor() Determines whether the bullet has own color or inherits it from the first portion in the paragraph.
setBulletHardColor(byte value) Determines whether the bullet has own color or inherits it from the first portion in the paragraph.
isBulletHardFont() Determines whether the bullet has own font or inherits it from the first portion in the paragraph.
setBulletHardFont(byte value) Determines whether the bullet has own font or inherits it from the first portion in the paragraph.
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).
getEffective() Gets effective bullet formatting data with the inheritance applied.

getType()

public abstract byte getType()

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

Returns: byte

setType(byte value)

public abstract void setType(byte value)

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

Parameters:

Parameter Type Description
value byte

getChar()

public abstract char getChar()

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

Returns: char

setChar(char value)

public abstract void setChar(char value)

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

Parameters:

Parameter Type Description
value char

getFont()

public abstract IFontData getFont()

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

Returns: IFontData

setFont(IFontData value)

public abstract void setFont(IFontData value)

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

Parameters:

Parameter Type Description
value IFontData

getHeight()

public abstract 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.

Returns: float

setHeight(float value)

public abstract 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.

Parameters:

Parameter Type Description
value float

getColor()

public abstract IColorFormat getColor()

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

Returns: IColorFormat

getPicture()

public abstract ISlidesPicture getPicture()

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

Returns: ISlidesPicture

getNumberedBulletStartWith()

public abstract short getNumberedBulletStartWith()

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

Returns: short

setNumberedBulletStartWith(short value)

public abstract void setNumberedBulletStartWith(short value)

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

Parameters:

Parameter Type Description
value short

getNumberedBulletStyle()

public abstract byte getNumberedBulletStyle()

Returns or sets the style of a numbered bullet with no inheritance. Read/write NumberedBulletStyle(#getNumberedBulletStyle.getNumberedBulletStyle/#setNumberedBulletStyle(byte).setNumberedBulletStyle(byte)).

Returns: byte

setNumberedBulletStyle(byte value)

public abstract void setNumberedBulletStyle(byte value)

Returns or sets the style of a numbered bullet with no inheritance. Read/write NumberedBulletStyle(#getNumberedBulletStyle.getNumberedBulletStyle/#setNumberedBulletStyle(byte).setNumberedBulletStyle(byte)).

Parameters:

Parameter Type Description
value byte

isBulletHardColor()

public abstract byte isBulletHardColor()

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

Returns: byte

setBulletHardColor(byte value)

public abstract void setBulletHardColor(byte value)

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

Parameters:

Parameter Type Description
value byte

isBulletHardFont()

public abstract byte isBulletHardFont()

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

Returns: byte

setBulletHardFont(byte value)

public abstract void setBulletHardFont(byte value)

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

Parameters:

Parameter Type Description
value byte

applyDefaultParagraphIndentsShifts()

public abstract 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).

getEffective()

public abstract 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: IBulletFormatEffectiveData - A IBulletFormatEffectiveData.