com.aspose.words
Class ListLevel

java.lang.Object
    extended by com.aspose.words.ListLevel
All Implemented Interfaces:
java.lang.Cloneable

public class ListLevel 
extends java.lang.Object

Defines formatting for a list level.

You do not create objects of this class. List level objects are created automatically when a list is created. You access ListLevel objects via the ListLevelCollection collection.

Use the properties of ListLevel to specify list formatting for individual list levels.


Property Getters/Setters Summary
intgetAlignment()
voidsetAlignment(int value)
           Gets or sets the justification of the actual number of the list item. The value of the property is ListLevelAlignment integer constant.
Aspose.Words.FontgetFont()
           Specifies character formatting used for the list label.
ImageDatagetImageData()
           Returns image data of the picture bullet shape for the current list level.
booleanisLegal()
voidisLegal(boolean value)
           True if the level turns all inherited numbers to Arabic, false if it preserves their number style.
Aspose.Words.StylegetLinkedStyle()
           Gets or sets the paragraph style that is linked to this list level.
java.lang.StringgetNumberFormat()
voidsetNumberFormat(java.lang.String value)
           Returns or sets the number format for the list level.
doublegetNumberPosition()
voidsetNumberPosition(double value)
           Returns or sets the position (in points) of the number or bullet for the list level.
Aspose.Words.NumberStylegetNumberStyle()
           Returns or sets the number style for this list level.
intgetRestartAfterLevel()
voidsetRestartAfterLevel(int value)
           Sets or returns the list level that must appear before the specified list level restarts numbering.
intgetStartAt()
voidsetStartAt(int value)
           Returns or sets the starting number for this list level.
doublegetTabPosition()
voidsetTabPosition(double value)
           Returns or sets the tab position (in points) for the list level.
doublegetTextPosition()
voidsetTextPosition(double value)
           Returns or sets the position (in points) for the second line of wrapping text for the list level.
intgetTrailingCharacter()
voidsetTrailingCharacter(int value)
           Returns or sets the character inserted after the number for the list level. The value of the property is ListTrailingCharacter integer constant.
 
Method Summary
voidclearRunAttrs()
          Reserved for internal use.
voidcreatePictureBullet()
           Creates picture bullet shape for the current list level.
voiddeletePictureBullet()
           Deletes picture bullet for the current list level.
java.lang.ObjectfetchInheritedRunAttr(int key)
          Reserved for internal use.
java.lang.ObjectgetDirectRunAttr(int key)
          Reserved for internal use.
intgetDirectRunAttrsCount()
          Reserved for internal use.
voidremoveRunAttr(int key)
          Reserved for internal use.
voidsetRunAttr(int key, java.lang.Object value)
          Reserved for internal use.
 

Property Getters/Setters Detail

getAlignment/setAlignment

public int getAlignment() / public void setAlignment(int value)
Gets or sets the justification of the actual number of the list item. The value of the property is ListLevelAlignment integer constant.

The list label is justified relative to the NumberPosition property.


getFont

public Aspose.Words.Font getFont()
Specifies character formatting used for the list label.

getImageData

public ImageData getImageData()
Returns image data of the picture bullet shape for the current list level. If this level doesn't define picture bullet returns null. Before setting new image for non picture bullet shape, please use createPictureBullet() method first.

isLegal/isLegal

public boolean isLegal() / public void isLegal(boolean value)
True if the level turns all inherited numbers to Arabic, false if it preserves their number style.

getLinkedStyle

public Aspose.Words.Style getLinkedStyle()
Gets or sets the paragraph style that is linked to this list level.

This property is null when the list level is not linked to a paragraph style. This property can be set to null.


getNumberFormat/setNumberFormat

public java.lang.String getNumberFormat() / public void setNumberFormat(java.lang.String value)
Returns or sets the number format for the list level.

Among normal text characters, the string can contain placeholder characters \x0000 to \x0008 representing the numbers from the corresponding list levels.

For example, the string "\x0000.\x0001)" will generate a list label that looks something like "1.5)". The number "1" is the current number from the 1st list level, the number "5" is the current number from the 2nd list level.

Null is not allowed, but an empty string meaning no number is valid.


getNumberPosition/setNumberPosition

public double getNumberPosition() / public void setNumberPosition(double value)
Returns or sets the position (in points) of the number or bullet for the list level.

NumberPosition corresponds to LeftIndent plus FirstLineIndent of the paragraph.

See Also:
TextPosition, TabPosition

getNumberStyle

public Aspose.Words.NumberStyle getNumberStyle()
Returns or sets the number style for this list level.

getRestartAfterLevel/setRestartAfterLevel

public int getRestartAfterLevel() / public void setRestartAfterLevel(int value)
Sets or returns the list level that must appear before the specified list level restarts numbering.

The value of -1 means the numbering will continue.


getStartAt/setStartAt

public int getStartAt() / public void setStartAt(int value)
Returns or sets the starting number for this list level.

Default value is 1.


getTabPosition/setTabPosition

public double getTabPosition() / public void setTabPosition(double value)
Returns or sets the tab position (in points) for the list level.

Has effect only when TrailingCharacter is a tab.

See Also:
NumberPosition, TextPosition

getTextPosition/setTextPosition

public double getTextPosition() / public void setTextPosition(double value)
Returns or sets the position (in points) for the second line of wrapping text for the list level.

TextPosition corresponds to LeftIndent of the paragraph.

See Also:
NumberPosition, TabPosition

getTrailingCharacter/setTrailingCharacter

public int getTrailingCharacter() / public void setTrailingCharacter(int value)
Returns or sets the character inserted after the number for the list level. The value of the property is ListTrailingCharacter integer constant.

Method Detail

clearRunAttrs

public void clearRunAttrs()
Reserved for internal use.

createPictureBullet

public void createPictureBullet()
                        throws java.lang.Exception
Creates picture bullet shape for the current list level. Please note, NumberStyle will be set to Bullet and NumberFormat to "\xF0B7" to properly display picture bullet. Red cross image will be set as picture bullet image upon creating. To change it please use ImageData.

deletePictureBullet

public void deletePictureBullet()
Deletes picture bullet for the current list level. Default bullet will be shown after deleting.

fetchInheritedRunAttr

public java.lang.Object fetchInheritedRunAttr(int key)
Reserved for internal use.

getDirectRunAttr

public java.lang.Object getDirectRunAttr(int key)
Reserved for internal use.

getDirectRunAttrsCount

public int getDirectRunAttrsCount()
Reserved for internal use.

removeRunAttr

public void removeRunAttr(int key)
Reserved for internal use.

setRunAttr

public void setRunAttr(int key, java.lang.Object value)
Reserved for internal use.

See Also:
          Aspose.Words Documentation - the home page for the Aspose.Words Product Documentation.
          Aspose.Words Support Forum - our preferred method of support.