ASPOSE home

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 ListLevels 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.
FontgetFont()
           Specifies character formatting used for the list label.
booleanisLegal()
voidisLegal(boolean value)
           True if the level turns all inherited numbers to arabic, false if it preserves their number style.
booleanisRestartAfterHigher()
voidisRestartAfterHigher(boolean value)
           Controls whether the RestartAfterLevel option is active.
StylegetLinkedStyle()
voidsetLinkedStyle(Style value)
           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.
intgetNumberStyle()
voidsetNumberStyle(int value)
           Returns or sets the number style for this list level. The value of the property is NumberStyle integer constant.
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.
 

Property Getters/Setters Detail

getStartAt/setStartAt

public int getStartAt()

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

Default value is 1.


getNumberStyle/setNumberStyle

public int getNumberStyle()

public void setNumberStyle(int value)
Returns or sets the number style for this list level. The value of the property is NumberStyle integer constant.

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.


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.


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.

isRestartAfterHigher/isRestartAfterHigher

public boolean isRestartAfterHigher()

public void isRestartAfterHigher(boolean value)
Controls whether the RestartAfterLevel option is active.

When true, the numbering on this level restarts after a list item of the level equal to RestartAfterLevel or higher appears in the list.

When false, the numbering continues sequentially each time the list level appears.


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.

Has effect only when IsRestartAfterHigher is active.


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.

getFont

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

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

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

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

getLinkedStyle/setLinkedStyle

public Style getLinkedStyle()

public void setLinkedStyle(Style value)
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.

We are not fully sure how paragraph styles linked to list levels work in Microsoft Word, so use this at your own risk.


See Also:
          Wiki - the home page for the Aspose.Words Product Documentation that includes Programmer's Guide, Knowledge Base and other articles.
          Aspose.Words Support Forum - our preferred method of support.
          Aspose.Words Team - contact Aspose.Words Team.


ASPOSE home